| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>GeneralReduceByKeyOperator (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="GeneralReduceByKeyOperator (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":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>Field | </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.streamlet.impl.operators</a></div> |
| <h2 title="Class GeneralReduceByKeyOperator" class="title">Class GeneralReduceByKeyOperator<R,​K,​T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../api/topology/BaseComponent.html" title="class in org.apache.heron.api.topology">org.apache.heron.api.topology.BaseComponent</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../api/bolt/BaseRichBolt.html" title="class in org.apache.heron.api.bolt">org.apache.heron.api.bolt.BaseRichBolt</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="StreamletOperator.html" title="class in org.apache.heron.streamlet.impl.operators">org.apache.heron.streamlet.impl.operators.StreamletOperator</a><R,​<a href="../../KeyValue.html" title="class in org.apache.heron.streamlet">KeyValue</a><K,​T>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.heron.streamlet.impl.operators.GeneralReduceByKeyOperator<R,​K,​T></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </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="../../../api/bolt/IBolt.html" title="interface in org.apache.heron.api.bolt">IBolt</a></code>, <code><a href="../../../api/bolt/IRichBolt.html" title="interface in org.apache.heron.api.bolt">IRichBolt</a></code>, <code><a href="../../../api/topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></code>, <code><a href="../../IStreamletOperator.html" title="interface in org.apache.heron.streamlet">IStreamletOperator</a><R,​<a href="../../KeyValue.html" title="class in org.apache.heron.streamlet">KeyValue</a><K,​T>></code>, <code><a href="../../IStreamletRichOperator.html" title="interface in org.apache.heron.streamlet">IStreamletRichOperator</a><R,​<a href="../../KeyValue.html" title="class in org.apache.heron.streamlet">KeyValue</a><K,​T>></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">GeneralReduceByKeyOperator<R,​K,​T></span> |
| extends <a href="StreamletOperator.html" title="class in org.apache.heron.streamlet.impl.operators">StreamletOperator</a><R,​<a href="../../KeyValue.html" title="class in org.apache.heron.streamlet">KeyValue</a><K,​T>></pre> |
| <div class="block">ReduceByKeyOperator is the class that implements the reduce functionality. |
| It takes in the key and value extractors, an initial value, and a reduceFunction |
| function as the input. The result are key value pairs of <K, T>. |
| R: Input data type, K, Key type, T, Value type. |
| TODO: make it stateful or create a new stateful operator. The tricky part is how |
| to convert K and T to State<> which needs to be serializable.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../../serialized-form.html#org.apache.heron.streamlet.impl.operators.GeneralReduceByKeyOperator">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> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.heron.streamlet.impl.operators.StreamletOperator"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.heron.streamlet.impl.operators.<a href="StreamletOperator.html" title="class in org.apache.heron.streamlet.impl.operators">StreamletOperator</a></h3> |
| <code><a href="StreamletOperator.html#collector">collector</a>, <a href="StreamletOperator.html#OUTPUT_FIELD_NAME">OUTPUT_FIELD_NAME</a></code></li> |
| </ul> |
| </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.streamlet.SerializableFunction,T,org.apache.heron.streamlet.SerializableBiFunction)">GeneralReduceByKeyOperator</a></span>​(<a href="../../SerializableFunction.html" title="interface in org.apache.heron.streamlet">SerializableFunction</a><<a href="GeneralReduceByKeyOperator.html" title="type parameter in GeneralReduceByKeyOperator">R</a>,​<a href="GeneralReduceByKeyOperator.html" title="type parameter in GeneralReduceByKeyOperator">K</a>> keyExtractor, |
| <a href="GeneralReduceByKeyOperator.html" title="type parameter in GeneralReduceByKeyOperator">T</a> identity, |
| <a href="../../SerializableBiFunction.html" title="interface in org.apache.heron.streamlet">SerializableBiFunction</a><<a href="GeneralReduceByKeyOperator.html" title="type parameter in GeneralReduceByKeyOperator">T</a>,​<a href="GeneralReduceByKeyOperator.html" title="type parameter in GeneralReduceByKeyOperator">R</a>,​? extends <a href="GeneralReduceByKeyOperator.html" title="type parameter in GeneralReduceByKeyOperator">T</a>> reduceFn)</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>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="../../../api/tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a> tuple)</code></th> |
| <td class="colLast"> |
| <div class="block">Process a single tuple of input.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.streamlet.impl.operators.StreamletOperator"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.heron.streamlet.impl.operators.<a href="StreamletOperator.html" title="class in org.apache.heron.streamlet.impl.operators">StreamletOperator</a></h3> |
| <code><a href="StreamletOperator.html#declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">declareOutputFields</a>, <a href="StreamletOperator.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.bolt.BaseRichBolt"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.heron.api.bolt.<a href="../../../api/bolt/BaseRichBolt.html" title="class in org.apache.heron.api.bolt">BaseRichBolt</a></h3> |
| <code><a href="../../../api/bolt/BaseRichBolt.html#cleanup()">cleanup</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.api.topology.BaseComponent"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.heron.api.topology.<a href="../../../api/topology/BaseComponent.html" title="class in org.apache.heron.api.topology">BaseComponent</a></h3> |
| <code><a href="../../../api/topology/BaseComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code></li> |
| </ul> |
| <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> |
| <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="../../../api/bolt/IBolt.html" title="interface in org.apache.heron.api.bolt">IBolt</a></h3> |
| <code><a href="../../../api/bolt/IBolt.html#cleanup()">cleanup</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="../../../api/topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></h3> |
| <code><a href="../../../api/topology/IComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.heron.streamlet.SerializableFunction,java.lang.Object,org.apache.heron.streamlet.SerializableBiFunction)"> |
| <!-- --> |
| </a><a id="<init>(org.apache.heron.streamlet.SerializableFunction,T,org.apache.heron.streamlet.SerializableBiFunction)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>GeneralReduceByKeyOperator</h4> |
| <pre>public GeneralReduceByKeyOperator​(<a href="../../SerializableFunction.html" title="interface in org.apache.heron.streamlet">SerializableFunction</a><<a href="GeneralReduceByKeyOperator.html" title="type parameter in GeneralReduceByKeyOperator">R</a>,​<a href="GeneralReduceByKeyOperator.html" title="type parameter in GeneralReduceByKeyOperator">K</a>> keyExtractor, |
| <a href="GeneralReduceByKeyOperator.html" title="type parameter in GeneralReduceByKeyOperator">T</a> identity, |
| <a href="../../SerializableBiFunction.html" title="interface in org.apache.heron.streamlet">SerializableBiFunction</a><<a href="GeneralReduceByKeyOperator.html" title="type parameter in GeneralReduceByKeyOperator">T</a>,​<a href="GeneralReduceByKeyOperator.html" title="type parameter in GeneralReduceByKeyOperator">R</a>,​? extends <a href="GeneralReduceByKeyOperator.html" title="type parameter in GeneralReduceByKeyOperator">T</a>> reduceFn)</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="execute(org.apache.heron.api.tuple.Tuple)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre class="methodSignature">public void execute​(<a href="../../../api/tuple/Tuple.html" title="interface in org.apache.heron.api.tuple">Tuple</a> tuple)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../api/bolt/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="paramLabel">Parameters:</span></dt> |
| <dd><code>tuple</code> - The input tuple to be processed.</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>Field | </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> |
