| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>StreamletBase (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="StreamletBase (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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>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><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</a></div> |
| <h2 title="Interface StreamletBase" class="title">Interface StreamletBase<R></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><code><a href="KVStreamlet.html" title="interface in org.apache.heron.streamlet">KVStreamlet</a><K,​V></code>, <code><a href="Streamlet.html" title="interface in org.apache.heron.streamlet">Streamlet</a><R></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="impl/streamlets/ConsumerStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">ConsumerStreamlet</a></code>, <code><a href="impl/streamlets/CountByKeyAndWindowStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">CountByKeyAndWindowStreamlet</a></code>, <code><a href="impl/streamlets/CountByKeyStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">CountByKeyStreamlet</a></code>, <code><a href="impl/streamlets/CustomStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">CustomStreamlet</a></code>, <code><a href="impl/streamlets/FilterStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">FilterStreamlet</a></code>, <code><a href="impl/streamlets/FlatMapStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">FlatMapStreamlet</a></code>, <code><a href="impl/streamlets/GeneralReduceByKeyAndWindowStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">GeneralReduceByKeyAndWindowStreamlet</a></code>, <code><a href="impl/streamlets/GeneralReduceByKeyStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">GeneralReduceByKeyStreamlet</a></code>, <code><a href="impl/streamlets/JoinStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">JoinStreamlet</a></code>, <code><a href="impl/streamlets/KeyByStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">KeyByStreamlet</a></code>, <code><a href="impl/streamlets/KVStreamletShadow.html" title="class in org.apache.heron.streamlet.impl.streamlets">KVStreamletShadow</a></code>, <code><a href="impl/streamlets/LogStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">LogStreamlet</a></code>, <code><a href="impl/streamlets/MapStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">MapStreamlet</a></code>, <code><a href="impl/streamlets/ReduceByKeyAndWindowStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">ReduceByKeyAndWindowStreamlet</a></code>, <code><a href="impl/streamlets/ReduceByKeyStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">ReduceByKeyStreamlet</a></code>, <code><a href="impl/streamlets/RemapStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">RemapStreamlet</a></code>, <code><a href="impl/streamlets/SinkStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">SinkStreamlet</a></code>, <code><a href="impl/streamlets/SourceStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">SourceStreamlet</a></code>, <code><a href="impl/streamlets/SplitStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">SplitStreamlet</a></code>, <code><a href="impl/streamlets/SpoutStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">SpoutStreamlet</a></code>, <code><a href="impl/StreamletBaseImpl.html" title="class in org.apache.heron.streamlet.impl">StreamletBaseImpl</a></code>, <code><a href="impl/StreamletImpl.html" title="class in org.apache.heron.streamlet.impl">StreamletImpl</a></code>, <code><a href="impl/streamlets/StreamletShadow.html" title="class in org.apache.heron.streamlet.impl.streamlets">StreamletShadow</a></code>, <code><a href="impl/streamlets/SupplierStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">SupplierStreamlet</a></code>, <code><a href="impl/streamlets/TransformStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">TransformStreamlet</a></code>, <code><a href="impl/streamlets/UnionStreamlet.html" title="class in org.apache.heron.streamlet.impl.streamlets">UnionStreamlet</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">StreamletBase<R></span></pre> |
| <div class="block">A Streamlet is a (potentially unbounded) ordered collection of tuples. |
| The StreamletBase class contains basic information of a Streamlet |
| such as name and partition count without the connection functions |
| such as map() and filter().</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> |
| <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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the name of the Streamlet.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNumPartitions()">getNumPartitions</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the number of partitions of this Streamlet.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="StreamletBase.html" title="interface in org.apache.heron.streamlet">StreamletBase</a><<a href="StreamletBase.html" title="type parameter in StreamletBase">R</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setName(java.lang.String)">setName</a></span>​(java.lang.String sName)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the name of the BaseStreamlet.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="StreamletBase.html" title="interface in org.apache.heron.streamlet">StreamletBase</a><<a href="StreamletBase.html" title="type parameter in StreamletBase">R</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNumPartitions(int)">setNumPartitions</a></span>​(int numPartitions)</code></th> |
| <td class="colLast"> |
| <div class="block">Sets the number of partitions of the streamlet</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="setName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setName</h4> |
| <pre class="methodSignature"><a href="StreamletBase.html" title="interface in org.apache.heron.streamlet">StreamletBase</a><<a href="StreamletBase.html" title="type parameter in StreamletBase">R</a>> setName​(java.lang.String sName)</pre> |
| <div class="block">Sets the name of the BaseStreamlet.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sName</code> - The name given by the user for this BaseStreamlet</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns back the Streamlet with changed name</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre class="methodSignature">java.lang.String getName()</pre> |
| <div class="block">Gets the name of the Streamlet.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the name of the Streamlet</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setNumPartitions(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setNumPartitions</h4> |
| <pre class="methodSignature"><a href="StreamletBase.html" title="interface in org.apache.heron.streamlet">StreamletBase</a><<a href="StreamletBase.html" title="type parameter in StreamletBase">R</a>> setNumPartitions​(int numPartitions)</pre> |
| <div class="block">Sets the number of partitions of the streamlet</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>numPartitions</code> - The user assigned number of partitions</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns back the Streamlet with changed number of partitions</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getNumPartitions()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getNumPartitions</h4> |
| <pre class="methodSignature">int getNumPartitions()</pre> |
| <div class="block">Gets the number of partitions of this Streamlet.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of partitions of this Streamlet</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>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><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |