| <!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 (1.8.0_112) on Mon Dec 18 11:25:19 EST 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>TWindow (Apache Edgent (incubating) v1.2.0 API)</title> |
| <meta name="date" content="2017-12-18"> |
| <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="TWindow (Apache Edgent (incubating) v1.2.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"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"; |
| </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/TWindow.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/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/edgent/topology/TWindow.html" target="_top">Frames</a></li> |
| <li><a href="TWindow.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.edgent.topology</div> |
| <h2 title="Interface TWindow" class="title">Interface TWindow<T,K></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Tuple type</dd> |
| <dd><code>K</code> - Partition key type</dd> |
| </dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/edgent/topology/spi/graph/AbstractTWindow.html" title="class in org.apache.edgent.topology.spi.graph">AbstractTWindow</a>, <a href="../../../../org/apache/edgent/topology/spi/graph/TWindowImpl.html" title="class in org.apache.edgent.topology.spi.graph">TWindowImpl</a>, <a href="../../../../org/apache/edgent/topology/spi/graph/TWindowTimeImpl.html" title="class in org.apache.edgent.topology.spi.graph">TWindowTimeImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">TWindow<T,K></span> |
| extends <a href="../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></pre> |
| <div class="block">Partitioned window of tuples. Logically a window |
| represents an continuously updated ordered list of tuples according to the |
| criteria that created it. For example <a href="../../../../org/apache/edgent/topology/TStream.html#last-int-org.apache.edgent.function.Function-"><code>s.last(10, zero())</code></a> |
| declares a window with a single partition that at any time contains the last ten tuples seen on |
| stream <code>s</code>. |
| <P> |
| Windows are partitioned which means the window's configuration |
| is independently maintained for each key seen on the stream. |
| For example with a window created using <a href="../../../../org/apache/edgent/topology/TStream.html#last-int-org.apache.edgent.function.Function-"><code>last(3, tuple -> tuple.getId())</code></a> |
| then each key has its own window containing the last |
| three tuples with the same key obtained from the tuple's identity using <code>getId()</code>. |
| </P></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/edgent/topology/TStream.html#last-int-org.apache.edgent.function.Function-"><code>Count based window</code></a>, |
| <a href="../../../../org/apache/edgent/topology/TStream.html#last-long-java.util.concurrent.TimeUnit-org.apache.edgent.function.Function-"><code>Time based window</code></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><U> <a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><U></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/topology/TWindow.html#aggregate-org.apache.edgent.function.BiFunction-">aggregate</a></span>(<a href="../../../../org/apache/edgent/function/BiFunction.html" title="interface in org.apache.edgent.function">BiFunction</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/edgent/topology/TWindow.html" title="type parameter in TWindow">T</a>>,<a href="../../../../org/apache/edgent/topology/TWindow.html" title="type parameter in TWindow">K</a>,U> aggregator)</code> |
| <div class="block">Declares a stream that is a continuous, sliding, aggregation of |
| partitions in this window.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><U> <a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><U></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/topology/TWindow.html#batch-org.apache.edgent.function.BiFunction-">batch</a></span>(<a href="../../../../org/apache/edgent/function/BiFunction.html" title="interface in org.apache.edgent.function">BiFunction</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/edgent/topology/TWindow.html" title="type parameter in TWindow">T</a>>,<a href="../../../../org/apache/edgent/topology/TWindow.html" title="type parameter in TWindow">K</a>,U> batcher)</code> |
| <div class="block">Declares a stream that represents a batched aggregation of |
| partitions in this window.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><<a href="../../../../org/apache/edgent/topology/TWindow.html" title="type parameter in TWindow">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/topology/TWindow.html#feeder--">feeder</a></span>()</code> |
| <div class="block">Get the stream that feeds this window.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><<a href="../../../../org/apache/edgent/topology/TWindow.html" title="type parameter in TWindow">T</a>,<a href="../../../../org/apache/edgent/topology/TWindow.html" title="type parameter in TWindow">K</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/topology/TWindow.html#getKeyFunction--">getKeyFunction</a></span>()</code> |
| <div class="block">Returns the key function used to map tuples to partitions.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.edgent.topology.TopologyElement"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.edgent.topology.<a href="../../../../org/apache/edgent/topology/TopologyElement.html" title="interface in org.apache.edgent.topology">TopologyElement</a></h3> |
| <code><a href="../../../../org/apache/edgent/topology/TopologyElement.html#topology--">topology</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="aggregate-org.apache.edgent.function.BiFunction-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>aggregate</h4> |
| <pre><U> <a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><U> aggregate(<a href="../../../../org/apache/edgent/function/BiFunction.html" title="interface in org.apache.edgent.function">BiFunction</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/edgent/topology/TWindow.html" title="type parameter in TWindow">T</a>>,<a href="../../../../org/apache/edgent/topology/TWindow.html" title="type parameter in TWindow">K</a>,U> aggregator)</pre> |
| <div class="block">Declares a stream that is a continuous, sliding, aggregation of |
| partitions in this window. |
| <P> |
| Changes in a partition's contents trigger an invocation of |
| <code>aggregator.apply(tuples, key)</code>, where <code>tuples</code> is |
| a <code>List<T></code> containing all the tuples in the partition in |
| insertion order from oldest to newest. The list is stable |
| during the aggregator invocation. |
| <UL> |
| <LI>Count-based window: the aggregator is called after each |
| tuple added to a partition. When an addition results in a tuple |
| being evicted, the eviction occurs before the aggregator is called.</LI> |
| <LI>Time-based window: the aggregator is called after each tuple |
| added to a partition. The aggregator is also called |
| each time one or more tuples are evicted from a partition |
| (multiple tuples may be evicted at once). The list will be |
| empty if the eviction results in an empty partition.</LI> |
| </UL> |
| A non-null <code>aggregator</code> result is added to the returned stream. |
| <P> |
| Thus the returned stream will contain a sequence of tuples where the |
| most recent tuple represents the most up to date aggregation of a |
| partition.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>U</code> - Tuple type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>aggregator</code> - Logic to aggregation a partition.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A stream that contains the latest aggregations of partitions in this window.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="batch-org.apache.edgent.function.BiFunction-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>batch</h4> |
| <pre><U> <a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><U> batch(<a href="../../../../org/apache/edgent/function/BiFunction.html" title="interface in org.apache.edgent.function">BiFunction</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/edgent/topology/TWindow.html" title="type parameter in TWindow">T</a>>,<a href="../../../../org/apache/edgent/topology/TWindow.html" title="type parameter in TWindow">K</a>,U> batcher)</pre> |
| <div class="block">Declares a stream that represents a batched aggregation of |
| partitions in this window. |
| <P> |
| Each partition "batch" triggers an invocation of |
| <code>batcher.apply(tuples, key)</code>, where <code>tuples</code> is |
| a <code>List<T></code> containing all the tuples in the partition in |
| insertion order from oldest to newest The list is stable |
| during the batcher invocation. |
| <UL> |
| <LI>Count-based window: a batch occurs when the partition is full.</LI> |
| <LI>Time-based window: a batch occurs every "time" period units. The |
| list will be empty if no tuples have been received during the period.</LI> |
| </UL> |
| A non-null <code>batcher</code> result is added to the returned stream. |
| The partition's contents are cleared after a batch is processed. |
| <P> |
| Thus the returned stream will contain a sequence of tuples where the |
| most recent tuple represents the most up to date aggregation of a |
| partition.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>U</code> - Tuple type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>batcher</code> - Logic to aggregation a partition.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A stream that contains the latest aggregations of partitions in this window.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getKeyFunction--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKeyFunction</h4> |
| <pre><a href="../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><<a href="../../../../org/apache/edgent/topology/TWindow.html" title="type parameter in TWindow">T</a>,<a href="../../../../org/apache/edgent/topology/TWindow.html" title="type parameter in TWindow">K</a>> getKeyFunction()</pre> |
| <div class="block">Returns the key function used to map tuples to partitions.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Key function used to map tuples to partitions.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="feeder--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>feeder</h4> |
| <pre><a href="../../../../org/apache/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology">TStream</a><<a href="../../../../org/apache/edgent/topology/TWindow.html" title="type parameter in TWindow">T</a>> feeder()</pre> |
| <div class="block">Get the stream that feeds this window.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>stream that feeds this window.</dd> |
| </dl> |
| </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/TWindow.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/edgent/topology/TStream.html" title="interface in org.apache.edgent.topology"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/edgent/topology/TWindow.html" target="_top">Frames</a></li> |
| <li><a href="TWindow.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 © 2016–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
