Google Git
Sign in
apache / incubator-heron / refs/heads/asf-site / . / content / api / java / org / apache / heron / streamlet / impl / operators / StreamletOperator.html
blob: 1f7d9799ac4203914a486f508c852aa88a3879df [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 -->
<title>StreamletOperator (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="StreamletOperator (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.heron.streamlet.impl.operators</a></div>
<h2 title="Class StreamletOperator" class="title">Class StreamletOperator&lt;R,&#8203;T&gt;</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>org.apache.heron.streamlet.impl.operators.StreamletOperator&lt;R,&#8203;T&gt;</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>&lt;R,&#8203;T&gt;</code>, <code><a href="../../IStreamletRichOperator.html" title="interface in org.apache.heron.streamlet">IStreamletRichOperator</a>&lt;R,&#8203;T&gt;</code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../sinks/ComplexSink.html" title="class in org.apache.heron.streamlet.impl.sinks">ComplexSink</a></code>, <code><a href="../sinks/ConsumerSink.html" title="class in org.apache.heron.streamlet.impl.sinks">ConsumerSink</a></code>, <code><a href="FilterOperator.html" title="class in org.apache.heron.streamlet.impl.operators">FilterOperator</a></code>, <code><a href="FlatMapOperator.html" title="class in org.apache.heron.streamlet.impl.operators">FlatMapOperator</a></code>, <code><a href="GeneralReduceByKeyOperator.html" title="class in org.apache.heron.streamlet.impl.operators">GeneralReduceByKeyOperator</a></code>, <code><a href="KeyByOperator.html" title="class in org.apache.heron.streamlet.impl.operators">KeyByOperator</a></code>, <code><a href="../sinks/LogSink.html" title="class in org.apache.heron.streamlet.impl.sinks">LogSink</a></code>, <code><a href="MapOperator.html" title="class in org.apache.heron.streamlet.impl.operators">MapOperator</a></code>, <code><a href="ReduceByKeyOperator.html" title="class in org.apache.heron.streamlet.impl.operators">ReduceByKeyOperator</a></code>, <code><a href="SplitOperator.html" title="class in org.apache.heron.streamlet.impl.operators">SplitOperator</a></code>, <code><a href="TransformOperator.html" title="class in org.apache.heron.streamlet.impl.operators">TransformOperator</a></code>, <code><a href="UnionOperator.html" title="class in org.apache.heron.streamlet.impl.operators">UnionOperator</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">StreamletOperator&lt;R,&#8203;T&gt;</span>
extends <a href="../../../api/bolt/BaseRichBolt.html" title="class in org.apache.heron.api.bolt">BaseRichBolt</a>
implements <a href="../../IStreamletRichOperator.html" title="interface in org.apache.heron.streamlet">IStreamletRichOperator</a>&lt;R,&#8203;T&gt;</pre>
<div class="block">The Bolt interface that other operators of the streamlet packages extend.
The only common stuff amongst all of them is the output streams</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../serialized-form.html#org.apache.heron.streamlet.impl.operators.StreamletOperator">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">&nbsp;</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>protected <a href="../../../api/bolt/OutputCollector.html" title="class in org.apache.heron.api.bolt">OutputCollector</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collector">collector</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#OUTPUT_FIELD_NAME">OUTPUT_FIELD_NAME</a></span></code></th>
<td class="colLast">&nbsp;</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">&nbsp;</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()">StreamletOperator</a></span>()</code></th>
<td class="colLast">&nbsp;</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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="#declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">declareOutputFields</a></span>&#8203;(<a href="../../../api/topology/OutputFieldsDeclarer.html" title="interface in org.apache.heron.api.topology">OutputFieldsDeclarer</a>&nbsp;outputFieldsDeclarer)</code></th>
<td class="colLast">
<div class="block">The operators implementing streamlet functionality have some properties.</div>
</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="#prepare(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.bolt.OutputCollector)">prepare</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;map,
<a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a>&nbsp;topologyContext,
<a href="../../../api/bolt/OutputCollector.html" title="class in org.apache.heron.api.bolt">OutputCollector</a>&nbsp;outputCollector)</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>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.heron.api.bolt.BaseRichBolt">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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&nbsp;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&nbsp;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&nbsp;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>, <a href="../../../api/bolt/IBolt.html#execute(org.apache.heron.api.tuple.Tuple)">execute</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&nbsp;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">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="OUTPUT_FIELD_NAME">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OUTPUT_FIELD_NAME</h4>
<pre>protected static final&nbsp;java.lang.String OUTPUT_FIELD_NAME</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../../constant-values.html#org.apache.heron.streamlet.impl.operators.StreamletOperator.OUTPUT_FIELD_NAME">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="collector">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>collector</h4>
<pre>protected&nbsp;<a href="../../../api/bolt/OutputCollector.html" title="class in org.apache.heron.api.bolt">OutputCollector</a> collector</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="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StreamletOperator</h4>
<pre>public&nbsp;StreamletOperator()</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="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&nbsp;void&nbsp;prepare&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;map,
<a href="../../../api/topology/TopologyContext.html" title="interface in org.apache.heron.api.topology">TopologyContext</a>&nbsp;topologyContext,
<a href="../../../api/bolt/OutputCollector.html" title="class in org.apache.heron.api.bolt">OutputCollector</a>&nbsp;outputCollector)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../api/bolt/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="../../../api/bolt/IBolt.html#prepare(java.util.Map,org.apache.heron.api.topology.TopologyContext,org.apache.heron.api.bolt.OutputCollector)">prepare</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/bolt/IBolt.html" title="interface in org.apache.heron.api.bolt">IBolt</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>map</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>topologyContext</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>outputCollector</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="declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>declareOutputFields</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;declareOutputFields&#8203;(<a href="../../../api/topology/OutputFieldsDeclarer.html" title="interface in org.apache.heron.api.topology">OutputFieldsDeclarer</a>&nbsp;outputFieldsDeclarer)</pre>
<div class="block">The operators implementing streamlet functionality have some properties.
1. They all output only one stream
2. They should be able to consume each other's output
This imply that the output stream should be named same for all of them.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../api/topology/IComponent.html#declareOutputFields(org.apache.heron.api.topology.OutputFieldsDeclarer)">declareOutputFields</a></code>&nbsp;in interface&nbsp;<code><a href="../../../api/topology/IComponent.html" title="interface in org.apache.heron.api.topology">IComponent</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>outputFieldsDeclarer</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>
</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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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>