| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 --> |
| <title>TupleWindowImpl (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="TupleWindowImpl (Heron Java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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 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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.storm.windowing</a></div> |
| <h2 title="Class TupleWindowImpl" class="title">Class TupleWindowImpl</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.storm.windowing.TupleWindowImpl</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="TupleWindow.html" title="interface in org.apache.storm.windowing">TupleWindow</a></code>, <code><a href="Window.html" title="interface in org.apache.storm.windowing">Window</a><<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">TupleWindowImpl</span> |
| extends java.lang.Object |
| implements <a href="TupleWindow.html" title="interface in org.apache.storm.windowing">TupleWindow</a></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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"> </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(org.apache.heron.api.windowing.TupleWindow)">TupleWindowImpl</a></span>​(<a href="../../heron/api/windowing/TupleWindow.html" title="interface in org.apache.heron.api.windowing">TupleWindow</a> tupleWindow)</code></th> |
| <td class="colLast"> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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.util.List<<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get()">get</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the list of events in the window.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEndTimestamp()">getEndTimestamp</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">If processing based on event time, returns the window end time based on watermark otherwise |
| returns the window end time based on processing time.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExpired()">getExpired</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the list of events expired from the window since the last time the window was generated.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNew()">getNew</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get the list of newly added events in the window since the last time the window was generated.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.Long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStartTimestamp()">getStartTimestamp</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the window start timestamp.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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.storm.windowing.Window"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.storm.windowing.<a href="Window.html" title="interface in org.apache.storm.windowing">Window</a></h3> |
| <code><a href="Window.html#getIter()">getIter</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.apache.heron.api.windowing.TupleWindow)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TupleWindowImpl</h4> |
| <pre>public TupleWindowImpl​(<a href="../../heron/api/windowing/TupleWindow.html" title="interface in org.apache.heron.api.windowing">TupleWindow</a> tupleWindow)</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="get()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre class="methodSignature">public java.util.List<<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>> get()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="Window.html#get()">Window</a></code></span></div> |
| <div class="block">Gets the list of events in the window. |
| <p> |
| <b>Note: </b> If the number of tuples in windows is huge, invoking <code>get</code> would |
| load all the tuples into memory and may throw an OOM exception. Use |
| windowing with persistence |
| </p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Window.html#get()">get</a></code> in interface <code><a href="Window.html" title="interface in org.apache.storm.windowing">Window</a><<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of events in the window.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getNew()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNew</h4> |
| <pre class="methodSignature">public java.util.List<<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>> getNew()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="Window.html#getNew()">Window</a></code></span></div> |
| <div class="block">Get the list of newly added events in the window since the last time the window was generated.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Window.html#getNew()">getNew</a></code> in interface <code><a href="Window.html" title="interface in org.apache.storm.windowing">Window</a><<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of newly added events in the window.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getExpired()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExpired</h4> |
| <pre class="methodSignature">public java.util.List<<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>> getExpired()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="Window.html#getExpired()">Window</a></code></span></div> |
| <div class="block">Get the list of events expired from the window since the last time the window was generated.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Window.html#getExpired()">getExpired</a></code> in interface <code><a href="Window.html" title="interface in org.apache.storm.windowing">Window</a><<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of events expired from the window.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getEndTimestamp()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEndTimestamp</h4> |
| <pre class="methodSignature">public java.lang.Long getEndTimestamp()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="Window.html#getEndTimestamp()">Window</a></code></span></div> |
| <div class="block">If processing based on event time, returns the window end time based on watermark otherwise |
| returns the window end time based on processing time.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Window.html#getEndTimestamp()">getEndTimestamp</a></code> in interface <code><a href="Window.html" title="interface in org.apache.storm.windowing">Window</a><<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the window end timestamp</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getStartTimestamp()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getStartTimestamp</h4> |
| <pre class="methodSignature">public java.lang.Long getStartTimestamp()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="Window.html#getStartTimestamp()">Window</a></code></span></div> |
| <div class="block">Returns the window start timestamp. Will return null if the window length is not based on |
| time duration.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Window.html#getStartTimestamp()">getStartTimestamp</a></code> in interface <code><a href="Window.html" title="interface in org.apache.storm.windowing">Window</a><<a href="../tuple/Tuple.html" title="interface in org.apache.storm.tuple">Tuple</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the window start timestamp or null if the window length is not time based</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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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> |
