http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OldDoFn.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OldDoFn.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OldDoFn.html new file mode 100644 index 0000000..931f47a --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OldDoFn.html @@ -0,0 +1,641 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_111) on Fri Jan 27 21:25:28 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>OldDoFn (Apache Beam SDK for Java, version 0.5.0)</title> +<meta name="date" content="2017-01-27"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="OldDoFn (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":42,"i1":42,"i2":42,"i3":42,"i4":42,"i5":38,"i6":42,"i7":42,"i8":42}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/OldDoFn.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/NonMergingActiveWindowSet.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/OldDoFn.html" target="_top">Frames</a></li> +<li><a href="OldDoFn.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.core</div> +<h2 title="Class OldDoFn" class="title">Class OldDoFn<InputT,OutputT></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.OldDoFn<InputT,OutputT></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>InputT</code> - the type of the (main) input elements</dd> +<dd><code>OutputT</code> - the type of the (main) output elements</dd> +</dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/beam/runners/core/AssignWindowsDoFn.html" title="class in org.apache.beam.runners.core">AssignWindowsDoFn</a>, <a href="../../../../../org/apache/beam/runners/core/GroupAlsoByWindowsDoFn.html" title="class in org.apache.beam.runners.core">GroupAlsoByWindowsDoFn</a>, <a href="../../../../../org/apache/beam/runners/core/GroupAlsoByWindowViaWindowSetDoFn.html" title="class in org.apache.beam.runners.core">GroupAlsoByWindowViaWindowSetDoFn</a></dd> +</dl> +<hr> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Uses of <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core"><code>OldDoFn</code></a> should be replaced by the new <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</span></div> +</div> +<br> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public abstract class <span class="typeNameLabel">OldDoFn<InputT,OutputT></span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></pre> +<div class="block">The argument to <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> providing the code to use to process + elements of the input + <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a>. + + <p>See <a href="../../../../../org/apache/beam/sdk/transforms/ParDo.html" title="class in org.apache.beam.sdk.transforms"><code>ParDo</code></a> for more explanation, examples of use, and + discussion of constraints on <code>OldDoFn</code>s, including their + serializability, lack of access to global shared mutable state, + requirements for failure tolerance, and benefits of optimization. + + <p><code>OldDoFn</code>s can be tested in the context of a particular + <code>Pipeline</code> by running that <code>Pipeline</code> on sample input + and then checking its output. Unit testing of a <code>OldDoFn</code>, + separately from any <code>ParDo</code> transform or <code>Pipeline</code>, + can be done via the <a href="../../../../../org/apache/beam/sdk/transforms/DoFnTester.html" title="class in org.apache.beam.sdk.transforms"><code>DoFnTester</code></a> harness. + + <p><a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> (currently experimental) offers an alternative + mechanism for accessing <a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html#window--"><code>OldDoFn.ProcessContext.window()</code></a> without the need + to implement <a href="../../../../../org/apache/beam/runners/core/OldDoFn.RequiresWindowAccess.html" title="interface in org.apache.beam.runners.core"><code>OldDoFn.RequiresWindowAccess</code></a>. + + <p>See also <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#processElement-org.apache.beam.runners.core.OldDoFn.ProcessContext-"><code>processElement(org.apache.beam.runners.core.OldDoFn<InputT, OutputT>.ProcessContext)</code></a> for details on implementing the transformation + from <code>InputT</code> to <code>OutputT</code>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.beam.runners.core.OldDoFn">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html" title="class in org.apache.beam.runners.core">OldDoFn.Context</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Information accessible to all methods in this <code>OldDoFn</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html" title="class in org.apache.beam.runners.core">OldDoFn.ProcessContext</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Information accessible when running <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#processElement-org.apache.beam.runners.core.OldDoFn.ProcessContext-"><code>processElement(org.apache.beam.runners.core.OldDoFn<InputT, OutputT>.ProcessContext)</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.RequiresWindowAccess.html" title="interface in org.apache.beam.runners.core">OldDoFn.RequiresWindowAccess</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Interface for signaling that a <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core"><code>OldDoFn</code></a> needs to access the window the + element is being processed in, via <a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html#window--"><code>OldDoFn.ProcessContext.window()</code></a>.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#OldDoFn--">OldDoFn</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> + </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#OldDoFn-java.util.Map-">OldDoFn</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/beam/sdk/transforms/DelegatingAggregator.html" title="class in org.apache.beam.sdk.transforms">DelegatingAggregator</a><?,?>> aggregators)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> + </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>protected <AggInputT,AggOutputT><br><a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms">Aggregator</a><AggInputT,AggOutputT></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#createAggregator-java.lang.String-org.apache.beam.sdk.transforms.Combine.CombineFn-">createAggregator</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a><? super AggInputT,?,AggOutputT> combiner)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns an <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms"><code>Aggregator</code></a> with aggregation logic specified by the + <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a> argument.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>protected <AggInputT><br><a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms">Aggregator</a><AggInputT,AggInputT></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#createAggregator-java.lang.String-org.apache.beam.sdk.transforms.SerializableFunction-">createAggregator</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><AggInputT>,AggInputT> combiner)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns an <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms"><code>Aggregator</code></a> with the aggregation logic specified by the + <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a> argument.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#finishBundle-org.apache.beam.runners.core.OldDoFn.Context-">finishBundle</a></span>(<a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html" title="class in org.apache.beam.runners.core">OldDoFn.Context</a> c)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Finishes processing this batch of elements.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>org.joda.time.Duration</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#getAllowedTimestampSkew--">getAllowedTimestampSkew</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">does not interact well with the watermark.</span></div> +</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a> builder)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Register display data for the given transform or component.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#processElement-org.apache.beam.runners.core.OldDoFn.ProcessContext-">processElement</a></span>(<a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html" title="class in org.apache.beam.runners.core">OldDoFn.ProcessContext</a> c)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Processes one input element.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#setup--">setup</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Prepares this <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> instance for processing bundles.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#startBundle-org.apache.beam.runners.core.OldDoFn.Context-">startBundle</a></span>(<a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html" title="class in org.apache.beam.runners.core">OldDoFn.Context</a> c)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Prepares this <code>OldDoFn</code> instance for processing a batch of elements.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#teardown--">teardown</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Cleans up this <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="OldDoFn--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>OldDoFn</h4> +<pre>public OldDoFn()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</li> +</ul> +<a name="OldDoFn-java.util.Map-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>OldDoFn</h4> +<pre>public OldDoFn(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a>,<a href="../../../../../org/apache/beam/sdk/transforms/DelegatingAggregator.html" title="class in org.apache.beam.sdk.transforms">DelegatingAggregator</a><?,?>> aggregators)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getAllowedTimestampSkew--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllowedTimestampSkew</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public org.joda.time.Duration getAllowedTimestampSkew()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">does not interact well with the watermark.</span></div> +<div class="block">Returns the allowed timestamp skew duration, which is the maximum + duration that timestamps can be shifted backward in + <a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#outputWithTimestamp-OutputT-org.joda.time.Instant-"><code>OldDoFn.Context.outputWithTimestamp(OutputT, org.joda.time.Instant)</code></a>. + + <p>The default value is <code>Duration.ZERO</code>, in which case + timestamps can only be shifted forward to future. For infinite + skew, return <code>Duration.millis(Long.MAX_VALUE)</code>. + + <p>Note that producing an element whose timestamp is less than the + current timestamp may result in late data, i.e. returning a non-zero + value here does not impact watermark calculations used for firing + windows.</div> +</li> +</ul> +<a name="setup--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setup</h4> +<pre>public void setup() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Prepares this <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> instance for processing bundles. + + <p><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#setup--"><code>setup()</code></a> will be called at most once per <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> instance, and before any other + <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> method is called. + + <p>By default, does nothing.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="startBundle-org.apache.beam.runners.core.OldDoFn.Context-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startBundle</h4> +<pre>public void startBundle(<a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html" title="class in org.apache.beam.runners.core">OldDoFn.Context</a> c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Prepares this <code>OldDoFn</code> instance for processing a batch of elements. + + <p>By default, does nothing.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="processElement-org.apache.beam.runners.core.OldDoFn.ProcessContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processElement</h4> +<pre>public abstract void processElement(<a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html" title="class in org.apache.beam.runners.core">OldDoFn.ProcessContext</a> c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Processes one input element. + + <p>The current element of the input <code>PCollection</code> is returned by + <a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html#element--"><code>c.element()</code></a>. It should be considered immutable. The Beam + runner will not mutate the element, so it is safe to cache, etc. The element should not be + mutated by any of the <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core"><code>OldDoFn</code></a> methods, because it may be cached elsewhere, retained by + the Beam runner, or used in other unspecified ways. + + <p>A value is added to the main output <code>PCollection</code> by <a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html#output-OutputT-"><code>OldDoFn.Context.output(OutputT)</code></a>. + Once passed to <code>output</code> the element should be considered immutable and not be modified in + any way. It may be cached elsewhere, retained by the Beam runner, or used in other + unspecified ways.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html" title="class in org.apache.beam.runners.core"><code>OldDoFn.ProcessContext</code></a></dd> +</dl> +</li> +</ul> +<a name="finishBundle-org.apache.beam.runners.core.OldDoFn.Context-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>finishBundle</h4> +<pre>public void finishBundle(<a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html" title="class in org.apache.beam.runners.core">OldDoFn.Context</a> c) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Finishes processing this batch of elements. + + <p>By default, does nothing.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="teardown--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>teardown</h4> +<pre>public void teardown() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Cleans up this <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>. + + <p><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#teardown--"><code>teardown()</code></a> will be called before the <a href="../../../../../org/apache/beam/sdk/runners/PipelineRunner.html" title="class in org.apache.beam.sdk.runners"><code>PipelineRunner</code></a> discards a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> + instance, including due to another <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> method throwing an <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang"><code>Exception</code></a>. No other + <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> methods will be called after a call to <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#teardown--"><code>teardown()</code></a>. + + <p>By default, does nothing.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>populateDisplayData</h4> +<pre>public void populateDisplayData(<a href="../../../../../org/apache/beam/sdk/transforms/display/DisplayData.Builder.html" title="interface in org.apache.beam.sdk.transforms.display">DisplayData.Builder</a> builder)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Register display data for the given transform or component. + + <p><code>populateDisplayData(DisplayData.Builder)</code> is invoked by Pipeline runners to collect + display data via <a href="../../../../../org/apache/beam/sdk/transforms/display/DisplayData.html#from-org.apache.beam.sdk.transforms.display.HasDisplayData-"><code>DisplayData.from(HasDisplayData)</code></a>. Implementations may call + <code>super.populateDisplayData(builder)</code> in order to register display data in the current + namespace, but should otherwise use <code>subcomponent.populateDisplayData(builder)</code> to use + the namespace of the subcomponent. + + <p>By default, does not register any display data. Implementors may override this method + to provide their own display data.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a></code> in interface <code><a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>builder</code> - The builder to populate with display data.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display"><code>HasDisplayData</code></a></dd> +</dl> +</li> +</ul> +<a name="createAggregator-java.lang.String-org.apache.beam.sdk.transforms.Combine.CombineFn-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createAggregator</h4> +<pre>protected final <AggInputT,AggOutputT> <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms">Aggregator</a><AggInputT,AggOutputT> createAggregator(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a><? super AggInputT,?,AggOutputT> combiner)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns an <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms"><code>Aggregator</code></a> with aggregation logic specified by the + <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a> argument. The name provided must be unique across + <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms"><code>Aggregator</code></a>s created within the OldDoFn. Aggregators can only be created + during pipeline construction.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the aggregator</dd> +<dd><code>combiner</code> - the <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a> to use in the aggregator</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an aggregator for the provided name and combiner in the scope of + this OldDoFn</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true"; title="class or interface in java.lang">NullPointerException</a></code> - if the name or combiner is null</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if the given name collides with another + aggregator in this scope</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - if called during pipeline processing.</dd> +</dl> +</li> +</ul> +<a name="createAggregator-java.lang.String-org.apache.beam.sdk.transforms.SerializableFunction-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createAggregator</h4> +<pre>protected final <AggInputT> <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms">Aggregator</a><AggInputT,AggInputT> createAggregator(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, + <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms">SerializableFunction</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><AggInputT>,AggInputT> combiner)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns an <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms"><code>Aggregator</code></a> with the aggregation logic specified by the + <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a> argument. The name provided must be unique + across <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms"><code>Aggregator</code></a>s created within the OldDoFn. Aggregators can only be + created during pipeline construction.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the aggregator</dd> +<dd><code>combiner</code> - the <a href="../../../../../org/apache/beam/sdk/transforms/SerializableFunction.html" title="interface in org.apache.beam.sdk.transforms"><code>SerializableFunction</code></a> to use in the aggregator</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an aggregator for the provided name and combiner in the scope of + this OldDoFn</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true"; title="class or interface in java.lang">NullPointerException</a></code> - if the name or combiner is null</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if the given name collides with another + aggregator in this scope</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true"; title="class or interface in java.lang">IllegalStateException</a></code> - if called during pipeline processing.</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/OldDoFn.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/NonMergingActiveWindowSet.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/OldDoFn.html" target="_top">Frames</a></li> +<li><a href="OldDoFn.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OutputWindowedValue.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OutputWindowedValue.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OutputWindowedValue.html new file mode 100644 index 0000000..b215dcd --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/OutputWindowedValue.html @@ -0,0 +1,262 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_111) on Fri Jan 27 21:25:28 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>OutputWindowedValue (Apache Beam SDK for Java, version 0.5.0)</title> +<meta name="date" content="2017-01-27"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="OutputWindowedValue (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/OutputWindowedValue.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/OldDoFn.RequiresWindowAccess.html" title="interface in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/PaneInfoTracker.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/OutputWindowedValue.html" target="_top">Frames</a></li> +<li><a href="OutputWindowedValue.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.core</div> +<h2 title="Interface OutputWindowedValue" class="title">Interface OutputWindowedValue<OutputT></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">OutputWindowedValue<OutputT></span></pre> +<div class="block">An object that can output a value with all of its windowing information to the main output or + a side output.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OutputWindowedValue.html#outputWindowedValue-OutputT-org.joda.time.Instant-java.util.Collection-org.apache.beam.sdk.transforms.windowing.PaneInfo-">outputWindowedValue</a></span>(<a href="../../../../../org/apache/beam/runners/core/OutputWindowedValue.html" title="type parameter in OutputWindowedValue">OutputT</a> output, + org.joda.time.Instant timestamp, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><? extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> windows, + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/PaneInfo.html" title="class in org.apache.beam.sdk.transforms.windowing">PaneInfo</a> pane)</code> +<div class="block">Outputs a value with windowing information to the main output.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><SideOutputT><br>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/OutputWindowedValue.html#sideOutputWindowedValue-org.apache.beam.sdk.values.TupleTag-SideOutputT-org.joda.time.Instant-java.util.Collection-org.apache.beam.sdk.transforms.windowing.PaneInfo-">sideOutputWindowedValue</a></span>(<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><SideOutputT> tag, + SideOutputT output, + org.joda.time.Instant timestamp, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><? extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> windows, + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/PaneInfo.html" title="class in org.apache.beam.sdk.transforms.windowing">PaneInfo</a> pane)</code> +<div class="block">Outputs a value with windowing information to a side output.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="outputWindowedValue-java.lang.Object-org.joda.time.Instant-java.util.Collection-org.apache.beam.sdk.transforms.windowing.PaneInfo-"> +<!-- --> +</a><a name="outputWindowedValue-OutputT-org.joda.time.Instant-java.util.Collection-org.apache.beam.sdk.transforms.windowing.PaneInfo-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>outputWindowedValue</h4> +<pre>void outputWindowedValue(<a href="../../../../../org/apache/beam/runners/core/OutputWindowedValue.html" title="type parameter in OutputWindowedValue">OutputT</a> output, + org.joda.time.Instant timestamp, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><? extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> windows, + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/PaneInfo.html" title="class in org.apache.beam.sdk.transforms.windowing">PaneInfo</a> pane)</pre> +<div class="block">Outputs a value with windowing information to the main output.</div> +</li> +</ul> +<a name="sideOutputWindowedValue-org.apache.beam.sdk.values.TupleTag-java.lang.Object-org.joda.time.Instant-java.util.Collection-org.apache.beam.sdk.transforms.windowing.PaneInfo-"> +<!-- --> +</a><a name="sideOutputWindowedValue-org.apache.beam.sdk.values.TupleTag-SideOutputT-org.joda.time.Instant-java.util.Collection-org.apache.beam.sdk.transforms.windowing.PaneInfo-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>sideOutputWindowedValue</h4> +<pre><SideOutputT> void sideOutputWindowedValue(<a href="../../../../../org/apache/beam/sdk/values/TupleTag.html" title="class in org.apache.beam.sdk.values">TupleTag</a><SideOutputT> tag, + SideOutputT output, + org.joda.time.Instant timestamp, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><? extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>> windows, + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/PaneInfo.html" title="class in org.apache.beam.sdk.transforms.windowing">PaneInfo</a> pane)</pre> +<div class="block">Outputs a value with windowing information to a side output.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/OutputWindowedValue.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/OldDoFn.RequiresWindowAccess.html" title="interface in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/PaneInfoTracker.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/OutputWindowedValue.html" target="_top">Frames</a></li> +<li><a href="OutputWindowedValue.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/PaneInfoTracker.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/PaneInfoTracker.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/PaneInfoTracker.html new file mode 100644 index 0000000..4e0b13d --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/PaneInfoTracker.html @@ -0,0 +1,329 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_111) on Fri Jan 27 21:25:28 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>PaneInfoTracker (Apache Beam SDK for Java, version 0.5.0)</title> +<meta name="date" content="2017-01-27"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="PaneInfoTracker (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/PaneInfoTracker.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/OutputWindowedValue.html" title="interface in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/PeekingReiterator.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/PaneInfoTracker.html" target="_top">Frames</a></li> +<li><a href="PaneInfoTracker.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.core</div> +<h2 title="Class PaneInfoTracker" class="title">Class PaneInfoTracker</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.PaneInfoTracker</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">PaneInfoTracker</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Determine the timing and other properties of a new pane for a given computation, key and window. + Incorporates any previous pane, whether the pane has been produced because an + on-time <a href="../../../../../org/apache/beam/sdk/transforms/windowing/AfterWatermark.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>AfterWatermark</code></a> trigger firing, and the relation between the element's timestamp + and the current output watermark.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/PaneInfoTracker.html#PaneInfoTracker-org.apache.beam.sdk.util.TimerInternals-">PaneInfoTracker</a></span>(<a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util">TimerInternals</a> timerInternals)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/PaneInfoTracker.html#clear-org.apache.beam.sdk.util.state.StateAccessor-">clear</a></span>(<a href="../../../../../org/apache/beam/sdk/util/state/StateAccessor.html" title="interface in org.apache.beam.sdk.util.state">StateAccessor</a><?> state)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/sdk/util/state/ReadableState.html" title="interface in org.apache.beam.sdk.util.state">ReadableState</a><<a href="../../../../../org/apache/beam/sdk/transforms/windowing/PaneInfo.html" title="class in org.apache.beam.sdk.transforms.windowing">PaneInfo</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/PaneInfoTracker.html#getNextPaneInfo-org.apache.beam.runners.core.ReduceFn.Context-boolean-">getNextPaneInfo</a></span>(<a href="../../../../../org/apache/beam/runners/core/ReduceFn.Context.html" title="class in org.apache.beam.runners.core">ReduceFn.Context</a> context, + boolean isFinal)</code> +<div class="block">Return a (<a href="../../../../../org/apache/beam/sdk/util/state/ReadableState.html" title="interface in org.apache.beam.sdk.util.state"><code>ReadableState</code></a> for) the pane info appropriate for <code>context</code>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/PaneInfoTracker.html#prefetchPaneInfo-org.apache.beam.runners.core.ReduceFn.Context-">prefetchPaneInfo</a></span>(<a href="../../../../../org/apache/beam/runners/core/ReduceFn.Context.html" title="class in org.apache.beam.runners.core">ReduceFn.Context</a> context)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/PaneInfoTracker.html#storeCurrentPaneInfo-org.apache.beam.runners.core.ReduceFn.Context-org.apache.beam.sdk.transforms.windowing.PaneInfo-">storeCurrentPaneInfo</a></span>(<a href="../../../../../org/apache/beam/runners/core/ReduceFn.Context.html" title="class in org.apache.beam.runners.core">ReduceFn.Context</a> context, + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/PaneInfo.html" title="class in org.apache.beam.sdk.transforms.windowing">PaneInfo</a> currentPane)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="PaneInfoTracker-org.apache.beam.sdk.util.TimerInternals-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PaneInfoTracker</h4> +<pre>public PaneInfoTracker(<a href="../../../../../org/apache/beam/sdk/util/TimerInternals.html" title="interface in org.apache.beam.sdk.util">TimerInternals</a> timerInternals)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="clear-org.apache.beam.sdk.util.state.StateAccessor-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clear</h4> +<pre>public void clear(<a href="../../../../../org/apache/beam/sdk/util/state/StateAccessor.html" title="interface in org.apache.beam.sdk.util.state">StateAccessor</a><?> state)</pre> +</li> +</ul> +<a name="prefetchPaneInfo-org.apache.beam.runners.core.ReduceFn.Context-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>prefetchPaneInfo</h4> +<pre>public void prefetchPaneInfo(<a href="../../../../../org/apache/beam/runners/core/ReduceFn.Context.html" title="class in org.apache.beam.runners.core">ReduceFn.Context</a> context)</pre> +</li> +</ul> +<a name="getNextPaneInfo-org.apache.beam.runners.core.ReduceFn.Context-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNextPaneInfo</h4> +<pre>public <a href="../../../../../org/apache/beam/sdk/util/state/ReadableState.html" title="interface in org.apache.beam.sdk.util.state">ReadableState</a><<a href="../../../../../org/apache/beam/sdk/transforms/windowing/PaneInfo.html" title="class in org.apache.beam.sdk.transforms.windowing">PaneInfo</a>> getNextPaneInfo(<a href="../../../../../org/apache/beam/runners/core/ReduceFn.Context.html" title="class in org.apache.beam.runners.core">ReduceFn.Context</a> context, + boolean isFinal)</pre> +<div class="block">Return a (<a href="../../../../../org/apache/beam/sdk/util/state/ReadableState.html" title="interface in org.apache.beam.sdk.util.state"><code>ReadableState</code></a> for) the pane info appropriate for <code>context</code>. The pane + info includes the timing for the pane, who's calculation is quite subtle.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>isFinal</code> - should be <code>true</code> only if the triggering machinery can guarantee + no further firings for the</dd> +</dl> +</li> +</ul> +<a name="storeCurrentPaneInfo-org.apache.beam.runners.core.ReduceFn.Context-org.apache.beam.sdk.transforms.windowing.PaneInfo-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>storeCurrentPaneInfo</h4> +<pre>public void storeCurrentPaneInfo(<a href="../../../../../org/apache/beam/runners/core/ReduceFn.Context.html" title="class in org.apache.beam.runners.core">ReduceFn.Context</a> context, + <a href="../../../../../org/apache/beam/sdk/transforms/windowing/PaneInfo.html" title="class in org.apache.beam.sdk.transforms.windowing">PaneInfo</a> currentPane)</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/PaneInfoTracker.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/beam/runners/core/OutputWindowedValue.html" title="interface in org.apache.beam.runners.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/beam/runners/core/PeekingReiterator.html" title="class in org.apache.beam.runners.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/PaneInfoTracker.html" target="_top">Frames</a></li> +<li><a href="PaneInfoTracker.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
