http://git-wip-us.apache.org/repos/asf/beam-site/blob/7b1f1576/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/package-use.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/package-use.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/package-use.html new file mode 100644 index 0000000..847d7b7 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/package-use.html @@ -0,0 +1,423 @@ +<!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:30 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Uses of Package org.apache.beam.runners.core (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="Uses of Package org.apache.beam.runners.core (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +</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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Uses of Package org.apache.beam.runners.core" class="title">Uses of Package<br>org.apache.beam.runners.core</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../org/apache/beam/runners/core/package-summary.html">org.apache.beam.runners.core</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.beam.runners.core">org.apache.beam.runners.core</a></td> +<td class="colLast"> +<div class="block">Provides utilities for Beam runner authors.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.beam.runners.core.triggers">org.apache.beam.runners.core.triggers</a></td> +<td class="colLast"> +<div class="block">State machine implementations for triggers, called "triggers" because + they react to events.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.beam.runners.direct">org.apache.beam.runners.direct</a></td> +<td class="colLast"> +<div class="block">Defines the <a href="../../../../../org/apache/beam/sdk/options/PipelineOptions.DirectRunner.html" title="class in org.apache.beam.sdk.options"><code>PipelineOptions.DirectRunner</code></a> + which executes both Bounded and Unbounded <code>Pipelines</code> on the local machine.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.beam.runners.flink">org.apache.beam.runners.flink</a></td> +<td class="colLast"> +<div class="block">Internal implementation of the Beam runner for Apache Flink.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.beam.runners.spark.aggregators">org.apache.beam.runners.spark.aggregators</a></td> +<td class="colLast"> +<div class="block">Provides internal utilities for implementing Beam aggregators using Spark accumulators.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.beam.runners.core"> +<!-- --> +</a> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../org/apache/beam/runners/core/package-summary.html">org.apache.beam.runners.core</a> used by <a href="../../../../../org/apache/beam/runners/core/package-summary.html">org.apache.beam.runners.core</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/ActiveWindowSet.html#org.apache.beam.runners.core">ActiveWindowSet</a> +<div class="block">Track which windows are <i>active</i>, and the <i>state address window(s)</i> under which their + state is stored.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/ActiveWindowSet.MergeCallback.html#org.apache.beam.runners.core">ActiveWindowSet.MergeCallback</a> +<div class="block">Callback for <a href="../../../../../org/apache/beam/runners/core/ActiveWindowSet.html#merge-org.apache.beam.runners.core.ActiveWindowSet.MergeCallback-"><code>ActiveWindowSet.merge(org.apache.beam.runners.core.ActiveWindowSet.MergeCallback<W>)</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/AggregatorFactory.html#org.apache.beam.runners.core">AggregatorFactory</a> +<div class="block">A factory for creating aggregators.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/BaseExecutionContext.CreateStepContextFunction.html#org.apache.beam.runners.core">BaseExecutionContext.CreateStepContextFunction</a> +<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> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/DoFnRunner.html#org.apache.beam.runners.core">DoFnRunner</a> +<div class="block">An wrapper interface that represents the execution of a <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/DoFnRunners.OutputManager.html#org.apache.beam.runners.core">DoFnRunners.OutputManager</a> +<div class="block">Information about how to create output receivers and output to them.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/ElementAndRestriction.html#org.apache.beam.runners.core">ElementAndRestriction</a> +<div class="block">A tuple of an element and a restriction applied to processing it with a + <a href="https://s.apache.org/splittable-do-fn";>splittable</a> <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/ElementAndRestrictionCoder.html#org.apache.beam.runners.core">ElementAndRestrictionCoder</a> +<div class="block">A <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders"><code>Coder</code></a> for <a href="../../../../../org/apache/beam/runners/core/ElementAndRestriction.html" title="class in org.apache.beam.runners.core"><code>ElementAndRestriction</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/ExecutionContext.html#org.apache.beam.runners.core">ExecutionContext</a> +<div class="block">Context for the current execution.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/ExecutionContext.StepContext.html#org.apache.beam.runners.core">ExecutionContext.StepContext</a> +<div class="block">Per-step, per-key context used for retrieving state.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/GroupAlsoByWindowsDoFn.html#org.apache.beam.runners.core">GroupAlsoByWindowsDoFn</a> +<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 merges windows and groups elements in those windows, optionally + combining values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/KeyedWorkItem.html#org.apache.beam.runners.core">KeyedWorkItem</a> +<div class="block">Interface that contains all the timers and elements associated with a specific work item.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/KeyedWorkItemCoder.html#org.apache.beam.runners.core">KeyedWorkItemCoder</a> +<div class="block">A <a href="../../../../../org/apache/beam/sdk/coders/Coder.html" title="interface in org.apache.beam.sdk.coders"><code>Coder</code></a> for <a href="../../../../../org/apache/beam/runners/core/KeyedWorkItem.html" title="interface in org.apache.beam.runners.core"><code>KeyedWorkItems</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/OldDoFn.html#org.apache.beam.runners.core">OldDoFn</a> +<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> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/OldDoFn.Context.html#org.apache.beam.runners.core">OldDoFn.Context</a> +<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="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/OldDoFn.ProcessContext.html#org.apache.beam.runners.core">OldDoFn.ProcessContext</a> +<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>OldDoFn.processElement(org.apache.beam.runners.core.OldDoFn<InputT, OutputT>.ProcessContext)</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/OldDoFn.RequiresWindowAccess.html#org.apache.beam.runners.core">OldDoFn.RequiresWindowAccess</a> +<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> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/OutputWindowedValue.html#org.apache.beam.runners.core">OutputWindowedValue</a> +<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> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/PeekingReiterator.html#org.apache.beam.runners.core">PeekingReiterator</a> +<div class="block">A <a href="../../../../../org/apache/beam/sdk/util/common/Reiterator.html" title="interface in org.apache.beam.sdk.util.common"><code>Reiterator</code></a> that supports one-element lookahead during iteration.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/PerKeyCombineFnRunner.html#org.apache.beam.runners.core">PerKeyCombineFnRunner</a> +<div class="block">An interface that runs a <a href="../../../../../org/apache/beam/sdk/transforms/CombineFnBase.PerKeyCombineFn.html" title="interface in org.apache.beam.sdk.transforms"><code>CombineFnBase.PerKeyCombineFn</code></a> with unified APIs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/PushbackSideInputDoFnRunner.html#org.apache.beam.runners.core">PushbackSideInputDoFnRunner</a> +<div class="block">A <a href="../../../../../org/apache/beam/runners/core/DoFnRunner.html" title="interface in org.apache.beam.runners.core"><code>DoFnRunner</code></a> that can refuse to process elements that are not ready, instead returning + them via the <a href="../../../../../org/apache/beam/runners/core/PushbackSideInputDoFnRunner.html#processElementInReadyWindows-org.apache.beam.sdk.util.WindowedValue-"><code>PushbackSideInputDoFnRunner.processElementInReadyWindows(WindowedValue)</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/ReduceFn.html#org.apache.beam.runners.core">ReduceFn</a> +<div class="block">Specification for processing to happen after elements have been grouped by key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/ReduceFn.Context.html#org.apache.beam.runners.core">ReduceFn.Context</a> +<div class="block">Information accessible to all the processing methods in this <code>ReduceFn</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/ReduceFn.OnMergeContext.html#org.apache.beam.runners.core">ReduceFn.OnMergeContext</a> +<div class="block">Information accessible within <a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#onMerge-org.apache.beam.runners.core.ReduceFn.OnMergeContext-"><code>ReduceFn.onMerge(org.apache.beam.runners.core.ReduceFn<K, InputT, OutputT, W>.OnMergeContext)</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/ReduceFn.OnTriggerContext.html#org.apache.beam.runners.core">ReduceFn.OnTriggerContext</a> +<div class="block">Information accessible within <a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#onTrigger-org.apache.beam.runners.core.ReduceFn.OnTriggerContext-"><code>ReduceFn.onTrigger(org.apache.beam.runners.core.ReduceFn<K, InputT, OutputT, W>.OnTriggerContext)</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/ReduceFn.ProcessValueContext.html#org.apache.beam.runners.core">ReduceFn.ProcessValueContext</a> +<div class="block">Information accessible within <a href="../../../../../org/apache/beam/runners/core/ReduceFn.html#processValue-org.apache.beam.runners.core.ReduceFn.ProcessValueContext-"><code>ReduceFn.processValue(org.apache.beam.runners.core.ReduceFn<K, InputT, OutputT, W>.ProcessValueContext)</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/SplittableParDo.ProcessFn.html#org.apache.beam.runners.core">SplittableParDo.ProcessFn</a> +<div class="block">The heart of splittable <a href="../../../../../org/apache/beam/sdk/transforms/DoFn.html" title="class in org.apache.beam.sdk.transforms"><code>DoFn</code></a> execution: processes a single (element, restriction) pair + by creating a tracker for the restriction and checkpointing/resuming processing later if + necessary.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/SystemReduceFn.html#org.apache.beam.runners.core">SystemReduceFn</a> +<div class="block"><a href="../../../../../org/apache/beam/runners/core/ReduceFn.html" title="class in org.apache.beam.runners.core"><code>ReduceFn</code></a> implementing the default reduction behaviors of <a href="../../../../../org/apache/beam/sdk/transforms/GroupByKey.html" title="class in org.apache.beam.sdk.transforms"><code>GroupByKey</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/UnboundedReadFromBoundedSource.BoundedToUnboundedSourceAdapter.html#org.apache.beam.runners.core">UnboundedReadFromBoundedSource.BoundedToUnboundedSourceAdapter</a> +<div class="block">A <code>BoundedSource</code> to <code>UnboundedSource</code> adapter.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.beam.runners.core.triggers"> +<!-- --> +</a> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../org/apache/beam/runners/core/package-summary.html">org.apache.beam.runners.core</a> used by <a href="../../../../../org/apache/beam/runners/core/triggers/package-summary.html">org.apache.beam.runners.core.triggers</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/ActiveWindowSet.html#org.apache.beam.runners.core.triggers">ActiveWindowSet</a> +<div class="block">Track which windows are <i>active</i>, and the <i>state address window(s)</i> under which their + state is stored.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.beam.runners.direct"> +<!-- --> +</a> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../org/apache/beam/runners/core/package-summary.html">org.apache.beam.runners.core</a> used by <a href="../../../../../org/apache/beam/runners/direct/package-summary.html">org.apache.beam.runners.direct</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/AggregatorFactory.html#org.apache.beam.runners.direct">AggregatorFactory</a> +<div class="block">A factory for creating aggregators.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/ExecutionContext.StepContext.html#org.apache.beam.runners.direct">ExecutionContext.StepContext</a> +<div class="block">Per-step, per-key context used for retrieving state.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.beam.runners.flink"> +<!-- --> +</a> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../org/apache/beam/runners/core/package-summary.html">org.apache.beam.runners.core</a> used by <a href="../../../../../org/apache/beam/runners/flink/package-summary.html">org.apache.beam.runners.flink</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/OldDoFn.ProcessContext.html#org.apache.beam.runners.flink">OldDoFn.ProcessContext</a> +<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>OldDoFn.processElement(org.apache.beam.runners.core.OldDoFn<InputT, OutputT>.ProcessContext)</code></a>.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.beam.runners.spark.aggregators"> +<!-- --> +</a> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../org/apache/beam/runners/core/package-summary.html">org.apache.beam.runners.core</a> used by <a href="../../../../../org/apache/beam/runners/spark/aggregators/package-summary.html">org.apache.beam.runners.spark.aggregators</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/AggregatorFactory.html#org.apache.beam.runners.spark.aggregators">AggregatorFactory</a> +<div class="block">A factory for creating aggregators.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><a href="../../../../../org/apache/beam/runners/core/class-use/ExecutionContext.StepContext.html#org.apache.beam.runners.spark.aggregators">ExecutionContext.StepContext</a> +<div class="block">Per-step, per-key context used for retrieving state.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Use</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</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/beam/runners/core/package-use.html" target="_top">Frames</a></li> +<li><a href="package-use.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> +<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/triggers/AfterAllStateMachine.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/triggers/AfterAllStateMachine.html b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/triggers/AfterAllStateMachine.html new file mode 100644 index 0000000..ba2cb97 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.5.0/org/apache/beam/runners/core/triggers/AfterAllStateMachine.html @@ -0,0 +1,449 @@ +<!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>AfterAllStateMachine (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="AfterAllStateMachine (Apache Beam SDK for Java, version 0.5.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/AfterAllStateMachine.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/triggers/AfterDelayFromFirstElementStateMachine.html" title="class in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/core/triggers/AfterAllStateMachine.html" target="_top">Frames</a></li> +<li><a href="AfterAllStateMachine.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.triggers.TriggerStateMachine">Nested</a> | </li> +<li><a href="#fields.inherited.from.class.org.apache.beam.runners.core.triggers.TriggerStateMachine">Field</a> | </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.triggers</div> +<h2 title="Class AfterAllStateMachine" class="title">Class AfterAllStateMachine</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/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">org.apache.beam.runners.core.triggers.TriggerStateMachine</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">org.apache.beam.runners.core.triggers.TriggerStateMachine.OnceTriggerStateMachine</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.triggers.AfterAllStateMachine</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<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></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html" title="annotation in org.apache.beam.sdk.annotations">@Experimental</a>(<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.html#value--">value</a>=<a href="../../../../../../org/apache/beam/sdk/annotations/Experimental.Kind.html#TRIGGER">TRIGGER</a>) +public class <span class="typeNameLabel">AfterAllStateMachine</span> +extends <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnceTriggerStateMachine</a></pre> +<div class="block">A <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers"><code>TriggerStateMachine</code></a> that fires and finishes once after all of its sub-triggers + have fired.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../serialized-form.html#org.apache.beam.runners.core.triggers.AfterAllStateMachine">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.triggers.TriggerStateMachine"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class org.apache.beam.runners.core.triggers.<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></h3> +<code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.MergingTriggerInfo.html" title="interface in org.apache.beam.runners.core.triggers">TriggerStateMachine.MergingTriggerInfo</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnceTriggerStateMachine</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnElementContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnElementContext</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnMergeContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnMergeContext</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.tr iggers">TriggerStateMachine.TriggerContext</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html" title="interface in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerInfo</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.beam.runners.core.triggers.TriggerStateMachine"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.beam.runners.core.triggers.<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></h3> +<code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#subTriggers">subTriggers</a></code></li> +</ul> +</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>static <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnceTriggerStateMachine</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/AfterAllStateMachine.html#of-java.lang.Iterable-">of</a></span>(<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><? extends <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a>> triggers)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnceTriggerStateMachine</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/AfterAllStateMachine.html#of-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnceTriggerStateMachine...-">of</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnceTriggerStateMachine</a>... triggers)</code> +<div class="block">Returns an <code>AfterAll</code> <code>Trigger</code> with the given subtriggers.</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/triggers/AfterAllStateMachine.html#onElement-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnElementContext-">onElement</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnElementContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnElementContext</a> c)</code> +<div class="block">Called every time an element is incorporated into a window.</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/triggers/AfterAllStateMachine.html#onMerge-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext-">onMerge</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnMergeContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnMergeContext</a> c)</code> +<div class="block">Called immediately after windows have been merged.</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/triggers/AfterAllStateMachine.html#onOnlyFiring-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">onOnlyFiring</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> context)</code> +<div class="block">Invokes <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html#onFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-"><code>TriggerStateMachine.OnceTriggerStateMachine.onFire(org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext)</code></a> for all subtriggers, eliding redundant calls to <a href="../../../../../../org/apache/beam/runners/core/triggers/AfterAllStateMachine.html#shouldFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-"><code>shouldFire(org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext)</code></a> + because they all must be ready to fire.</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/triggers/AfterAllStateMachine.html#shouldFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">shouldFire</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> context)</code> +<div class="block">Returns <code>true</code> if the current state of the trigger indicates that its condition + is satisfied and it is ready to fire.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/AfterAllStateMachine.html#toString--">toString</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.runners.core.triggers.TriggerStateMachine.OnceTriggerStateMachine"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.runners.core.triggers.<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnceTriggerStateMachine</a></h3> +<code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html#onFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">onFire</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.runners.core.triggers.TriggerStateMachine"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.beam.runners.core.triggers.<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></h3> +<code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#clear-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">clear</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#equals-java.lang.Object-">equals</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#hashCode--">hashCode</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#isCompatible-org.apache.beam.runners.core.triggers.TriggerStateMachine-">isCompatible</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#orFinally-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnceTriggerStateMachine-">orFinally</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#prefetchOnElement-org.apache.beam.sdk.util.state.StateAccessor-">prefetchOnElement</a>, <a href ="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#prefetchOnFire-org.apache.beam.sdk.util.state.StateAccessor-">prefetchOnFire</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#prefetchOnMerge-org.apache.beam.sdk.util.state.MergingStateAccessor-">prefetchOnMerge</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#prefetchShouldFire-org.apache.beam.sdk.util.state.StateAccessor-">prefetchShouldFire</a>, <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#subTriggers--">subTriggers</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#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#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#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-ex ternal=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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="of-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnceTriggerStateMachine...-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>of</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/SafeVarargs.html?is-external=true"; title="class or interface in java.lang">@SafeVarargs</a> +public static <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnceTriggerStateMachine</a> of(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnceTriggerStateMachine</a>... triggers)</pre> +<div class="block">Returns an <code>AfterAll</code> <code>Trigger</code> with the given subtriggers.</div> +</li> +</ul> +<a name="of-java.lang.Iterable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>of</h4> +<pre>public static <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnceTriggerStateMachine</a> of(<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><? extends <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a>> triggers)</pre> +</li> +</ul> +<a name="onElement-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnElementContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onElement</h4> +<pre>public void onElement(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnElementContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnElementContext</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/triggers/TriggerStateMachine.html#onElement-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnElementContext-">TriggerStateMachine</a></code></span></div> +<div class="block">Called every time an element is incorporated into a window.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#onElement-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnElementContext-">onElement</a></code> in class <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</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> +</dl> +</li> +</ul> +<a name="onMerge-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onMerge</h4> +<pre>public void onMerge(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnMergeContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnMergeContext</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/triggers/TriggerStateMachine.html#onMerge-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext-">TriggerStateMachine</a></code></span></div> +<div class="block">Called immediately after windows have been merged. + + <p>Leaf triggers should update their state by inspecting their status and any state in the + merging windows. Composite triggers should update their state by calling <a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html#invokeOnMerge-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext-"><code>ExecutableTriggerStateMachine.invokeOnMerge(org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext)</code></a> on their sub-triggers, and applying appropriate + logic. + + <p>A trigger such as <a href="../../../../../../org/apache/beam/runners/core/triggers/AfterWatermarkStateMachine.html#pastEndOfWindow--"><code>AfterWatermarkStateMachine.pastEndOfWindow()</code></a> may no longer be + finished; it is the responsibility of the trigger itself to record this fact. It is forbidden + for a trigger to become finished due to <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#onMerge-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext-"><code>TriggerStateMachine.onMerge(org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext)</code></a>, as it has not yet fired the pending + elements that led to it being ready to fire. + + <p>The implementation does not need to clear out any state associated with the old windows.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#onMerge-org.apache.beam.runners.core.triggers.TriggerStateMachine.OnMergeContext-">onMerge</a></code> in class <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</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> +</dl> +</li> +</ul> +<a name="shouldFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>shouldFire</h4> +<pre>public boolean shouldFire(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> context) + 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">Returns <code>true</code> if the current state of the trigger indicates that its condition + is satisfied and it is ready to fire.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#shouldFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">shouldFire</a></code> in class <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>true</code> if all subtriggers return <code>true</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> +</dl> +</li> +</ul> +<a name="onOnlyFiring-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onOnlyFiring</h4> +<pre>public void onOnlyFiring(<a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> context) + 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">Invokes <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html#onFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-"><code>TriggerStateMachine.OnceTriggerStateMachine.onFire(org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext)</code></a> for all subtriggers, eliding redundant calls to <a href="../../../../../../org/apache/beam/runners/core/triggers/AfterAllStateMachine.html#shouldFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-"><code>shouldFire(org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext)</code></a> + because they all must be ready to fire.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html#onOnlyFiring-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-">onOnlyFiring</a></code> in class <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.OnceTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.OnceTriggerStateMachine</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> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <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> toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#toString--">toString</a></code> in class <code><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></code></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/AfterAllStateMachine.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/triggers/AfterDelayFromFirstElementStateMachine.html" title="class in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/beam/runners/core/triggers/AfterAllStateMachine.html" target="_top">Frames</a></li> +<li><a href="AfterAllStateMachine.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.triggers.TriggerStateMachine">Nested</a> | </li> +<li><a href="#fields.inherited.from.class.org.apache.beam.runners.core.triggers.TriggerStateMachine">Field</a> | </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>
