| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Tuple (Storm 2.2.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Tuple (Storm 2.2.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Tuple.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/storm/tuple/MessageId.html" title="class in org.apache.storm.tuple"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/storm/tuple/TupleImpl.html" title="class in org.apache.storm.tuple"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/storm/tuple/Tuple.html" target="_top">Frames</a></li> |
| <li><a href="Tuple.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></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> |
| </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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.storm.tuple</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><a href="../../../../org/apache/storm/tuple/ITuple.html" title="interface in org.apache.storm.tuple">ITuple</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/storm/clojure/ClojureTuple.html" title="class in org.apache.storm.clojure">ClojureTuple</a>, <a href="../../../../org/apache/storm/tuple/TupleImpl.html" title="class in org.apache.storm.tuple">TupleImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Tuple</span> |
| extends <a href="../../../../org/apache/storm/tuple/ITuple.html" title="interface in org.apache.storm.tuple">ITuple</a></pre> |
| <div class="block"><p>The tuple is the main data structure in Storm. 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><p><p>Storm needs to know how to serialize all the values in a tuple. By default, Storm 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.</p></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="http://storm.apache.org/documentation/Serialization.html">Serialization</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/task/GeneralTopologyContext.html" title="class in org.apache.storm.task">GeneralTopologyContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/tuple/Tuple.html#getContext--">getContext</a></span>()</code> |
| <div class="block">Gets the topology context associated with the tuple.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/tuple/MessageId.html" title="class in org.apache.storm.tuple">MessageId</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/tuple/Tuple.html#getMessageId--">getMessageId</a></span>()</code> |
| <div class="block">Gets the message id that associated with this tuple.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/tuple/Tuple.html#getSourceComponent--">getSourceComponent</a></span>()</code> |
| <div class="block">Gets the id of the component that created this tuple.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/storm/generated/GlobalStreamId.html" title="class in org.apache.storm.generated">GlobalStreamId</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/tuple/Tuple.html#getSourceGlobalStreamId--">getSourceGlobalStreamId</a></span>()</code> |
| <div class="block">Returns the global stream id (component + stream) of this tuple.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/tuple/Tuple.html#getSourceStreamId--">getSourceStreamId</a></span>()</code> |
| <div class="block">Gets the id of the stream that this tuple was emitted to.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/tuple/Tuple.html#getSourceTask--">getSourceTask</a></span>()</code> |
| <div class="block">Gets the id of the task that created this tuple.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.storm.tuple.ITuple"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.storm.tuple.<a href="../../../../org/apache/storm/tuple/ITuple.html" title="interface in org.apache.storm.tuple">ITuple</a></h3> |
| <code><a href="../../../../org/apache/storm/tuple/ITuple.html#contains-java.lang.String-">contains</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#fieldIndex-java.lang.String-">fieldIndex</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getBinary-int-">getBinary</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getBinaryByField-java.lang.String-">getBinaryByField</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getBoolean-int-">getBoolean</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getBooleanByField-java.lang.String-">getBooleanByField</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getByte-int-">getByte</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getByteByField-java.lang.String-">getByteByField</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getDouble-int-">getDouble</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getDoubleByField-java.lang.String-">getDoubleByField</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getFields--">getFields</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getFloat-int-">getFloat</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getFloatByField-java.lang.String-">getFloatByField</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getInteger-int-">getInteger</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getIntegerByField-java.lang.String-">getIntegerByField</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getLong-int-">getLong</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getLongByField-java.lang.String-">getLongByField</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getShort-int-">getShort</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getShortByField-java.lang.String-">getShortByField</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getString-int-">getString</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getStringByField-java.lang.String-">getStringByField</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getValue-int-">getValue</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getValueByField-java.lang.String-">getValueByField</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#getValues--">getValues</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#select-org.apache.storm.tuple.Fields-">select</a>, <a href="../../../../org/apache/storm/tuple/ITuple.html#size--">size</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getSourceGlobalStreamId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceGlobalStreamId</h4> |
| <pre><a href="../../../../org/apache/storm/generated/GlobalStreamId.html" title="class in org.apache.storm.generated">GlobalStreamId</a> getSourceGlobalStreamId()</pre> |
| <div class="block"><p>Returns the global stream id (component + stream) of this tuple.</p></div> |
| </li> |
| </ul> |
| <a name="getSourceComponent--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceComponent</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSourceComponent()</pre> |
| <div class="block"><p>Gets the id of the component that created this tuple.</p></div> |
| </li> |
| </ul> |
| <a name="getSourceTask--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceTask</h4> |
| <pre>int getSourceTask()</pre> |
| <div class="block"><p>Gets the id of the task that created this tuple.</p></div> |
| </li> |
| </ul> |
| <a name="getSourceStreamId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSourceStreamId</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSourceStreamId()</pre> |
| <div class="block"><p>Gets the id of the stream that this tuple was emitted to.</p></div> |
| </li> |
| </ul> |
| <a name="getMessageId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMessageId</h4> |
| <pre><a href="../../../../org/apache/storm/tuple/MessageId.html" title="class in org.apache.storm.tuple">MessageId</a> getMessageId()</pre> |
| <div class="block"><p>Gets the message id that associated with this tuple.</p></div> |
| </li> |
| </ul> |
| <a name="getContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getContext</h4> |
| <pre><a href="../../../../org/apache/storm/task/GeneralTopologyContext.html" title="class in org.apache.storm.task">GeneralTopologyContext</a> getContext()</pre> |
| <div class="block"><p>Gets the topology context associated with the tuple.</p></div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Tuple.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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><script type="text/javascript" src="../../../../highlight.pack.js"></script> |
| <script type="text/javascript"><!-- |
| hljs.initHighlightingOnLoad(); |
| //--></script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/storm/tuple/MessageId.html" title="class in org.apache.storm.tuple"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/storm/tuple/TupleImpl.html" title="class in org.apache.storm.tuple"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/storm/tuple/Tuple.html" target="_top">Frames</a></li> |
| <li><a href="Tuple.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.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> |
| </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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
