| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Tuple (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.tuple, interface: Tuple"> |
| <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/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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.tuple</a></div> |
| <h1 title="Interface Tuple" class="title">Interface Tuple</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="ITuple.html" title="interface in org.apache.storm.tuple">ITuple</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../clojure/ClojureTuple.html" title="class in org.apache.storm.clojure">ClojureTuple</a></code>, <code><a href="TupleImpl.html" title="class in org.apache.storm.tuple">TupleImpl</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Tuple</span><span class="extends-implements"> |
| extends <a href="ITuple.html" title="interface in org.apache.storm.tuple">ITuple</a></span></div> |
| <div class="block">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>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.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="http://storm.apache.org/documentation/Serialization.html">Serialization</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code><a href="../task/GeneralTopologyContext.html" title="class in org.apache.storm.task">GeneralTopologyContext</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getContext()" class="member-name-link">getContext</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the topology context associated with the tuple.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="MessageId.html" title="class in org.apache.storm.tuple">MessageId</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getMessageId()" class="member-name-link">getMessageId</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the message id that associated with this tuple.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSourceComponent()" class="member-name-link">getSourceComponent</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the id of the component that created this tuple.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../generated/GlobalStreamId.html" title="class in org.apache.storm.generated">GlobalStreamId</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSourceGlobalStreamId()" class="member-name-link">getSourceGlobalStreamId</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the global stream id (component + stream) of this tuple.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSourceStreamId()" class="member-name-link">getSourceStreamId</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the id of the stream that this tuple was emitted to.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSourceTask()" class="member-name-link">getSourceTask</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Gets the id of the task that created this tuple.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.tuple.ITuple">Methods inherited from interface org.apache.storm.tuple.<a href="ITuple.html" title="interface in org.apache.storm.tuple">ITuple</a></h3> |
| <code><a href="ITuple.html#contains(java.lang.String)">contains</a>, <a href="ITuple.html#fieldIndex(java.lang.String)">fieldIndex</a>, <a href="ITuple.html#getBinary(int)">getBinary</a>, <a href="ITuple.html#getBinaryByField(java.lang.String)">getBinaryByField</a>, <a href="ITuple.html#getBoolean(int)">getBoolean</a>, <a href="ITuple.html#getBooleanByField(java.lang.String)">getBooleanByField</a>, <a href="ITuple.html#getByte(int)">getByte</a>, <a href="ITuple.html#getByteByField(java.lang.String)">getByteByField</a>, <a href="ITuple.html#getDouble(int)">getDouble</a>, <a href="ITuple.html#getDoubleByField(java.lang.String)">getDoubleByField</a>, <a href="ITuple.html#getFields()">getFields</a>, <a href="ITuple.html#getFloat(int)">getFloat</a>, <a href="ITuple.html#getFloatByField(java.lang.String)">getFloatByField</a>, <a href="ITuple.html#getInteger(int)">getInteger</a>, <a href="ITuple.html#getIntegerByField(java.lang.String)">getIntegerByField</a>, <a href="ITuple.html#getLong(int)">getLong</a>, <a href="ITuple.html#getLongByField(java.lang.String)">getLongByField</a>, <a href="ITuple.html#getShort(int)">getShort</a>, <a href="ITuple.html#getShortByField(java.lang.String)">getShortByField</a>, <a href="ITuple.html#getString(int)">getString</a>, <a href="ITuple.html#getStringByField(java.lang.String)">getStringByField</a>, <a href="ITuple.html#getValue(int)">getValue</a>, <a href="ITuple.html#getValueByField(java.lang.String)">getValueByField</a>, <a href="ITuple.html#getValues()">getValues</a>, <a href="ITuple.html#select(org.apache.storm.tuple.Fields)">select</a>, <a href="ITuple.html#size()">size</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getSourceGlobalStreamId()"> |
| <h3>getSourceGlobalStreamId</h3> |
| <div class="member-signature"><span class="return-type"><a href="../generated/GlobalStreamId.html" title="class in org.apache.storm.generated">GlobalStreamId</a></span> <span class="element-name">getSourceGlobalStreamId</span>()</div> |
| <div class="block">Returns the global stream id (component + stream) of this tuple.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSourceComponent()"> |
| <h3>getSourceComponent</h3> |
| <div class="member-signature"><span class="return-type"><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></span> <span class="element-name">getSourceComponent</span>()</div> |
| <div class="block">Gets the id of the component that created this tuple.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSourceTask()"> |
| <h3>getSourceTask</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name">getSourceTask</span>()</div> |
| <div class="block">Gets the id of the task that created this tuple.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSourceStreamId()"> |
| <h3>getSourceStreamId</h3> |
| <div class="member-signature"><span class="return-type"><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></span> <span class="element-name">getSourceStreamId</span>()</div> |
| <div class="block">Gets the id of the stream that this tuple was emitted to.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMessageId()"> |
| <h3>getMessageId</h3> |
| <div class="member-signature"><span class="return-type"><a href="MessageId.html" title="class in org.apache.storm.tuple">MessageId</a></span> <span class="element-name">getMessageId</span>()</div> |
| <div class="block">Gets the message id that associated with this tuple.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContext()"> |
| <h3>getContext</h3> |
| <div class="member-signature"><span class="return-type"><a href="../task/GeneralTopologyContext.html" title="class in org.apache.storm.task">GeneralTopologyContext</a></span> <span class="element-name">getContext</span>()</div> |
| <div class="block">Gets the topology context associated with the tuple.</div> |
| </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> |
