| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>WindowedBoltExecutor (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="WindowedBoltExecutor (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":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"; |
| 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><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 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="Class WindowedBoltExecutor" class="title">Class WindowedBoltExecutor</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.api.bolt.WindowedBoltExecutor</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code>java.io.Serializable</code>, <code><a href="IBolt.html" title="interface in org.apache.heron.api.bolt">IBolt</a></code>, <code><a href="IRichBolt.html" title="interface in org.apache.heron.api.bolt">IRichBolt</a></code>, <code><a href="../topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></code>, <code><a href="../topology/IStatefulComponent.html" title="interface in org.apache.heron.api.topology">IStatefulComponent</a><java.io.Serializable,​java.io.Serializable></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="StatefulWindowedBoltExecutor.html" title="class in org.apache.heron.api.bolt">StatefulWindowedBoltExecutor</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">WindowedBoltExecutor</span> |
| extends java.lang.Object |
| implements <a href="IRichBolt.html" title="interface in org.apache.heron.api.bolt">IRichBolt</a>, <a href="../topology/IStatefulComponent.html" title="interface in org.apache.heron.api.topology">IStatefulComponent</a><java.io.Serializable,​java.io.Serializable></pre> |
| <div class="block">An <a href="IWindowedBolt.html" title="interface in org.apache.heron.api.bolt"><code>IWindowedBolt</code></a> wrapper that does the windowing of tuples.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../serialized-form.html#org.apache.heron.api.bolt.WindowedBoltExecutor">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#LATE_TUPLE_FIELD">LATE_TUPLE_FIELD</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../windowing/WaterMarkEventGenerator.html" title="class in org.apache.heron.api.windowing">WaterMarkEventGenerator</a><<a href="../tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#waterMarkEventGenerator">waterMarkEventGenerator</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.heron.api.bolt.IWindowedBolt)">WindowedBoltExecutor</a></span>​(<a href="IWindowedBolt.html" title="interface in org.apache.heron.api.bolt">IWindowedBolt</a> bolt)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== 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="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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#boltExecute(java.util.List,java.util.List,java.util.List,java.lang.Long)">boltExecute</a></span>​(java.util.List<<a href="../tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a>> tuples, |
| java.util.List<<a href="../tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a>> newTuples, |
| java.util.List<<a href="../tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a>> expiredTuples, |
| java.lang.Long timestamp)</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="#cleanup()">cleanup</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Called when an IBolt is going to be shutdown.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">declareOutputFields</a></span>​(<a href="../topology/OutputFieldsDeclarer.html" title="interface in org.apache.heron.api.topology">OutputFieldsDeclarer</a> declarer)</code></th> |
| <td class="colLast"> |
| <div class="block">Declare the output schema for all the streams of this topology.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doPrepare(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.bolt.OutputCollector,java.util.Collection)">doPrepare</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, |
| java.util.Collection<<a href="../windowing/Event.html" title="interface in org.apache.heron.api.windowing">Event</a><<a href="../tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a>>> queue)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute(org.apache.heron.api.tuple.Tuple)">execute</a></span>​(<a href="../tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a> input)</code></th> |
| <td class="colLast"> |
| <div class="block">Process a single tuple of input.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,​java.lang.Object></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentConfiguration()">getComponentConfiguration</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Declare configuration specific to this component.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected java.util.Map<java.lang.String,​java.io.Serializable></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getState()">getState</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTopologyTimeoutMillis(java.util.Map)">getTopologyTimeoutMillis</a></span>​(java.util.Map<java.lang.String,​java.lang.Object> topoConf)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#initState(org.apache.heron.api.state.State)">initState</a></span>​(<a href="../state/State.html" title="interface in org.apache.heron.api.state">State</a><java.io.Serializable,​java.io.Serializable> state)</code></th> |
| <td class="colLast"> |
| <div class="block">Initializes the state of the function or operator to that of a previous checkpoint.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../windowing/WindowLifecycleListener.html" title="interface in org.apache.heron.api.windowing">WindowLifecycleListener</a><<a href="../tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newWindowLifecycleListener()">newWindowLifecycleListener</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <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">Called when a task for this component is initialized within a worker on the cluster.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#preSave(java.lang.String)">preSave</a></span>​(java.lang.String checkpointId)</code></th> |
| <td class="colLast"> |
| <div class="block">This is a hook for the component to perform some actions just before the |
| framework saves its state.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#start()">start</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Start the trigger policy and waterMarkEventGenerator if set</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validate(java.util.Map,org.apache.heron.api.bolt.BaseWindowedBolt.Count,java.lang.Long,org.apache.heron.api.bolt.BaseWindowedBolt.Count,java.lang.Long)">validate</a></span>​(java.util.Map<java.lang.String,​java.lang.Object> topoConf, |
| <a href="BaseWindowedBolt.Count.html" title="class in org.apache.heron.api.bolt">BaseWindowedBolt.Count</a> windowLengthCount, |
| java.lang.Long windowLengthDuration, |
| <a href="BaseWindowedBolt.Count.html" title="class in org.apache.heron.api.bolt">BaseWindowedBolt.Count</a> slidingIntervalCount, |
| java.lang.Long slidingIntervalDuration)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="LATE_TUPLE_FIELD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>LATE_TUPLE_FIELD</h4> |
| <pre>public static final java.lang.String LATE_TUPLE_FIELD</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.heron.api.bolt.WindowedBoltExecutor.LATE_TUPLE_FIELD">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="waterMarkEventGenerator"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>waterMarkEventGenerator</h4> |
| <pre>protected transient <a href="../windowing/WaterMarkEventGenerator.html" title="class in org.apache.heron.api.windowing">WaterMarkEventGenerator</a><<a href="../tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a>> waterMarkEventGenerator</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.heron.api.bolt.IWindowedBolt)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WindowedBoltExecutor</h4> |
| <pre>public WindowedBoltExecutor​(<a href="IWindowedBolt.html" title="interface in org.apache.heron.api.bolt">IWindowedBolt</a> bolt)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getTopologyTimeoutMillis(java.util.Map)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTopologyTimeoutMillis</h4> |
| <pre class="methodSignature">protected int getTopologyTimeoutMillis​(java.util.Map<java.lang.String,​java.lang.Object> topoConf)</pre> |
| </li> |
| </ul> |
| <a id="validate(java.util.Map,org.apache.heron.api.bolt.BaseWindowedBolt.Count,java.lang.Long,org.apache.heron.api.bolt.BaseWindowedBolt.Count,java.lang.Long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validate</h4> |
| <pre class="methodSignature">protected void validate​(java.util.Map<java.lang.String,​java.lang.Object> topoConf, |
| <a href="BaseWindowedBolt.Count.html" title="class in org.apache.heron.api.bolt">BaseWindowedBolt.Count</a> windowLengthCount, |
| java.lang.Long windowLengthDuration, |
| <a href="BaseWindowedBolt.Count.html" title="class in org.apache.heron.api.bolt">BaseWindowedBolt.Count</a> slidingIntervalCount, |
| java.lang.Long slidingIntervalDuration)</pre> |
| </li> |
| </ul> |
| <a id="getState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getState</h4> |
| <pre class="methodSignature">protected java.util.Map<java.lang.String,​java.io.Serializable> getState()</pre> |
| </li> |
| </ul> |
| <a id="start()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>start</h4> |
| <pre class="methodSignature">protected void start()</pre> |
| <div class="block">Start the trigger policy and waterMarkEventGenerator if set</div> |
| </li> |
| </ul> |
| <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">public 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="IBolt.html#prepare(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.bolt.OutputCollector)">IBolt</a></code></span></div> |
| <div class="block">Called when a task for this component is initialized within a worker on the cluster. |
| It provides the bolt with the environment in which the bolt executes. |
| <p> |
| <p>This includes the:</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="IBolt.html#prepare(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.bolt.OutputCollector)">prepare</a></code> in interface <code><a href="IBolt.html" title="interface in org.apache.heron.api.bolt">IBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>topoConf</code> - The Heron configuration for this bolt. This is the configuration provided to the topology merged in with cluster configuration on this machine.</dd> |
| <dd><code>context</code> - This object can be used to get information about this task's place within the topology, including the task id and component id of this task, input and output information, etc.</dd> |
| <dd><code>collector</code> - The collector is used to emit tuples from this bolt. Tuples can be emitted at any time, including the prepare and cleanup methods. The collector is thread-safe and should be saved as an instance variable of this bolt object.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="doPrepare(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.bolt.OutputCollector,java.util.Collection)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doPrepare</h4> |
| <pre class="methodSignature">protected void doPrepare​(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, |
| java.util.Collection<<a href="../windowing/Event.html" title="interface in org.apache.heron.api.windowing">Event</a><<a href="../tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a>>> queue)</pre> |
| </li> |
| </ul> |
| <a id="execute(org.apache.heron.api.tuple.Tuple)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre class="methodSignature">public void execute​(<a href="../tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a> input)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="IBolt.html#execute(org.apache.heron.api.tuple.Tuple)">IBolt</a></code></span></div> |
| <div class="block">Process a single tuple of input. The Tuple object contains metadata on it |
| about which component/stream/task it came from. The values of the Tuple can |
| be accessed using Tuple#getValue. The IBolt does not have to process the Tuple |
| immediately. It is perfectly fine to hang onto a tuple and process it later |
| (for instance, to do an aggregation or join). |
| <p> |
| <p>Tuples should be emitted using the OutputCollector provided through the prepare method. |
| It is required that all input tuples are acked or failed at some point using the OutputCollector. |
| Otherwise, Heron will be unable to determine when tuples coming off the spouts |
| have been completed.</p> |
| <p> |
| <p>For the common case of acking an input tuple at the end of the execute method, |
| see IBasicBolt which automates this.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="IBolt.html#execute(org.apache.heron.api.tuple.Tuple)">execute</a></code> in interface <code><a href="IBolt.html" title="interface in org.apache.heron.api.bolt">IBolt</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>input</code> - The input tuple to be processed.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="cleanup()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cleanup</h4> |
| <pre class="methodSignature">public void cleanup()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="IBolt.html#cleanup()">IBolt</a></code></span></div> |
| <div class="block">Called when an IBolt is going to be shutdown. There is no guarentee that cleanup |
| will be called, because the supervisor kill -9's worker processes on the cluster. |
| <p> |
| <p>The one context where cleanup is guaranteed to be called is when a topology |
| is killed when running Heron in simulator.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="IBolt.html#cleanup()">cleanup</a></code> in interface <code><a href="IBolt.html" title="interface in org.apache.heron.api.bolt">IBolt</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>declareOutputFields</h4> |
| <pre class="methodSignature">public void declareOutputFields​(<a href="../topology/OutputFieldsDeclarer.html" title="interface in org.apache.heron.api.topology">OutputFieldsDeclarer</a> declarer)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../topology/IComponent.html#declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">IComponent</a></code></span></div> |
| <div class="block">Declare the output schema for all the streams of this topology.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../topology/IComponent.html#declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">declareOutputFields</a></code> in interface <code><a href="../topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>declarer</code> - this is used to declare output stream ids, output fields, and whether or not each output stream is a direct stream</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getComponentConfiguration()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getComponentConfiguration</h4> |
| <pre class="methodSignature">public java.util.Map<java.lang.String,​java.lang.Object> getComponentConfiguration()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../topology/IComponent.html#getComponentConfiguration()">IComponent</a></code></span></div> |
| <div class="block">Declare configuration specific to this component. Only a subset of the "topology.*" configs can |
| be overridden. The component configuration can be further overridden when constructing the |
| topology using <a href="../topology/TopologyBuilder.html" title="class in org.apache.heron.api.topology"><code>TopologyBuilder</code></a></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../topology/IComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code> in interface <code><a href="../topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newWindowLifecycleListener()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newWindowLifecycleListener</h4> |
| <pre class="methodSignature">protected <a href="../windowing/WindowLifecycleListener.html" title="interface in org.apache.heron.api.windowing">WindowLifecycleListener</a><<a href="../tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a>> newWindowLifecycleListener()</pre> |
| </li> |
| </ul> |
| <a id="boltExecute(java.util.List,java.util.List,java.util.List,java.lang.Long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>boltExecute</h4> |
| <pre class="methodSignature">protected void boltExecute​(java.util.List<<a href="../tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a>> tuples, |
| java.util.List<<a href="../tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a>> newTuples, |
| java.util.List<<a href="../tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a>> expiredTuples, |
| java.lang.Long timestamp)</pre> |
| </li> |
| </ul> |
| <a id="initState(org.apache.heron.api.state.State)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initState</h4> |
| <pre class="methodSignature">public void initState​(<a href="../state/State.html" title="interface in org.apache.heron.api.state">State</a><java.io.Serializable,​java.io.Serializable> state)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../topology/IStatefulComponent.html#initState(org.apache.heron.api.state.State)">IStatefulComponent</a></code></span></div> |
| <div class="block">Initializes the state of the function or operator to that of a previous checkpoint. |
| This method is invoked when a component is executed as part of a recovery run. In case |
| there was prior state associated with the component, the state will be empty. |
| Stateful Spouts/Bolts are expected to hold on to the state variable to save their |
| internal state |
| <p> |
| Note that initialState() is called before open() or prepare().</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../topology/IStatefulComponent.html#initState(org.apache.heron.api.state.State)">initState</a></code> in interface <code><a href="../topology/IStatefulComponent.html" title="interface in org.apache.heron.api.topology">IStatefulComponent</a><java.io.Serializable,​java.io.Serializable></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>state</code> - the previously saved state of the component.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="preSave(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>preSave</h4> |
| <pre class="methodSignature">public void preSave​(java.lang.String checkpointId)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../topology/IStatefulComponent.html#preSave(java.lang.String)">IStatefulComponent</a></code></span></div> |
| <div class="block">This is a hook for the component to perform some actions just before the |
| framework saves its state.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../topology/IStatefulComponent.html#preSave(java.lang.String)">preSave</a></code> in interface <code><a href="../topology/IStatefulComponent.html" title="interface in org.apache.heron.api.topology">IStatefulComponent</a><java.io.Serializable,​java.io.Serializable></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>checkpointId</code> - the ID of the checkpoint</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><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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
