| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>MergeAggregateProcessor (Storm 2.6.2 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.storm.streams.processors, class: MergeAggregateProcessor"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/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="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/MergeAggregateProcessor.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <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="sub-nav-list"> |
| <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> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.storm.streams.processors</a></div> |
| <h1 title="Class MergeAggregateProcessor" class="title">Class MergeAggregateProcessor<T,<wbr>A,<wbr>R></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.storm.streams.processors.MergeAggregateProcessor<T,<wbr>A,<wbr>R></div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="BatchProcessor.html" title="interface in org.apache.storm.streams.processors">BatchProcessor</a></code>, <code><a href="Processor.html" title="interface in org.apache.storm.streams.processors">Processor</a><A></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">MergeAggregateProcessor<T,<wbr>A,<wbr>R></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="BatchProcessor.html" title="interface in org.apache.storm.streams.processors">BatchProcessor</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../serialized-form.html#org.apache.storm.streams.processors.MergeAggregateProcessor">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected <a href="ProcessorContext.html" title="interface in org.apache.storm.streams.processors">ProcessorContext</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#context" class="member-name-link">context</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.storm.streams.operations.CombinerAggregator)" class="member-name-link">MergeAggregateProcessor</a><wbr>(<a href="../operations/CombinerAggregator.html" title="interface in org.apache.storm.streams.operations">CombinerAggregator</a><<a href="MergeAggregateProcessor.html" title="type parameter in MergeAggregateProcessor">T</a>,<wbr><a href="MergeAggregateProcessor.html" title="type parameter in MergeAggregateProcessor">A</a>,<wbr><a href="MergeAggregateProcessor.html" title="type parameter in MergeAggregateProcessor">R</a>> aggregator)</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute(A)" class="member-name-link">execute</a><wbr>(<a href="MergeAggregateProcessor.html" title="type parameter in MergeAggregateProcessor">A</a> input)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Execute some operation on the input value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute(T,java.lang.String)" class="member-name-link">execute</a><wbr>(<a href="MergeAggregateProcessor.html" title="type parameter in MergeAggregateProcessor">A</a> input, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Executes some operations on the input and possibly emits some results.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#finish()" class="member-name-link">finish</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This is triggered to signal the end of the current batch of values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#init(org.apache.storm.streams.processors.ProcessorContext)" class="member-name-link">init</a><wbr>(<a href="ProcessorContext.html" title="interface in org.apache.storm.streams.processors">ProcessorContext</a> context)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Initializes the processor.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected final <R> void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#mayBeForwardAggUpdate(java.util.function.Supplier)" class="member-name-link">mayBeForwardAggUpdate</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><R> result)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Forwards the result update to downstream processors.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#punctuate(java.lang.String)" class="member-name-link">punctuate</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> stream)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="context"> |
| <h3>context</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="ProcessorContext.html" title="interface in org.apache.storm.streams.processors">ProcessorContext</a></span> <span class="element-name">context</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.storm.streams.operations.CombinerAggregator)"> |
| <h3>MergeAggregateProcessor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">MergeAggregateProcessor</span><wbr><span class="parameters">(<a href="../operations/CombinerAggregator.html" title="interface in org.apache.storm.streams.operations">CombinerAggregator</a><<a href="MergeAggregateProcessor.html" title="type parameter in MergeAggregateProcessor">T</a>,<wbr><a href="MergeAggregateProcessor.html" title="type parameter in MergeAggregateProcessor">A</a>,<wbr><a href="MergeAggregateProcessor.html" title="type parameter in MergeAggregateProcessor">R</a>> aggregator)</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="execute(A)"> |
| <h3 id="execute(java.lang.Object)">execute</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">execute</span><wbr><span class="parameters">(<a href="MergeAggregateProcessor.html" title="type parameter in MergeAggregateProcessor">A</a> input)</span></div> |
| <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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>input</code> - the input</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="finish()"> |
| <h3>finish</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">finish</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="init(org.apache.storm.streams.processors.ProcessorContext)"> |
| <h3>init</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">init</span><wbr><span class="parameters">(<a href="ProcessorContext.html" title="interface in org.apache.storm.streams.processors">ProcessorContext</a> context)</span></div> |
| <div class="block">Initializes the processor. This is typically invoked from the underlying storm bolt's prepare method.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Processor.html#init(org.apache.storm.streams.processors.ProcessorContext)">init</a></code> in interface <code><a href="Processor.html" title="interface in org.apache.storm.streams.processors">Processor</a><T></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - the processor context</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="execute(T,java.lang.String)"> |
| <h3 id="execute(java.lang.Object,java.lang.String)">execute</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">execute</span><wbr><span class="parameters">(<a href="MergeAggregateProcessor.html" title="type parameter in MergeAggregateProcessor">A</a> input, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> streamId)</span></div> |
| <div class="block">Executes some operations on the input and possibly emits some results. Processors that do not care about the source stream should override <code>BaseProcessor.execute(Object)</code> instead.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Processor.html#execute(T,java.lang.String)">execute</a></code> in interface <code><a href="Processor.html" title="interface in org.apache.storm.streams.processors">Processor</a><T></code></dd> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="punctuate(java.lang.String)"> |
| <h3>punctuate</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">punctuate</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> stream)</span></div> |
| <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. For e.g. |
| emit the results of an aggregation.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Processor.html#punctuate(java.lang.String)">punctuate</a></code> in interface <code><a href="Processor.html" title="interface in org.apache.storm.streams.processors">Processor</a><T></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>stream</code> - the stream id on which the punctuation arrived</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="mayBeForwardAggUpdate(java.util.function.Supplier)"> |
| <h3>mayBeForwardAggUpdate</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="type-parameters"><R></span> <span class="return-type">void</span> <span class="element-name">mayBeForwardAggUpdate</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><R> result)</span></div> |
| <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 class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>R</code> - the result type</dd> |
| <dt>Parameters:</dt> |
| <dd><code>result</code> - the result function</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |