| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>IWindowedBolt (Heron Java API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-03-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="IWindowedBolt (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":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"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.heron.api.bolt</a></div> |
| <h2 title="Interface IWindowedBolt" class="title">Interface IWindowedBolt</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></code>, <code>java.io.Serializable</code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="IStatefulWindowedBolt.html" title="interface in org.apache.heron.api.bolt">IStatefulWindowedBolt</a><K,​V></code>, <code><a href="../../streamlet/IStreamletWindowOperator.html" title="interface in org.apache.heron.streamlet">IStreamletWindowOperator</a><R,​T></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="BaseStatefulWindowedBolt.html" title="class in org.apache.heron.api.bolt">BaseStatefulWindowedBolt</a></code>, <code><a href="BaseWindowedBolt.html" title="class in org.apache.heron.api.bolt">BaseWindowedBolt</a></code>, <code><a href="BaseWindowedBoltTest.TestBolt.html" title="class in org.apache.heron.api.bolt">BaseWindowedBoltTest.TestBolt</a></code>, <code><a href="../../streamlet/impl/operators/GeneralReduceByKeyAndWindowOperator.html" title="class in org.apache.heron.streamlet.impl.operators">GeneralReduceByKeyAndWindowOperator</a></code>, <code><a href="../../../storm/topology/IWindowedBoltDelegate.html" title="class in org.apache.storm.topology">IWindowedBoltDelegate</a></code>, <code><a href="../../streamlet/impl/operators/JoinOperator.html" title="class in org.apache.heron.streamlet.impl.operators">JoinOperator</a></code>, <code><a href="../../streamlet/impl/operators/ReduceByKeyAndWindowOperator.html" title="class in org.apache.heron.streamlet.impl.operators">ReduceByKeyAndWindowOperator</a></code>, <code><a href="../../integration_test/topology/windowing/stateful/StatefulWindowingTest.ConsumerBolt.html" title="class in org.apache.heron.integration_test.topology.windowing.stateful">StatefulWindowingTest.ConsumerBolt</a></code>, <code><a href="../../examples/eco/StatefulWindowSumBolt.html" title="class in org.apache.heron.examples.eco">StatefulWindowSumBolt</a></code>, <code><a href="../../streamlet/impl/operators/StreamletWindowOperator.html" title="class in org.apache.heron.streamlet.impl.operators">StreamletWindowOperator</a></code>, <code><a href="../../resource/TestWindowBolt.html" title="class in org.apache.heron.resource">TestWindowBolt</a></code>, <code><a href="../../integration_test/topology/windowing/WindowTestBase.VerificationBolt.html" title="class in org.apache.heron.integration_test.topology.windowing">WindowTestBase.VerificationBolt</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">IWindowedBolt</span> |
| extends <a href="../topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></pre> |
| <div class="block">A bolt abstraction for supporting time and count based sliding & tumbling windows.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cleanup()">cleanup</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute(org.apache.heron.api.windowing.TupleWindow)">execute</a></span>​(<a href="../windowing/TupleWindow.html" title="interface in org.apache.heron.api.windowing">TupleWindow</a> inputWindow)</code></th> |
| <td class="colLast"> |
| <div class="block">Process the tuple window and optionally emit new tuples based on the tuples in the input |
| window.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../windowing/TimestampExtractor.html" title="interface in org.apache.heron.api.windowing">TimestampExtractor</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTimestampExtractor()">getTimestampExtractor</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Return a <a href="../windowing/TimestampExtractor.html" title="interface in org.apache.heron.api.windowing"><code>TimestampExtractor</code></a> for extracting timestamps from a |
| tuple for event time based processing, or null for processing time.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prepare(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.bolt.OutputCollector)">prepare</a></span>​(java.util.Map<java.lang.String,​java.lang.Object> topoConf, |
| <a href="../topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a> context, |
| <a href="OutputCollector.html" title="class in org.apache.heron.api.bolt">OutputCollector</a> collector)</code></th> |
| <td class="colLast"> |
| <div class="block">This is similar to the |
| <a href="IBolt.html#prepare(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.bolt.OutputCollector)"><code>IBolt.prepare(Map, TopologyContext, OutputCollector)</code></a> |
| except |
| that while emitting, the tuples are automatically anchored to the tuples in the inputWindow.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.api.topology.IComponent"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.heron.api.topology.<a href="../topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></h3> |
| <code><a href="../topology/IComponent.html#declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">declareOutputFields</a>, <a href="../topology/IComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="prepare(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.bolt.OutputCollector)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>prepare</h4> |
| <pre class="methodSignature">void prepare​(java.util.Map<java.lang.String,​java.lang.Object> topoConf, |
| <a href="../topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a> context, |
| <a href="OutputCollector.html" title="class in org.apache.heron.api.bolt">OutputCollector</a> collector)</pre> |
| <div class="block">This is similar to the |
| <a href="IBolt.html#prepare(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.bolt.OutputCollector)"><code>IBolt.prepare(Map, TopologyContext, OutputCollector)</code></a> |
| except |
| that while emitting, the tuples are automatically anchored to the tuples in the inputWindow.</div> |
| </li> |
| </ul> |
| <a id="execute(org.apache.heron.api.windowing.TupleWindow)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre class="methodSignature">void execute​(<a href="../windowing/TupleWindow.html" title="interface in org.apache.heron.api.windowing">TupleWindow</a> inputWindow)</pre> |
| <div class="block">Process the tuple window and optionally emit new tuples based on the tuples in the input |
| window.</div> |
| </li> |
| </ul> |
| <a id="cleanup()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cleanup</h4> |
| <pre class="methodSignature">void cleanup()</pre> |
| </li> |
| </ul> |
| <a id="getTimestampExtractor()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getTimestampExtractor</h4> |
| <pre class="methodSignature"><a href="../windowing/TimestampExtractor.html" title="interface in org.apache.heron.api.windowing">TimestampExtractor</a> getTimestampExtractor()</pre> |
| <div class="block">Return a <a href="../windowing/TimestampExtractor.html" title="interface in org.apache.heron.api.windowing"><code>TimestampExtractor</code></a> for extracting timestamps from a |
| tuple for event time based processing, or null for processing time.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the timestamp extractor</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |