| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>Tuple (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="Tuple (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6,"i24":6,"i25":6,"i26":6,"i27":6,"i28":6,"i29":6,"i30":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.api.tuple</a></div> |
| <h2 title="Interface Tuple" class="title">Interface Tuple</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code>java.io.Serializable</code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../../common/utils/tuple/TickTuple.html" title="class in org.apache.heron.common.utils.tuple">TickTuple</a></code>, <code><a href="../../common/utils/tuple/TupleImpl.html" title="class in org.apache.heron.common.utils.tuple">TupleImpl</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">Tuple</span> |
| extends java.io.Serializable</pre> |
| <div class="block">The tuple is the main data structure in Heron. A tuple is a named list of values, |
| where each value can be any type. Tuples are dynamically typed -- the types of the fields |
| do not need to be declared. Tuples have helper methods like getInteger and getString |
| to get field values without having to cast the result. |
| <p> |
| Heron needs to know how to serialize all the values in a tuple. By default, Heron |
| knows how to serialize the primitive types, strings, and byte arrays. If you want to |
| use another type, you'll need to implement and register a serializer for that type.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://storm.apache.org/documentation/Serialization.html">Storm serialization</a></dd> |
| </dl> |
| </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>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contains(java.lang.String)">contains</a></span>​(java.lang.String field)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if this tuple contains the specified name of the field.</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="#fieldIndex(java.lang.String)">fieldIndex</a></span>​(java.lang.String field)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the position of the specified field in this tuple.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBinary(int)">getBinary</a></span>​(int i)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the byte array at position i in the tuple.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBinaryByField(java.lang.String)">getBinaryByField</a></span>​(java.lang.String field)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.Boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBoolean(int)">getBoolean</a></span>​(int i)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the Boolean at position i in the tuple.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBooleanByField(java.lang.String)">getBooleanByField</a></span>​(java.lang.String field)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.Byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getByte(int)">getByte</a></span>​(int i)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the Byte at position i in the tuple.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Byte</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getByteByField(java.lang.String)">getByteByField</a></span>​(java.lang.String field)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.lang.Double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDouble(int)">getDouble</a></span>​(int i)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the Double at position i in the tuple.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDoubleByField(java.lang.String)">getDoubleByField</a></span>​(java.lang.String field)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="Fields.html" title="class in org.apache.heron.api.tuple">Fields</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFields()">getFields</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the names of the fields in this tuple.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Float</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFloat(int)">getFloat</a></span>​(int i)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the Float at position i in the tuple.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>java.lang.Float</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFloatByField(java.lang.String)">getFloatByField</a></span>​(java.lang.String field)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Integer</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInteger(int)">getInteger</a></span>​(int i)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the Integer at position i in the tuple.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>java.lang.Integer</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIntegerByField(java.lang.String)">getIntegerByField</a></span>​(java.lang.String field)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLong(int)">getLong</a></span>​(int i)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the Long at position i in the tuple.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>java.lang.Long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLongByField(java.lang.String)">getLongByField</a></span>​(java.lang.String field)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Short</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getShort(int)">getShort</a></span>​(int i)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the Short at position i in the tuple.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>java.lang.Short</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getShortByField(java.lang.String)">getShortByField</a></span>​(java.lang.String field)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSourceComponent()">getSourceComponent</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the id of the component that created this tuple.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code><a href="../generated/TopologyAPI.StreamId.html" title="class in org.apache.heron.api.generated">TopologyAPI.StreamId</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSourceGlobalStreamId()">getSourceGlobalStreamId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the global stream id (component + stream) of this tuple.</div> |
| </td> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSourceStreamId()">getSourceStreamId</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the id of the stream that this tuple was emitted to.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSourceTask()">getSourceTask</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the id of the task that created this tuple.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getString(int)">getString</a></span>​(int i)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the String at position i in the tuple.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStringByField(java.lang.String)">getStringByField</a></span>​(java.lang.String field)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValue(int)">getValue</a></span>​(int i)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the field at position i in the tuple.</div> |
| </td> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValueByField(java.lang.String)">getValueByField</a></span>​(java.lang.String field)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.Object></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getValues()">getValues</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets all the values in this tuple.</div> |
| </td> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetValues()">resetValues</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Resets the tuple values to null |
| TODO:- Is this needed</div> |
| </td> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.lang.Object></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#select(org.apache.heron.api.tuple.Fields)">select</a></span>​(<a href="Fields.html" title="class in org.apache.heron.api.tuple">Fields</a> selector)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a subset of the tuple based on the fields selector.</div> |
| </td> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#size()">size</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the number of fields in this tuple.</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="size()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>size</h4> |
| <pre class="methodSignature">int size()</pre> |
| <div class="block">Returns the number of fields in this tuple.</div> |
| </li> |
| </ul> |
| <a id="fieldIndex(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fieldIndex</h4> |
| <pre class="methodSignature">int fieldIndex​(java.lang.String field)</pre> |
| <div class="block">Returns the position of the specified field in this tuple.</div> |
| </li> |
| </ul> |
| <a id="contains(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>contains</h4> |
| <pre class="methodSignature">boolean contains​(java.lang.String field)</pre> |
| <div class="block">Returns true if this tuple contains the specified name of the field.</div> |
| </li> |
| </ul> |
| <a id="getValue(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValue</h4> |
| <pre class="methodSignature">java.lang.Object getValue​(int i)</pre> |
| <div class="block">Gets the field at position i in the tuple. Returns object since tuples are dynamically typed.</div> |
| </li> |
| </ul> |
| <a id="getString(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getString</h4> |
| <pre class="methodSignature">java.lang.String getString​(int i)</pre> |
| <div class="block">Returns the String at position i in the tuple. If that field is not a String, |
| you will get a runtime error.</div> |
| </li> |
| </ul> |
| <a id="getInteger(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInteger</h4> |
| <pre class="methodSignature">java.lang.Integer getInteger​(int i)</pre> |
| <div class="block">Returns the Integer at position i in the tuple. If that field is not an Integer, |
| you will get a runtime error.</div> |
| </li> |
| </ul> |
| <a id="getLong(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLong</h4> |
| <pre class="methodSignature">java.lang.Long getLong​(int i)</pre> |
| <div class="block">Returns the Long at position i in the tuple. If that field is not a Long, |
| you will get a runtime error.</div> |
| </li> |
| </ul> |
| <a id="getBoolean(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBoolean</h4> |
| <pre class="methodSignature">java.lang.Boolean getBoolean​(int i)</pre> |
| <div class="block">Returns the Boolean at position i in the tuple. If that field is not a Boolean, |
| you will get a runtime error.</div> |
| </li> |
| </ul> |
| <a id="getShort(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getShort</h4> |
| <pre class="methodSignature">java.lang.Short getShort​(int i)</pre> |
| <div class="block">Returns the Short at position i in the tuple. If that field is not a Short, |
| you will get a runtime error.</div> |
| </li> |
| </ul> |
| <a id="getByte(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getByte</h4> |
| <pre class="methodSignature">java.lang.Byte getByte​(int i)</pre> |
| <div class="block">Returns the Byte at position i in the tuple. If that field is not a Byte, |
| you will get a runtime error.</div> |
| </li> |
| </ul> |
| <a id="getDouble(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDouble</h4> |
| <pre class="methodSignature">java.lang.Double getDouble​(int i)</pre> |
| <div class="block">Returns the Double at position i in the tuple. If that field is not a Double, |
| you will get a runtime error.</div> |
| </li> |
| </ul> |
| <a id="getFloat(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFloat</h4> |
| <pre class="methodSignature">java.lang.Float getFloat​(int i)</pre> |
| <div class="block">Returns the Float at position i in the tuple. If that field is not a Float, |
| you will get a runtime error.</div> |
| </li> |
| </ul> |
| <a id="getBinary(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBinary</h4> |
| <pre class="methodSignature">byte[] getBinary​(int i)</pre> |
| <div class="block">Returns the byte array at position i in the tuple. If that field is not a byte array, |
| you will get a runtime error.</div> |
| </li> |
| </ul> |
| <a id="getValueByField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValueByField</h4> |
| <pre class="methodSignature">java.lang.Object getValueByField​(java.lang.String field)</pre> |
| </li> |
| </ul> |
| <a id="getStringByField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getStringByField</h4> |
| <pre class="methodSignature">java.lang.String getStringByField​(java.lang.String field)</pre> |
| </li> |
| </ul> |
| <a id="getIntegerByField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getIntegerByField</h4> |
| <pre class="methodSignature">java.lang.Integer getIntegerByField​(java.lang.String field)</pre> |
| </li> |
| </ul> |
| <a id="getLongByField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLongByField</h4> |
| <pre class="methodSignature">java.lang.Long getLongByField​(java.lang.String field)</pre> |
| </li> |
| </ul> |
| <a id="getBooleanByField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBooleanByField</h4> |
| <pre class="methodSignature">java.lang.Boolean getBooleanByField​(java.lang.String field)</pre> |
| </li> |
| </ul> |
| <a id="getShortByField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getShortByField</h4> |
| <pre class="methodSignature">java.lang.Short getShortByField​(java.lang.String field)</pre> |
| </li> |
| </ul> |
| <a id="getByteByField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getByteByField</h4> |
| <pre class="methodSignature">java.lang.Byte getByteByField​(java.lang.String field)</pre> |
| </li> |
| </ul> |
| <a id="getDoubleByField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDoubleByField</h4> |
| <pre class="methodSignature">java.lang.Double getDoubleByField​(java.lang.String field)</pre> |
| </li> |
| </ul> |
| <a id="getFloatByField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFloatByField</h4> |
| <pre class="methodSignature">java.lang.Float getFloatByField​(java.lang.String field)</pre> |
| </li> |
| </ul> |
| <a id="getBinaryByField(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBinaryByField</h4> |
| <pre class="methodSignature">byte[] getBinaryByField​(java.lang.String field)</pre> |
| </li> |
| </ul> |
| <a id="getValues()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValues</h4> |
| <pre class="methodSignature">java.util.List<java.lang.Object> getValues()</pre> |
| <div class="block">Gets all the values in this tuple.</div> |
| </li> |
| </ul> |
| <a id="getFields()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFields</h4> |
| <pre class="methodSignature"><a href="Fields.html" title="class in org.apache.heron.api.tuple">Fields</a> getFields()</pre> |
| <div class="block">Gets the names of the fields in this tuple.</div> |
| </li> |
| </ul> |
| <a id="select(org.apache.heron.api.tuple.Fields)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>select</h4> |
| <pre class="methodSignature">java.util.List<java.lang.Object> select​(<a href="Fields.html" title="class in org.apache.heron.api.tuple">Fields</a> selector)</pre> |
| <div class="block">Returns a subset of the tuple based on the fields selector.</div> |
| </li> |
| </ul> |
| <a id="getSourceGlobalStreamId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceGlobalStreamId</h4> |
| <pre class="methodSignature"><a href="../generated/TopologyAPI.StreamId.html" title="class in org.apache.heron.api.generated">TopologyAPI.StreamId</a> getSourceGlobalStreamId()</pre> |
| <div class="block">Returns the global stream id (component + stream) of this tuple.</div> |
| </li> |
| </ul> |
| <a id="getSourceComponent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceComponent</h4> |
| <pre class="methodSignature">java.lang.String getSourceComponent()</pre> |
| <div class="block">Gets the id of the component that created this tuple.</div> |
| </li> |
| </ul> |
| <a id="getSourceTask()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceTask</h4> |
| <pre class="methodSignature">int getSourceTask()</pre> |
| <div class="block">Gets the id of the task that created this tuple.</div> |
| </li> |
| </ul> |
| <a id="getSourceStreamId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceStreamId</h4> |
| <pre class="methodSignature">java.lang.String getSourceStreamId()</pre> |
| <div class="block">Gets the id of the stream that this tuple was emitted to.</div> |
| </li> |
| </ul> |
| <a id="resetValues()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>resetValues</h4> |
| <pre class="methodSignature">void resetValues()</pre> |
| <div class="block">Resets the tuple values to null |
| TODO:- Is this needed</div> |
| </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> |
