http://git-wip-us.apache.org/repos/asf/beam-site/blob/de6a0417/content/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html b/content/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html new file mode 100644 index 0000000..f1fc252 --- /dev/null +++ b/content/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html @@ -0,0 +1,405 @@ +<!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 Thu Dec 29 08:19:08 CET 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TriggerStateMachine.TriggerContext (Apache Beam SDK for Java, version 0.4.0)</title> +<meta name="date" content="2016-12-29"> +<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="TriggerStateMachine.TriggerContext (Apache Beam SDK for Java, version 0.4.0)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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/TriggerStateMachine.TriggerContext.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/triggers/TriggerStateMachine.OnMergeContext.html" title="class in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html" title="interface 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/TriggerStateMachine.TriggerContext.html" target="_top">Frames</a></li> +<li><a href="TriggerStateMachine.TriggerContext.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.beam.runners.core.triggers</div> +<h2 title="Class TriggerStateMachine.TriggerContext" class="title">Class TriggerStateMachine.TriggerContext</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><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></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">TriggerStateMachine.TriggerContext</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Information accessible to all operational hooks in this <code>Trigger</code>. + + <p>Used directly in <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#shouldFire-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-"><code>TriggerStateMachine.shouldFire(org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext)</code></a> and <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html#clear-org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext-"><code>TriggerStateMachine.clear(org.apache.beam.runners.core.triggers.TriggerStateMachine.TriggerContext)</code></a>, and extended with additional information in other methods.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html#TriggerContext--">TriggerContext</a></span>()</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="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>abstract org.joda.time.Instant</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html#currentEventTime--">currentEventTime</a></span>()</code> +<div class="block">The current event time for the input or <code>null</code> if unknown.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>abstract org.joda.time.Instant</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html#currentProcessingTime--">currentProcessingTime</a></span>()</code> +<div class="block">The current processing time.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>abstract org.joda.time.Instant</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html#currentSynchronizedProcessingTime--">currentSynchronizedProcessingTime</a></span>()</code> +<div class="block">The current synchronized upstream processing time or <code>null</code> if unknown.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html#deleteTimer-org.joda.time.Instant-org.apache.beam.sdk.util.TimeDomain-">deleteTimer</a></span>(org.joda.time.Instant timestamp, + <a href="../../../../../../org/apache/beam/sdk/util/TimeDomain.html" title="enum in org.apache.beam.sdk.util">TimeDomain</a> domain)</code> +<div class="block">Removes the timer set in this trigger context for the given <code>Instant</code> + and <a href="../../../../../../org/apache/beam/sdk/util/TimeDomain.html" title="enum in org.apache.beam.sdk.util"><code>TimeDomain</code></a>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>abstract <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html#forTrigger-org.apache.beam.runners.core.triggers.ExecutableTriggerStateMachine-">forTrigger</a></span>(<a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a> trigger)</code> +<div class="block">Create a sub-context for the given sub-trigger.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>abstract <a href="../../../../../../org/apache/beam/sdk/util/state/StateAccessor.html" title="interface in org.apache.beam.sdk.util.state">StateAccessor</a><?></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html#state--">state</a></span>()</code> +<div class="block">Returns the interface for accessing persistent state.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>abstract <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html" title="interface in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html#trigger--">trigger</a></span>()</code> +<div class="block">Returns the interface for accessing trigger info.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>abstract <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html#window--">window</a></span>()</code> +<div class="block">The window that the current context is executing in.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="TriggerContext--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TriggerContext</h4> +<pre>public TriggerContext()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="trigger--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>trigger</h4> +<pre>public abstract <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html" title="interface in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerInfo</a> trigger()</pre> +<div class="block">Returns the interface for accessing trigger info.</div> +</li> +</ul> +<a name="state--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>state</h4> +<pre>public abstract <a href="../../../../../../org/apache/beam/sdk/util/state/StateAccessor.html" title="interface in org.apache.beam.sdk.util.state">StateAccessor</a><?> state()</pre> +<div class="block">Returns the interface for accessing persistent state.</div> +</li> +</ul> +<a name="window--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>window</h4> +<pre>public abstract <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/BoundedWindow.html" title="class in org.apache.beam.sdk.transforms.windowing">BoundedWindow</a> window()</pre> +<div class="block">The window that the current context is executing in.</div> +</li> +</ul> +<a name="forTrigger-org.apache.beam.runners.core.triggers.ExecutableTriggerStateMachine-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>forTrigger</h4> +<pre>public abstract <a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine.TriggerContext</a> forTrigger(<a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a> trigger)</pre> +<div class="block">Create a sub-context for the given sub-trigger.</div> +</li> +</ul> +<a name="deleteTimer-org.joda.time.Instant-org.apache.beam.sdk.util.TimeDomain-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deleteTimer</h4> +<pre>public abstract void deleteTimer(org.joda.time.Instant timestamp, + <a href="../../../../../../org/apache/beam/sdk/util/TimeDomain.html" title="enum in org.apache.beam.sdk.util">TimeDomain</a> domain)</pre> +<div class="block">Removes the timer set in this trigger context for the given <code>Instant</code> + and <a href="../../../../../../org/apache/beam/sdk/util/TimeDomain.html" title="enum in org.apache.beam.sdk.util"><code>TimeDomain</code></a>.</div> +</li> +</ul> +<a name="currentProcessingTime--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>currentProcessingTime</h4> +<pre>public abstract org.joda.time.Instant currentProcessingTime()</pre> +<div class="block">The current processing time.</div> +</li> +</ul> +<a name="currentSynchronizedProcessingTime--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>currentSynchronizedProcessingTime</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/javax/annotation/Nullable.html?is-external=true"; title="class or interface in javax.annotation">@Nullable</a> +public abstract org.joda.time.Instant currentSynchronizedProcessingTime()</pre> +<div class="block">The current synchronized upstream processing time or <code>null</code> if unknown.</div> +</li> +</ul> +<a name="currentEventTime--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>currentEventTime</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/javax/annotation/Nullable.html?is-external=true"; title="class or interface in javax.annotation">@Nullable</a> +public abstract org.joda.time.Instant currentEventTime()</pre> +<div class="block">The current event time for the input or <code>null</code> if unknown.</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/TriggerStateMachine.TriggerContext.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/triggers/TriggerStateMachine.OnMergeContext.html" title="class in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html" title="interface 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/TriggerStateMachine.TriggerContext.html" target="_top">Frames</a></li> +<li><a href="TriggerStateMachine.TriggerContext.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016 <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/de6a0417/content/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html ---------------------------------------------------------------------- diff --git a/content/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html b/content/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html new file mode 100644 index 0000000..823759e --- /dev/null +++ b/content/documentation/sdks/javadoc/0.4.0/org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html @@ -0,0 +1,406 @@ +<!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 Thu Dec 29 08:19:08 CET 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TriggerStateMachine.TriggerInfo (Apache Beam SDK for Java, version 0.4.0)</title> +<meta name="date" content="2016-12-29"> +<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="TriggerStateMachine.TriggerInfo (Apache Beam SDK for Java, version 0.4.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}; +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/TriggerStateMachine.TriggerInfo.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/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachineContextFactory.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/TriggerStateMachine.TriggerInfo.html" target="_top">Frames</a></li> +<li><a href="TriggerStateMachine.TriggerInfo.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.triggers</div> +<h2 title="Interface TriggerStateMachine.TriggerInfo" class="title">Interface TriggerStateMachine.TriggerInfo</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.MergingTriggerInfo.html" title="interface in org.apache.beam.runners.core.triggers">TriggerStateMachine.MergingTriggerInfo</a></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">TriggerStateMachine</a></dd> +</dl> +<hr> +<br> +<pre>public static interface <span class="typeNameLabel">TriggerStateMachine.TriggerInfo</span></pre> +<div class="block">Interface for accessing information about the trigger being executed and other triggers in the + same tree.</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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html#areAllSubtriggersFinished--">areAllSubtriggersFinished</a></span>()</code> +<div class="block">Returns true if all the sub-triggers of the current trigger are marked finished.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html#firstUnfinishedSubTrigger--">firstUnfinishedSubTrigger</a></span>()</code> +<div class="block">Returns the first unfinished sub-trigger.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html#isFinished--">isFinished</a></span>()</code> +<div class="block">Returns true if the current trigger is marked finished.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html#isFinished-int-">isFinished</a></span>(int subtriggerIndex)</code> +<div class="block">Return true if the given subtrigger is marked finished.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html#isMerging--">isMerging</a></span>()</code> +<div class="block">Returns true if the windowing strategy of the current <code>PCollection</code> is a merging <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a>.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html#resetTree--">resetTree</a></span>()</code> +<div class="block">Clears all keyed state for triggers in the current sub-tree and unsets all the associated + finished bits.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html#setFinished-boolean-">setFinished</a></span>(boolean finished)</code> +<div class="block">Sets the finished bit for the current trigger.</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/triggers/TriggerStateMachine.TriggerInfo.html#setFinished-boolean-int-">setFinished</a></span>(boolean finished, + int subTriggerIndex)</code> +<div class="block">Sets the finished bit for the given sub-trigger.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html#subTrigger-int-">subTrigger</a></span>(int subtriggerIndex)</code> +<div class="block">Access the executable version of the specified sub-trigger.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><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><<a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html#subTriggers--">subTriggers</a></span>()</code> +<div class="block">Access the executable versions of the sub-triggers of the current trigger.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><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><<a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachine.TriggerInfo.html#unfinishedSubTriggers--">unfinishedSubTriggers</a></span>()</code> +<div class="block">Returns an iterable over the unfinished sub-triggers of the current trigger.</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="isMerging--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isMerging</h4> +<pre>boolean isMerging()</pre> +<div class="block">Returns true if the windowing strategy of the current <code>PCollection</code> is a merging <a href="../../../../../../org/apache/beam/sdk/transforms/windowing/WindowFn.html" title="class in org.apache.beam.sdk.transforms.windowing"><code>WindowFn</code></a>. If true, the trigger execution needs to keep enough information to support the + possibility of <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> being called. If false, <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> will never be called.</div> +</li> +</ul> +<a name="subTriggers--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>subTriggers</h4> +<pre><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><<a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a>> subTriggers()</pre> +<div class="block">Access the executable versions of the sub-triggers of the current trigger.</div> +</li> +</ul> +<a name="subTrigger-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>subTrigger</h4> +<pre><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a> subTrigger(int subtriggerIndex)</pre> +<div class="block">Access the executable version of the specified sub-trigger.</div> +</li> +</ul> +<a name="isFinished--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isFinished</h4> +<pre>boolean isFinished()</pre> +<div class="block">Returns true if the current trigger is marked finished.</div> +</li> +</ul> +<a name="isFinished-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isFinished</h4> +<pre>boolean isFinished(int subtriggerIndex)</pre> +<div class="block">Return true if the given subtrigger is marked finished.</div> +</li> +</ul> +<a name="areAllSubtriggersFinished--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>areAllSubtriggersFinished</h4> +<pre>boolean areAllSubtriggersFinished()</pre> +<div class="block">Returns true if all the sub-triggers of the current trigger are marked finished.</div> +</li> +</ul> +<a name="unfinishedSubTriggers--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unfinishedSubTriggers</h4> +<pre><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><<a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a>> unfinishedSubTriggers()</pre> +<div class="block">Returns an iterable over the unfinished sub-triggers of the current trigger.</div> +</li> +</ul> +<a name="firstUnfinishedSubTrigger--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>firstUnfinishedSubTrigger</h4> +<pre><a href="../../../../../../org/apache/beam/runners/core/triggers/ExecutableTriggerStateMachine.html" title="class in org.apache.beam.runners.core.triggers">ExecutableTriggerStateMachine</a> firstUnfinishedSubTrigger()</pre> +<div class="block">Returns the first unfinished sub-trigger.</div> +</li> +</ul> +<a name="resetTree--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>resetTree</h4> +<pre>void resetTree() + 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">Clears all keyed state for triggers in the current sub-tree and unsets all the associated + finished bits.</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="setFinished-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFinished</h4> +<pre>void setFinished(boolean finished)</pre> +<div class="block">Sets the finished bit for the current trigger.</div> +</li> +</ul> +<a name="setFinished-boolean-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setFinished</h4> +<pre>void setFinished(boolean finished, + int subTriggerIndex)</pre> +<div class="block">Sets the finished bit for the given sub-trigger.</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/TriggerStateMachine.TriggerInfo.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/triggers/TriggerStateMachine.TriggerContext.html" title="class in org.apache.beam.runners.core.triggers"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/beam/runners/core/triggers/TriggerStateMachineContextFactory.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/TriggerStateMachine.TriggerInfo.html" target="_top">Frames</a></li> +<li><a href="TriggerStateMachine.TriggerInfo.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 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
