| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>StateQueryProcessor (Storm 2.4.0 API)</title> |
| <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="StateQueryProcessor (Storm 2.4.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/StateQueryProcessor.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/storm/streams/processors/StatefulProcessor.html" title="interface in org.apache.storm.streams.processors"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/storm/streams/processors/UpdateStateByKeyProcessor.html" title="class in org.apache.storm.streams.processors"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/streams/processors/StateQueryProcessor.html" target="_top">Frames</a></li> |
| <li><a href="StateQueryProcessor.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.storm.streams.processors</div> |
| <h2 title="Class StateQueryProcessor" class="title">Class StateQueryProcessor<K,V></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/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.storm.streams.processors.StateQueryProcessor<K,V></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/storm/streams/processors/Processor.html" title="interface in org.apache.storm.streams.processors">Processor</a><K>, <a href="../../../../../org/apache/storm/streams/processors/StatefulProcessor.html" title="interface in org.apache.storm.streams.processors">StatefulProcessor</a><K,V></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">StateQueryProcessor<K,V></span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../org/apache/storm/streams/processors/StatefulProcessor.html" title="interface in org.apache.storm.streams.processors">StatefulProcessor</a><K,V></pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.storm.streams.processors.StateQueryProcessor">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../../org/apache/storm/streams/processors/ProcessorContext.html" title="interface in org.apache.storm.streams.processors">ProcessorContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html#context">context</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html#StateQueryProcessor-org.apache.storm.streams.StreamState-">StateQueryProcessor</a></span>(<a href="../../../../../org/apache/storm/streams/StreamState.html" title="class in org.apache.storm.streams">StreamState</a><<a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html" title="type parameter in StateQueryProcessor">K</a>,<a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html" title="type parameter in StateQueryProcessor">V</a>> streamState)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html#execute-K-">execute</a></span>(<a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html" title="type parameter in StateQueryProcessor">K</a> key)</code> |
| <div class="block">Execute some operation on the input value.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html#execute-T-java.lang.String-">execute</a></span>(T input, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</code> |
| <div class="block">Executes some operations on the input and possibly emits some results.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html#finish--">finish</a></span>()</code> |
| <div class="block">This is triggered to signal the end of the current batch of values.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/storm/streams/StreamState.html" title="class in org.apache.storm.streams">StreamState</a><<a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html" title="type parameter in StateQueryProcessor">K</a>,<a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html" title="type parameter in StateQueryProcessor">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html#getStreamState--">getStreamState</a></span>()</code> </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/storm/streams/processors/StateQueryProcessor.html#init-org.apache.storm.streams.processors.ProcessorContext-">init</a></span>(<a href="../../../../../org/apache/storm/streams/processors/ProcessorContext.html" title="interface in org.apache.storm.streams.processors">ProcessorContext</a> context)</code> |
| <div class="block">Initializes the processor.</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/storm/streams/processors/StateQueryProcessor.html#initState-org.apache.storm.state.KeyValueState-">initState</a></span>(<a href="../../../../../org/apache/storm/state/KeyValueState.html" title="interface in org.apache.storm.state">KeyValueState</a><<a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html" title="type parameter in StateQueryProcessor">K</a>,<a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html" title="type parameter in StateQueryProcessor">V</a>> keyValueState)</code> |
| <div class="block">Initialize the state of the processor with the given <a href="../../../../../org/apache/storm/state/KeyValueState.html" title="interface in org.apache.storm.state"><code>KeyValueState</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected <R> void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html#mayBeForwardAggUpdate-java.util.function.Supplier-">mayBeForwardAggUpdate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a><R> result)</code> |
| <div class="block">Forwards the result update to downstream processors.</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/storm/streams/processors/StateQueryProcessor.html#punctuate-java.lang.String-">punctuate</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> stream)</code> |
| <div class="block">Punctuation marks end of a batch which can be used to compute and pass the results of one stage in the pipeline to the next.</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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="context"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>context</h4> |
| <pre>protected <a href="../../../../../org/apache/storm/streams/processors/ProcessorContext.html" title="interface in org.apache.storm.streams.processors">ProcessorContext</a> context</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="StateQueryProcessor-org.apache.storm.streams.StreamState-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>StateQueryProcessor</h4> |
| <pre>public StateQueryProcessor(<a href="../../../../../org/apache/storm/streams/StreamState.html" title="class in org.apache.storm.streams">StreamState</a><<a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html" title="type parameter in StateQueryProcessor">K</a>,<a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html" title="type parameter in StateQueryProcessor">V</a>> streamState)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="initState-org.apache.storm.state.KeyValueState-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initState</h4> |
| <pre>public void initState(<a href="../../../../../org/apache/storm/state/KeyValueState.html" title="interface in org.apache.storm.state">KeyValueState</a><<a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html" title="type parameter in StateQueryProcessor">K</a>,<a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html" title="type parameter in StateQueryProcessor">V</a>> keyValueState)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/storm/streams/processors/StatefulProcessor.html#initState-org.apache.storm.state.KeyValueState-">StatefulProcessor</a></code></span></div> |
| <div class="block"><p>Initialize the state of the processor with the given <a href="../../../../../org/apache/storm/state/KeyValueState.html" title="interface in org.apache.storm.state"><code>KeyValueState</code></a>.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/streams/processors/StatefulProcessor.html#initState-org.apache.storm.state.KeyValueState-">initState</a></code> in interface <code><a href="../../../../../org/apache/storm/streams/processors/StatefulProcessor.html" title="interface in org.apache.storm.streams.processors">StatefulProcessor</a><<a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html" title="type parameter in StateQueryProcessor">K</a>,<a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html" title="type parameter in StateQueryProcessor">V</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>keyValueState</code> - the key-value state</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStreamState--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStreamState</h4> |
| <pre>public <a href="../../../../../org/apache/storm/streams/StreamState.html" title="class in org.apache.storm.streams">StreamState</a><<a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html" title="type parameter in StateQueryProcessor">K</a>,<a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html" title="type parameter in StateQueryProcessor">V</a>> getStreamState()</pre> |
| </li> |
| </ul> |
| <a name="execute-java.lang.Object-"> |
| <!-- --> |
| </a><a name="execute-K-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>protected void execute(<a href="../../../../../org/apache/storm/streams/processors/StateQueryProcessor.html" title="type parameter in StateQueryProcessor">K</a> key)</pre> |
| <div class="block">Execute some operation on the input value. Sub classes can override this when then don't care about the source stream from where the |
| input is received.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - the input</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="init-org.apache.storm.streams.processors.ProcessorContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>public void init(<a href="../../../../../org/apache/storm/streams/processors/ProcessorContext.html" title="interface in org.apache.storm.streams.processors">ProcessorContext</a> context)</pre> |
| <div class="block"><p>Initializes the processor. This is typically invoked from the underlying storm bolt’s prepare method.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/streams/processors/Processor.html#init-org.apache.storm.streams.processors.ProcessorContext-">init</a></code> in interface <code><a href="../../../../../org/apache/storm/streams/processors/Processor.html" title="interface in org.apache.storm.streams.processors">Processor</a><T></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - the processor context</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute-java.lang.Object-java.lang.String-"> |
| <!-- --> |
| </a><a name="execute-T-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre>public void execute(T input, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> streamId)</pre> |
| <div class="block"><p>Executes some operations on the input and possibly emits some results.</p> Processors that do not care about the source stream should override <code>BaseProcessor.execute(Object)</code> instead.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/streams/processors/Processor.html#execute-T-java.lang.String-">execute</a></code> in interface <code><a href="../../../../../org/apache/storm/streams/processors/Processor.html" title="interface in org.apache.storm.streams.processors">Processor</a><T></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>input</code> - the input to be processed</dd> |
| <dd><code>streamId</code> - the source stream id from where the input is received</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="punctuate-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>punctuate</h4> |
| <pre>public void punctuate(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> stream)</pre> |
| <div class="block"><p>Punctuation marks end of a batch which can be used to compute and pass the results of one stage in the pipeline to the next. For e.g. emit the results of an aggregation.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/storm/streams/processors/Processor.html#punctuate-java.lang.String-">punctuate</a></code> in interface <code><a href="../../../../../org/apache/storm/streams/processors/Processor.html" title="interface in org.apache.storm.streams.processors">Processor</a><T></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - the stream id on which the punctuation arrived</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="finish--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>finish</h4> |
| <pre>protected void finish()</pre> |
| <div class="block">This is triggered to signal the end of the current batch of values. Sub classes can override this to emit the result of a batch of |
| values, for e.g. to emit the result of an aggregate or join operation on a batch of values. If a processor does per-value operation |
| like filter, map etc, they can choose to ignore this.</div> |
| </li> |
| </ul> |
| <a name="mayBeForwardAggUpdate-java.util.function.Supplier-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>mayBeForwardAggUpdate</h4> |
| <pre>protected final <R> void mayBeForwardAggUpdate(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Supplier.html?is-external=true" title="class or interface in java.util.function">Supplier</a><R> result)</pre> |
| <div class="block">Forwards the result update to downstream processors. Processors that operate on a batch of tuples, like aggregation, join etc can use |
| this to emit the partial results on each input if they are operating in non-windowed mode.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>R</code> - the result type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>result</code> - the result function</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/StateQueryProcessor.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 class="aboutLanguage"><script type="text/javascript" src="../../../../../highlight.pack.js"></script> |
| <script type="text/javascript"><!-- |
| hljs.initHighlightingOnLoad(); |
| //--></script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/storm/streams/processors/StatefulProcessor.html" title="interface in org.apache.storm.streams.processors"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/storm/streams/processors/UpdateStateByKeyProcessor.html" title="class in org.apache.storm.streams.processors"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/storm/streams/processors/StateQueryProcessor.html" target="_top">Frames</a></li> |
| <li><a href="StateQueryProcessor.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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 © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |