| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>IRichBolt (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="IRichBolt (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| 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>Method</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 IRichBolt" class="title">Interface IRichBolt</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="IBolt.html" title="interface in org.apache.heron.api.bolt">IBolt</a></code>, <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="../../streamlet/IStreamletRichOperator.html" title="interface in org.apache.heron.streamlet">IStreamletRichOperator</a><R,​T></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../../integration_test/core/AggregatorBolt.html" title="class in org.apache.heron.integration_test.core">AggregatorBolt</a></code>, <code><a href="../../integration_test/core/BaseBatchBolt.html" title="class in org.apache.heron.integration_test.core">BaseBatchBolt</a></code>, <code><a href="BaseRichBolt.html" title="class in org.apache.heron.api.bolt">BaseRichBolt</a></code>, <code><a href="BasicBoltExecutor.html" title="class in org.apache.heron.api.bolt">BasicBoltExecutor</a></code>, <code><a href="../../streamlet/impl/sinks/ComplexSink.html" title="class in org.apache.heron.streamlet.impl.sinks">ComplexSink</a></code>, <code><a href="../../streamlet/impl/sinks/ConsumerSink.html" title="class in org.apache.heron.streamlet.impl.sinks">ConsumerSink</a></code>, <code><a href="../../integration_test/common/bolt/CountAggregatorBolt.html" title="class in org.apache.heron.integration_test.common.bolt">CountAggregatorBolt</a></code>, <code><a href="../../streamlet/impl/operators/FilterOperator.html" title="class in org.apache.heron.streamlet.impl.operators">FilterOperator</a></code>, <code><a href="../../streamlet/impl/operators/FlatMapOperator.html" title="class in org.apache.heron.streamlet.impl.operators">FlatMapOperator</a></code>, <code><a href="../../streamlet/impl/operators/GeneralReduceByKeyOperator.html" title="class in org.apache.heron.streamlet.impl.operators">GeneralReduceByKeyOperator</a></code>, <code><a href="../../spouts/kafka/sample/HeronKafkaSpoutSampleTopology.LoggingBolt.html" title="class in org.apache.heron.spouts.kafka.sample">HeronKafkaSpoutSampleTopology.LoggingBolt</a></code>, <code><a href="../../integration_test/common/bolt/IncrementBolt.html" title="class in org.apache.heron.integration_test.common.bolt">IncrementBolt</a></code>, <code><a href="../../integration_test/core/IntegrationTestBolt.html" title="class in org.apache.heron.integration_test.core">IntegrationTestBolt</a></code>, <code><a href="../../../../../backtype/storm/topology/IRichBoltDelegate.html" title="class in backtype.storm.topology">IRichBoltDelegate</a></code>, <code><a href="../../../storm/topology/IRichBoltDelegate.html" title="class in org.apache.storm.topology">IRichBoltDelegate</a></code>, <code><a href="../../bolts/kafka/KafkaBolt.html" title="class in org.apache.heron.bolts.kafka">KafkaBolt</a></code>, <code><a href="../../streamlet/impl/operators/KeyByOperator.html" title="class in org.apache.heron.streamlet.impl.operators">KeyByOperator</a></code>, <code><a href="../../integration_test/core/LocalAggregatorBolt.html" title="class in org.apache.heron.integration_test.core">LocalAggregatorBolt</a></code>, <code><a href="../../streamlet/impl/sinks/LogSink.html" title="class in org.apache.heron.streamlet.impl.sinks">LogSink</a></code>, <code><a href="../../integration_test/common/bolt/MapAggregatorBolt.html" title="class in org.apache.heron.integration_test.common.bolt">MapAggregatorBolt</a></code>, <code><a href="../../streamlet/impl/operators/MapOperator.html" title="class in org.apache.heron.streamlet.impl.operators">MapOperator</a></code>, <code><a href="../../integration_test/common/bolt/PartialUniquerBolt.html" title="class in org.apache.heron.integration_test.common.bolt">PartialUniquerBolt</a></code>, <code><a href="../../streamlet/impl/operators/ReduceByKeyOperator.html" title="class in org.apache.heron.streamlet.impl.operators">ReduceByKeyOperator</a></code>, <code><a href="../../streamlet/impl/operators/SplitOperator.html" title="class in org.apache.heron.streamlet.impl.operators">SplitOperator</a></code>, <code><a href="../../integration_topology_test/core/StatefulBolt.html" title="class in org.apache.heron.integration_topology_test.core">StatefulBolt</a></code>, <code><a href="../../examples/eco/StatefulConsumerBolt.html" title="class in org.apache.heron.examples.eco">StatefulConsumerBolt</a></code>, <code><a href="../../integration_topology_test/common/bolt/StatefulIdentityBolt.html" title="class in org.apache.heron.integration_topology_test.common.bolt">StatefulIdentityBolt</a></code>, <code><a href="../../integration_test/core/StatefulIntegrationTestBolt.html" title="class in org.apache.heron.integration_test.core">StatefulIntegrationTestBolt</a></code>, <code><a href="../../integration_topology_test/core/StatefulIntegrationTopologyTestBolt.html" title="class in org.apache.heron.integration_topology_test.core">StatefulIntegrationTopologyTestBolt</a></code>, <code><a href="StatefulWindowedBoltExecutor.html" title="class in org.apache.heron.api.bolt">StatefulWindowedBoltExecutor</a></code>, <code><a href="../../streamlet/impl/operators/StreamletOperator.html" title="class in org.apache.heron.streamlet.impl.operators">StreamletOperator</a></code>, <code><a href="../../resource/TestBolt.html" title="class in org.apache.heron.resource">TestBolt</a></code>, <code><a href="../../resource/TestStatefulBolt.html" title="class in org.apache.heron.resource">TestStatefulBolt</a></code>, <code><a href="../../resource/TestTwoPhaseStatefulBolt.html" title="class in org.apache.heron.resource">TestTwoPhaseStatefulBolt</a></code>, <code><a href="../../streamlet/impl/operators/TransformOperator.html" title="class in org.apache.heron.streamlet.impl.operators">TransformOperator</a></code>, <code><a href="../../streamlet/impl/operators/UnionOperator.html" title="class in org.apache.heron.streamlet.impl.operators">UnionOperator</a></code>, <code><a href="WindowedBoltExecutor.html" title="class in org.apache.heron.api.bolt">WindowedBoltExecutor</a></code>, <code><a href="../../integration_test/common/bolt/WordCountBolt.html" title="class in org.apache.heron.integration_test.common.bolt">WordCountBolt</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">IRichBolt</span> |
| extends <a href="IBolt.html" title="interface in org.apache.heron.api.bolt">IBolt</a>, <a href="../topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></pre> |
| <div class="block">When writing topologies using Java, <a href="IRichBolt.html" title="interface in org.apache.heron.api.bolt"><code>IRichBolt</code></a> and |
| <a href="../spout/IRichSpout.html" title="interface in org.apache.heron.api.spout"><code>IRichSpout</code></a> are the main interfaces |
| to use to implement components of the topology.</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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.api.bolt.IBolt"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.heron.api.bolt.<a href="IBolt.html" title="interface in org.apache.heron.api.bolt">IBolt</a></h3> |
| <code><a href="IBolt.html#cleanup()">cleanup</a>, <a href="IBolt.html#execute(org.apache.heron.api.tuple.Tuple)">execute</a>, <a href="IBolt.html#prepare(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.bolt.OutputCollector)">prepare</a></code></li> |
| </ul> |
| <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> |
| </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>Method</li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
