http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ActiveWindowSet.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ActiveWindowSet.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ActiveWindowSet.html new file mode 100644 index 0000000..09aa871 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/ActiveWindowSet.html @@ -0,0 +1,544 @@ +<!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>ActiveWindowSet (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="ActiveWindowSet (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":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/ActiveWindowSet.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>Prev Class</li> +<li><a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.MergeCallback.html" title="interface 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/ActiveWindowSet.html" target="_top">Frames</a></li> +<li><a href="ActiveWindowSet.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>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 ActiveWindowSet" class="title">Interface ActiveWindowSet<W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>W</code> - the type of window being managed</dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/beam/runners/core/MergingActiveWindowSet.html" title="class in org.apache.beam.runners.core">MergingActiveWindowSet</a>, <a href="../../../../../org/apache/beam/runners/core/NonMergingActiveWindowSet.html" title="class in org.apache.beam.runners.core">NonMergingActiveWindowSet</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ActiveWindowSet<W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>></span></pre> +<div class="block">Track which windows are <i>active</i>, and the <i>state address window(s)</i> under which their + state is stored. Also help with the multi-step process of merging windows and their associated + state. + + <p>When windows are merged we must also merge their state. For example, we may need to + concatenate buffered elements, sum a count of elements, or find a new minimum timestamp. + If we start with two windows <code>Wa</code> and <code>Wb</code> and later discover they should be + merged into window <code>Wab</code> then, naively, we must copy and merge the states of <code>Wa</code> + and <code>Wab</code> into <code>Wab</code>. + + <p>However, the common case for merging windows is for a new window to be merged into an + existing window. Thus, if <code>Wa</code> is the existing window and <code>Wb</code> the new window it + is more efficient to leave the state for <code>Wa</code> where it is, and simply redirect <code>Wab</code> to it. In this case we say <code>Wab</code> has a state address window of <code>Wa</code>. + + <p>Even if windows <code>Wa</code> and <code>Wb</code> already have state, it can still be more efficient + to append the state of <code>Wb</code> onto <code>Wa</code> rather than copy the state from <code>Wa</code> + and <code>Wb</code> into <code>Wab</code>. + + <p>We use the following terminology for windows: + <ol> + <li><b>ACTIVE</b>: A window that has state associated with it and has not itself been merged + away. The window may have one (or more) state address windows under which its + non-empty state is stored. A state value for an ACTIVE window must be derived by reading + the state in (all of) its state address windows. Note that only pre 1.4 pipelines + use multiple state address windows per active window. From 1.4 onwards we eagerly merge + window state into a single state address window. + <li><b>NEW</b>: The initial state for a window of an incoming element which is not + already ACTIVE. We have not yet called <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#mergeWindows-org.apache.beam.sdk.transforms.windowing.WindowFn.MergeContext-"><code>WindowFn.mergeWindows(org.apache.beam.sdk.transforms.windowing.WindowFn<T, W>.MergeContext)</code></a>, and so don't yet know + whether the window will be be merged into another NEW or ACTIVE window, or will + become an ACTIVE window in its own right. + </ol> + + <p>If no windows will ever be merged we can use the trivial implementation <a href="../../../../../org/apache/beam/runners/core/NonMergingActiveWindowSet.html" title="class in org.apache.beam.runners.core"><code>NonMergingActiveWindowSet</code></a>. Otherwise, the actual implementation of this data structure is in + <a href="../../../../../org/apache/beam/runners/core/MergingActiveWindowSet.html" title="class in org.apache.beam.runners.core"><code>MergingActiveWindowSet</code></a>.</div> +</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">Interface and Description</th> +</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/ActiveWindowSet.MergeCallback.html" title="interface in org.apache.beam.runners.core">ActiveWindowSet.MergeCallback</a><<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.MergeCallback.html" title="type parameter in ActiveWindowSet.MergeCallback">W</a> extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>></span></code> +<div class="block">Callback for <a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#merge-org.apache.beam.runners.core.ActiveWindowSet.MergeCallback-"><code>merge(org.apache.beam.runners.core.ActiveWindowSet.MergeCallback<W>)</code></a>.</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></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/ActiveWindowSet.html#addActiveForTesting-W-">addActiveForTesting</a></span>(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</code> +<div class="block">If <code>window</code> is not already known to be ACTIVE then add it as ACTIVE.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#cleanupTemporaryWindows--">cleanupTemporaryWindows</a></span>()</code> +<div class="block">Remove any remaining NEW windows since they were not promoted to being ACTIVE + by <a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#ensureWindowIsActive-W-"><code>ensureWindowIsActive(W)</code></a> and we don't need to record anything about them.</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/ActiveWindowSet.html#ensureWindowExists-W-">ensureWindowExists</a></span>(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</code> +<div class="block">Called when an incoming element indicates it is a member of <code>window</code>, but before we + have started processing that element.</div> +</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/ActiveWindowSet.html#ensureWindowIsActive-W-">ensureWindowIsActive</a></span>(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</code> +<div class="block">Called when a NEW or ACTIVE window is now known to be ACTIVE.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#getActiveAndNewWindows--">getActiveAndNewWindows</a></span>()</code> +<div class="block">Return (a view of) the set of currently ACTIVE and NEW windows.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#isActive-W-">isActive</a></span>(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</code> +<div class="block">Return <code>true</code> if <code>window</code> is ACTIVE.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#isActiveOrNew-W-">isActiveOrNew</a></span>(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</code> +<div class="block">Return <code>true</code> if <code>window</code> is ACTIVE or NEW.</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/ActiveWindowSet.html#merge-org.apache.beam.runners.core.ActiveWindowSet.MergeCallback-">merge</a></span>(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.MergeCallback.html" title="interface in org.apache.beam.runners.core">ActiveWindowSet.MergeCallback</a><<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a>> mergeCallback)</code> +<div class="block">Invoke <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#mergeWindows-org.apache.beam.sdk.transforms.windowing.WindowFn.MergeContext-"><code>WindowFn.mergeWindows(org.apache.beam.sdk.transforms.windowing.WindowFn<T, W>.MergeContext)</code></a> on the <code>WindowFn</code> associated with this window set, + merging as many of the NEW and ACTIVE windows as possible.</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/ActiveWindowSet.html#merged-W-">merged</a></span>(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</code> +<div class="block">Signal that all state in <a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#readStateAddresses-W-"><code>readStateAddresses(W)</code></a> for <code>window</code> has been merged into + the <a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#writeStateAddress-W-"><code>writeStateAddress(W)</code></a> for <code>window</code>.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#mergedWriteStateAddress-java.util.Collection-W-">mergedWriteStateAddress</a></span>(<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><<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a>> toBeMerged, + <a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> mergeResult)</code> +<div class="block">Return the state address window into which all new state should be written after + ACTIVE windows <code>toBeMerged</code> have been merged into <code>mergeResult</code>.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#persist--">persist</a></span>()</code> +<div class="block">Save any state changes needed.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#readStateAddresses-W-">readStateAddresses</a></span>(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</code> +<div class="block">Return the state address windows for ACTIVE <code>window</code> from which all state associated + should be read and merged.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#remove-W-">remove</a></span>(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</code> +<div class="block">Remove <code>window</code> from the set.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#writeStateAddress-W-">writeStateAddress</a></span>(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</code> +<div class="block">Return the state address window of ACTIVE <code>window</code> into which all new state should be + written.</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="cleanupTemporaryWindows--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cleanupTemporaryWindows</h4> +<pre>void cleanupTemporaryWindows()</pre> +<div class="block">Remove any remaining NEW windows since they were not promoted to being ACTIVE + by <a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#ensureWindowIsActive-W-"><code>ensureWindowIsActive(W)</code></a> and we don't need to record anything about them.</div> +</li> +</ul> +<a name="persist--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>persist</h4> +<pre>void persist()</pre> +<div class="block">Save any state changes needed.</div> +</li> +</ul> +<a name="getActiveAndNewWindows--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getActiveAndNewWindows</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a>> getActiveAndNewWindows()</pre> +<div class="block">Return (a view of) the set of currently ACTIVE and NEW windows.</div> +</li> +</ul> +<a name="isActive-org.apache.beam.sdk.transforms.windowing.BoundedWindow-"> +<!-- --> +</a><a name="isActive-W-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isActive</h4> +<pre>boolean isActive(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</pre> +<div class="block">Return <code>true</code> if <code>window</code> is ACTIVE.</div> +</li> +</ul> +<a name="isActiveOrNew-org.apache.beam.sdk.transforms.windowing.BoundedWindow-"> +<!-- --> +</a><a name="isActiveOrNew-W-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isActiveOrNew</h4> +<pre>boolean isActiveOrNew(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</pre> +<div class="block">Return <code>true</code> if <code>window</code> is ACTIVE or NEW.</div> +</li> +</ul> +<a name="ensureWindowExists-org.apache.beam.sdk.transforms.windowing.BoundedWindow-"> +<!-- --> +</a><a name="ensureWindowExists-W-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ensureWindowExists</h4> +<pre>void ensureWindowExists(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</pre> +<div class="block">Called when an incoming element indicates it is a member of <code>window</code>, but before we + have started processing that element. If <code>window</code> is not already known to be ACTIVE, + then add it as NEW.</div> +</li> +</ul> +<a name="ensureWindowIsActive-org.apache.beam.sdk.transforms.windowing.BoundedWindow-"> +<!-- --> +</a><a name="ensureWindowIsActive-W-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ensureWindowIsActive</h4> +<pre>void ensureWindowIsActive(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</pre> +<div class="block">Called when a NEW or ACTIVE window is now known to be ACTIVE. + Ensure that if it is NEW then it becomes ACTIVE (with itself as its only state address + window).</div> +</li> +</ul> +<a name="addActiveForTesting-org.apache.beam.sdk.transforms.windowing.BoundedWindow-"> +<!-- --> +</a><a name="addActiveForTesting-W-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addActiveForTesting</h4> +<pre>void addActiveForTesting(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</pre> +<div class="block">If <code>window</code> is not already known to be ACTIVE then add it as ACTIVE. + For testing only.</div> +</li> +</ul> +<a name="remove-org.apache.beam.sdk.transforms.windowing.BoundedWindow-"> +<!-- --> +</a><a name="remove-W-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>remove</h4> +<pre>void remove(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</pre> +<div class="block">Remove <code>window</code> from the set.</div> +</li> +</ul> +<a name="merge-org.apache.beam.runners.core.ActiveWindowSet.MergeCallback-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>merge</h4> +<pre>void merge(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.MergeCallback.html" title="interface in org.apache.beam.runners.core">ActiveWindowSet.MergeCallback</a><<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a>> mergeCallback) + 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">Invoke <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html#mergeWindows-org.apache.beam.sdk.transforms.windowing.WindowFn.MergeContext-"><code>WindowFn.mergeWindows(org.apache.beam.sdk.transforms.windowing.WindowFn<T, W>.MergeContext)</code></a> on the <code>WindowFn</code> associated with this window set, + merging as many of the NEW and ACTIVE windows as possible. <code>mergeCallback</code> will be + invoked for each group of windows that are merged. After this all merge result windows will + be ACTIVE, and all windows which have been merged away will be neither ACTIVE nor NEW.</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="merged-org.apache.beam.sdk.transforms.windowing.BoundedWindow-"> +<!-- --> +</a><a name="merged-W-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>merged</h4> +<pre>void merged(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</pre> +<div class="block">Signal that all state in <a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#readStateAddresses-W-"><code>readStateAddresses(W)</code></a> for <code>window</code> has been merged into + the <a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#writeStateAddress-W-"><code>writeStateAddress(W)</code></a> for <code>window</code>.</div> +</li> +</ul> +<a name="readStateAddresses-org.apache.beam.sdk.transforms.windowing.BoundedWindow-"> +<!-- --> +</a><a name="readStateAddresses-W-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>readStateAddresses</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a>> readStateAddresses(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</pre> +<div class="block">Return the state address windows for ACTIVE <code>window</code> from which all state associated + should be read and merged.</div> +</li> +</ul> +<a name="writeStateAddress-org.apache.beam.sdk.transforms.windowing.BoundedWindow-"> +<!-- --> +</a><a name="writeStateAddress-W-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>writeStateAddress</h4> +<pre><a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> writeStateAddress(<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> window)</pre> +<div class="block">Return the state address window of ACTIVE <code>window</code> into which all new state should be + written. Always one of the results of <a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#readStateAddresses-W-"><code>readStateAddresses(W)</code></a>.</div> +</li> +</ul> +<a name="mergedWriteStateAddress-java.util.Collection-org.apache.beam.sdk.transforms.windowing.BoundedWindow-"> +<!-- --> +</a><a name="mergedWriteStateAddress-java.util.Collection-W-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>mergedWriteStateAddress</h4> +<pre><a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> mergedWriteStateAddress(<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><<a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a>> toBeMerged, + <a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html" title="type parameter in ActiveWindowSet">W</a> mergeResult)</pre> +<div class="block">Return the state address window into which all new state should be written after + ACTIVE windows <code>toBeMerged</code> have been merged into <code>mergeResult</code>.</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/ActiveWindowSet.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>Prev Class</li> +<li><a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.MergeCallback.html" title="interface 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/ActiveWindowSet.html" target="_top">Frames</a></li> +<li><a href="ActiveWindowSet.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>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/AggregatorFactory.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/AggregatorFactory.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/AggregatorFactory.html new file mode 100644 index 0000000..035d543 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/AggregatorFactory.html @@ -0,0 +1,241 @@ +<!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>AggregatorFactory (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="AggregatorFactory (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/AggregatorFactory.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/ActiveWindowSet.MergeCallback.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/AssignWindowsDoFn.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/AggregatorFactory.html" target="_top">Frames</a></li> +<li><a href="AggregatorFactory.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 AggregatorFactory" class="title">Interface AggregatorFactory</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/beam/runners/direct/AggregatorContainer.Mutator.html" title="class in org.apache.beam.runners.direct">AggregatorContainer.Mutator</a>, <a href="../../../../../org/apache/beam/runners/spark/aggregators/SparkAggregators.Factory.html" title="class in org.apache.beam.runners.spark.aggregators">SparkAggregators.Factory</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">AggregatorFactory</span></pre> +<div class="block">A factory for creating aggregators.</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><InputT,AccumT,OutputT><br><a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms">Aggregator</a><InputT,OutputT></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/AggregatorFactory.html#createAggregatorForDoFn-java.lang.Class-org.apache.beam.runners.core.ExecutionContext.StepContext-java.lang.String-org.apache.beam.sdk.transforms.Combine.CombineFn-">createAggregatorForDoFn</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> fnClass, + <a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core">ExecutionContext.StepContext</a> stepContext, + <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> aggregatorName, + <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a><InputT,AccumT,OutputT> combine)</code> +<div class="block">Create an aggregator with the given <code>name</code> and <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a>.</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="createAggregatorForDoFn-java.lang.Class-org.apache.beam.runners.core.ExecutionContext.StepContext-java.lang.String-org.apache.beam.sdk.transforms.Combine.CombineFn-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createAggregatorForDoFn</h4> +<pre><InputT,AccumT,OutputT> <a href="../../../../../org/apache/beam/sdk/transforms/Aggregator.html" title="interface in org.apache.beam.sdk.transforms">Aggregator</a><InputT,OutputT> createAggregatorForDoFn(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> fnClass, + <a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core">ExecutionContext.StepContext</a> stepContext, + <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> aggregatorName, + <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms">Combine.CombineFn</a><InputT,AccumT,OutputT> combine)</pre> +<div class="block">Create an aggregator with the given <code>name</code> and <a href="../../../../../org/apache/beam/sdk/transforms/Combine.CombineFn.html" title="class in org.apache.beam.sdk.transforms"><code>Combine.CombineFn</code></a>. + + <p>This method is called to create an aggregator for a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>. It receives the + class of the <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> being executed and the context of the step it is being + executed in.</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/AggregatorFactory.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/ActiveWindowSet.MergeCallback.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/AssignWindowsDoFn.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/AggregatorFactory.html" target="_top">Frames</a></li> +<li><a href="AggregatorFactory.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/AssignWindowsDoFn.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/AssignWindowsDoFn.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/AssignWindowsDoFn.html new file mode 100644 index 0000000..aaa1160 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/AssignWindowsDoFn.html @@ -0,0 +1,341 @@ +<!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>AssignWindowsDoFn (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="AssignWindowsDoFn (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/AssignWindowsDoFn.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/AggregatorFactory.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/BaseExecutionContext.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/AssignWindowsDoFn.html" target="_top">Frames</a></li> +<li><a href="AssignWindowsDoFn.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.classes.inherited.from.class.org.apache.beam.runners.core.OldDoFn">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 AssignWindowsDoFn" class="title">Class AssignWindowsDoFn<T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>></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><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core">org.apache.beam.runners.core.OldDoFn</a><T,T></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.AssignWindowsDoFn<T,W></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - Type of elements being windowed</dd> +<dd><code>W</code> - Window type</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/runners/core/OldDoFn.RequiresWindowAccess.html" title="interface in org.apache.beam.runners.core">OldDoFn.RequiresWindowAccess</a>, <a href="../../../../../org/apache/beam/sdk/transforms/display/HasDisplayData.html" title="interface in org.apache.beam.sdk.transforms.display">HasDisplayData</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../../org/apache/beam/sdk/util/SystemDoFnInternal.html" title="annotation in org.apache.beam.sdk.util">@SystemDoFnInternal</a> +public class <span class="typeNameLabel">AssignWindowsDoFn<T,W extends <a href="../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a>></span> +extends <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core">OldDoFn</a><T,T> +implements <a href="../../../../../org/apache/beam/runners/core/OldDoFn.RequiresWindowAccess.html" title="interface in org.apache.beam.runners.core">OldDoFn.RequiresWindowAccess</a></pre> +<div class="block"><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core"><code>OldDoFn</code></a> that tags elements of a <a href="../../../../../org/apache/beam/sdk/values/PCollection.html" title="class in org.apache.beam.sdk.values"><code>PCollection</code></a> with windows, according to the + provided <a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.beam.runners.core.AssignWindowsDoFn">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> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.beam.runners.core.OldDoFn"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class org.apache.beam.runners.core.<a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core">OldDoFn</a></h3> +<code><a href="../../../../../org/apache/beam/runners/core/OldDoFn.Context.html" title="class in org.apache.beam.runners.core">OldDoFn.Context</a>, <a href="../../../../../org/apache/beam/runners/core/OldDoFn.ProcessContext.html" title="class in org.apache.beam.runners.core">OldDoFn.ProcessContext</a>, <a href="../../../../../org/apache/beam/runners/core/OldDoFn.RequiresWindowAccess.html" title="interface in org.apache.beam.runners.core">OldDoFn.RequiresWindowAccess</a></code></li> +</ul> +</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/AssignWindowsDoFn.html#AssignWindowsDoFn-org.apache.beam.sdk.transforms.windowing.WindowFn-">AssignWindowsDoFn</a></span>(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><? super <a href="../../../../../org/apache/beam/runners/core/AssignWindowsDoFn.html" title="type parameter in AssignWindowsDoFn">T</a>,<a href="../../../../../org/apache/beam/runners/core/AssignWindowsDoFn.html" title="type parameter in AssignWindowsDoFn">W</a>> fn)</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/AssignWindowsDoFn.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">Processes one input element.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.runners.core.OldDoFn"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.runners.core.<a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core">OldDoFn</a></h3> +<code><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#createAggregator-java.lang.String-org.apache.beam.sdk.transforms.Combine.CombineFn-">createAggregator</a>, <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#createAggregator-java.lang.String-org.apache.beam.sdk.transforms.SerializableFunction-">createAggregator</a>, <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#finishBundle-org.apache.beam.runners.core.OldDoFn.Context-">finishBundle</a>, <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#getAllowedTimestampSkew--">getAllowedTimestampSkew</a>, <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#populateDisplayData-org.apache.beam.sdk.transforms.display.DisplayData.Builder-">populateDisplayData</a>, <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#setup--">setup</a>, <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#startBundle-org.apache.beam.runners.core.OldDoFn.Con text-">startBundle</a>, <a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#teardown--">teardown</a></code></li> +</ul> +<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="AssignWindowsDoFn-org.apache.beam.sdk.transforms.windowing.WindowFn-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AssignWindowsDoFn</h4> +<pre>public AssignWindowsDoFn(<a href="../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing">WindowFn</a><? super <a href="../../../../../org/apache/beam/runners/core/AssignWindowsDoFn.html" title="type parameter in AssignWindowsDoFn">T</a>,<a href="../../../../../org/apache/beam/runners/core/AssignWindowsDoFn.html" title="type parameter in AssignWindowsDoFn">W</a>> fn)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="processElement-org.apache.beam.runners.core.OldDoFn.ProcessContext-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>processElement</h4> +<pre>public 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="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#processElement-org.apache.beam.runners.core.OldDoFn.ProcessContext-">OldDoFn</a></code></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="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html#processElement-org.apache.beam.runners.core.OldDoFn.ProcessContext-">processElement</a></code> in class <code><a href="../../../../../org/apache/beam/runners/core/OldDoFn.html" title="class in org.apache.beam.runners.core">OldDoFn</a><<a href="../../../../../org/apache/beam/runners/core/AssignWindowsDoFn.html" title="type parameter in AssignWindowsDoFn">T</a>,<a href="../../../../../org/apache/beam/runners/core/AssignWindowsDoFn.html" title="type parameter in AssignWindowsDoFn">T</a>></code></dd> +<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> +</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/AssignWindowsDoFn.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/AggregatorFactory.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/BaseExecutionContext.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/AssignWindowsDoFn.html" target="_top">Frames</a></li> +<li><a href="AssignWindowsDoFn.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.classes.inherited.from.class.org.apache.beam.runners.core.OldDoFn">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/BaseExecutionContext.CreateStepContextFunction.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/BaseExecutionContext.CreateStepContextFunction.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/BaseExecutionContext.CreateStepContextFunction.html new file mode 100644 index 0000000..e9d14ab --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/BaseExecutionContext.CreateStepContextFunction.html @@ -0,0 +1,229 @@ +<!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>BaseExecutionContext.CreateStepContextFunction (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="BaseExecutionContext.CreateStepContextFunction (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/BaseExecutionContext.CreateStepContextFunction.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/BaseExecutionContext.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/BaseExecutionContext.StepContext.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/BaseExecutionContext.CreateStepContextFunction.html" target="_top">Frames</a></li> +<li><a href="BaseExecutionContext.CreateStepContextFunction.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 BaseExecutionContext.CreateStepContextFunction" class="title">Interface BaseExecutionContext.CreateStepContextFunction<T extends <a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core">ExecutionContext.StepContext</a>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/beam/runners/core/BaseExecutionContext.html" title="class in org.apache.beam.runners.core">BaseExecutionContext</a><<a href="../../../../../org/apache/beam/runners/core/BaseExecutionContext.html" title="type parameter in BaseExecutionContext">T</a> extends <a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core">ExecutionContext.StepContext</a>></dd> +</dl> +<hr> +<br> +<pre>protected static interface <span class="typeNameLabel">BaseExecutionContext.CreateStepContextFunction<T extends <a href="../../../../../org/apache/beam/runners/core/ExecutionContext.StepContext.html" title="interface in org.apache.beam.runners.core">ExecutionContext.StepContext</a>></span></pre> +<div class="block">Factory method interface to create an execution context if none exists during + <a href="../../../../../org/apache/beam/runners/core/BaseExecutionContext.html#getOrCreateStepContext-java.lang.String-org.apache.beam.runners.core.BaseExecutionContext.CreateStepContextFunction-"><code>BaseExecutionContext.getOrCreateStepContext(String, CreateStepContextFunction)</code></a>.</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><a href="../../../../../org/apache/beam/runners/core/BaseExecutionContext.CreateStepContextFunction.html" title="type parameter in BaseExecutionContext.CreateStepContextFunction">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/beam/runners/core/BaseExecutionContext.CreateStepContextFunction.html#create--">create</a></span>()</code> </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="create--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>create</h4> +<pre><a href="../../../../../org/apache/beam/runners/core/BaseExecutionContext.CreateStepContextFunction.html" title="type parameter in BaseExecutionContext.CreateStepContextFunction">T</a> create()</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/BaseExecutionContext.CreateStepContextFunction.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/BaseExecutionContext.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/BaseExecutionContext.StepContext.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/BaseExecutionContext.CreateStepContextFunction.html" target="_top">Frames</a></li> +<li><a href="BaseExecutionContext.CreateStepContextFunction.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>
