| <!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:18 EST 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Window (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="Window (Apache Edgent (incubating) v1.2.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":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/Window.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/window/Policies.html" title="class in org.apache.edgent.window"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/edgent/window/Windows.html" title="class in org.apache.edgent.window"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/edgent/window/Window.html" target="_top">Frames</a></li> |
| <li><a href="Window.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.window</div> |
| <h2 title="Interface Window" class="title">Interface Window<T,K,L extends <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><T>></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> - type of tuples in the window</dd> |
| <dd><code>K</code> - type of the window's key</dd> |
| <dd><code>L</code> - type of the list used to contain tuples.</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Window<T,K,L extends <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><T>></span></pre> |
| <div class="block">Partitioned window of tuples. |
| Conceptually a window maintains a continuously |
| changing subset of tuples on a stream, such as the last ten tuples |
| or tuples that have arrived in the last five minutes. |
| <P> |
| <code>Window</code> is partitioned by keys obtained |
| from tuples using a key function. Each tuple is |
| inserted into a partition containing all tuples |
| with the same key (using <code>equals()</code>). |
| Each partition independently maintains the subset of |
| tuples defined by the windows policies. |
| <BR> |
| An unpartitioned is created by using a key function that |
| returns a constant, to force all tuples to be inserted |
| into a single partition. A convenience function |
| <a href="../../../../org/apache/edgent/function/Functions.html#unpartitioned--"><code>unpartitioned()</code></a> is |
| provided that returns zero as the fixed key. |
| </P> |
| <P> |
| The window's policies are flexible to allow any definition of |
| what tuples each partition will contain, and how the |
| partition is processed. |
| </P></div> |
| </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/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function">BiConsumer</a><<a href="../../../../org/apache/edgent/window/Partition.html" title="interface in org.apache.edgent.window">Partition</a><<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">L</a>>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Window.html#getContentsPolicy--">getContentsPolicy</a></span>()</code> |
| <div class="block">Returns the contents policy of the window.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/edgent/function/Consumer.html" title="interface in org.apache.edgent.function">Consumer</a><<a href="../../../../org/apache/edgent/window/Partition.html" title="interface in org.apache.edgent.window">Partition</a><<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">L</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Window.html#getEvictDeterminer--">getEvictDeterminer</a></span>()</code> |
| <div class="block">Returns the window's eviction determiner.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/edgent/function/BiFunction.html" title="interface in org.apache.edgent.function">BiFunction</a><<a href="../../../../org/apache/edgent/window/Partition.html" title="interface in org.apache.edgent.window">Partition</a><<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">L</a>>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Window.html#getInsertionPolicy--">getInsertionPolicy</a></span>()</code> |
| <div class="block">Returns the insertion policy of the 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/window/Window.html" title="type parameter in Window">T</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Window.html#getKeyFunction--">getKeyFunction</a></span>()</code> |
| <div class="block">Returns the keyFunction of the window</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function">BiConsumer</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/window/Window.html" title="type parameter in Window">T</a>>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Window.html#getPartitionProcessor--">getPartitionProcessor</a></span>()</code> |
| <div class="block">Returns the partition processor associated with the window.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>,<a href="../../../../org/apache/edgent/window/Partition.html" title="interface in org.apache.edgent.window">Partition</a><<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">L</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Window.html#getPartitions--">getPartitions</a></span>()</code> |
| <div class="block">Retrieves the partitions in the window.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ScheduledExecutorService</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Window.html#getScheduledExecutorService--">getScheduledExecutorService</a></span>()</code> |
| <div class="block">Returns the ScheduledExecutorService associated with the window.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function">BiConsumer</a><<a href="../../../../org/apache/edgent/window/Partition.html" title="interface in org.apache.edgent.window">Partition</a><<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">L</a>>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Window.html#getTriggerPolicy--">getTriggerPolicy</a></span>()</code> |
| <div class="block">Returns the window's trigger policy.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Window.html#insert-T-">insert</a></span>(<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a> tuple)</code> |
| <div class="block">Attempts to insert the tuple into its partition.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Window.html#registerPartitionProcessor-org.apache.edgent.function.BiConsumer-">registerPartitionProcessor</a></span>(<a href="../../../../org/apache/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function">BiConsumer</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/window/Window.html" title="type parameter in Window">T</a>>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>> windowProcessor)</code> |
| <div class="block">Register a WindowProcessor.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Window.html#registerScheduledExecutorService-java.util.concurrent.ScheduledExecutorService-">registerScheduledExecutorService</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ScheduledExecutorService</a> ses)</code> |
| <div class="block">Register a ScheduledExecutorService.</div> |
| </td> |
| </tr> |
| </table> |
| </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="insert-java.lang.Object-"> |
| <!-- --> |
| </a><a name="insert-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>insert</h4> |
| <pre>boolean insert(<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a> tuple)</pre> |
| <div class="block">Attempts to insert the tuple into its partition. |
| Tuple insertion performs the following actions in order: |
| <OL> |
| <LI>Call <code>K key = getKeyFunction().apply(tuple)</code> to obtain the partition key.</LI> |
| <LI>Get the partition for <code>key</code> creating an empty partition if one did not exist for <code>key</code>. </LI> |
| <LI>Apply the insertion policy, calling <code>getInsertionPolicy().apply(partition, tuple)</code>. If it returns false then return false from this method, |
| otherwise continue.</LI> |
| <LI>Apply the contents policy, calling <code>getContentsPolicy().apply(partition, tuple)</code>. |
| This is a pre-insertion action that allows any action. Some policies may request room to be made for |
| the insertion by calling <a href="../../../../org/apache/edgent/window/Partition.html#evict--"><code>evict()</code></a> which will result in a call to the evict determiner.</LI> |
| <LI>Add <code>tuple</code> to the contents of the partition.</LI> |
| <LI>Apply the trigger policy, calling <code>getTriggerPolicy().apply(partition, tuple)</code>. |
| This is a post-insertion that action allows any action. A typical implementation is to call |
| <a href="../../../../org/apache/edgent/window/Partition.html#process--"><code>partition.process()</code></a> to perform processing of the window. |
| </OL></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tuple</code> - the tuple to insert</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true, if the tuple was successfully inserted. Otherwise, false.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerPartitionProcessor-org.apache.edgent.function.BiConsumer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerPartitionProcessor</h4> |
| <pre>void registerPartitionProcessor(<a href="../../../../org/apache/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function">BiConsumer</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/window/Window.html" title="type parameter in Window">T</a>>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>> windowProcessor)</pre> |
| <div class="block">Register a WindowProcessor.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>windowProcessor</code> - function to process the window</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="registerScheduledExecutorService-java.util.concurrent.ScheduledExecutorService-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>registerScheduledExecutorService</h4> |
| <pre>void registerScheduledExecutorService(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ScheduledExecutorService</a> ses)</pre> |
| <div class="block">Register a ScheduledExecutorService.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>ses</code> - the service</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInsertionPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInsertionPolicy</h4> |
| <pre><a href="../../../../org/apache/edgent/function/BiFunction.html" title="interface in org.apache.edgent.function">BiFunction</a><<a href="../../../../org/apache/edgent/window/Partition.html" title="interface in org.apache.edgent.window">Partition</a><<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">L</a>>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a>> getInsertionPolicy()</pre> |
| <div class="block">Returns the insertion policy of the window. |
| is called</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The insertion policy.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContentsPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContentsPolicy</h4> |
| <pre><a href="../../../../org/apache/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function">BiConsumer</a><<a href="../../../../org/apache/edgent/window/Partition.html" title="interface in org.apache.edgent.window">Partition</a><<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">L</a>>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a>> getContentsPolicy()</pre> |
| <div class="block">Returns the contents policy of the window. |
| The contents policy is invoked before a tuple |
| is inserted into a partition.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>contents policy for this window.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTriggerPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTriggerPolicy</h4> |
| <pre><a href="../../../../org/apache/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function">BiConsumer</a><<a href="../../../../org/apache/edgent/window/Partition.html" title="interface in org.apache.edgent.window">Partition</a><<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">L</a>>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a>> getTriggerPolicy()</pre> |
| <div class="block">Returns the window's trigger policy. |
| The trigger policy is invoked (triggered) by |
| the insertion of a tuple into a partition.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>trigger policy for this window.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPartitionProcessor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPartitionProcessor</h4> |
| <pre><a href="../../../../org/apache/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function">BiConsumer</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/window/Window.html" title="type parameter in Window">T</a>>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>> getPartitionProcessor()</pre> |
| <div class="block">Returns the partition processor associated with the window.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>partitionProcessor</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getScheduledExecutorService--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getScheduledExecutorService</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/ScheduledExecutorService.html?is-external=true" title="class or interface in java.util.concurrent">ScheduledExecutorService</a> getScheduledExecutorService()</pre> |
| <div class="block">Returns the ScheduledExecutorService associated with the window.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ScheduledExecutorService</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEvictDeterminer--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEvictDeterminer</h4> |
| <pre><a href="../../../../org/apache/edgent/function/Consumer.html" title="interface in org.apache.edgent.function">Consumer</a><<a href="../../../../org/apache/edgent/window/Partition.html" title="interface in org.apache.edgent.window">Partition</a><<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">L</a>>> getEvictDeterminer()</pre> |
| <div class="block">Returns the window's eviction determiner. |
| The evict determiner is responsible for |
| determining which tuples in a window need |
| to be evicted. |
| <BR> |
| Calls to <a href="../../../../org/apache/edgent/window/Partition.html#evict--"><code>Partition.evict()</code></a> result in |
| <code>getEvictDeterminer().accept(partition)</code> being |
| called. |
| In some cases this may not result in tuples being |
| evicted from the partition. |
| <P> |
| An evict determiner evicts tuples from the partition |
| by removing them from the list returned by |
| <a href="../../../../org/apache/edgent/window/Partition.html#getContents--"><code>Partition.getContents()</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>evict determiner for 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/window/Window.html" title="type parameter in Window">T</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>> getKeyFunction()</pre> |
| <div class="block">Returns the keyFunction of the window</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The window's keyFunction.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPartitions--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getPartitions</h4> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>,<a href="../../../../org/apache/edgent/window/Partition.html" title="interface in org.apache.edgent.window">Partition</a><<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">T</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">K</a>,<a href="../../../../org/apache/edgent/window/Window.html" title="type parameter in Window">L</a>>> getPartitions()</pre> |
| <div class="block">Retrieves the partitions in the window. The map of partitions |
| is stable when synchronizing on the intrinsic lock of the map, |
| for example: |
| <br> |
| <pre><code> |
| Map<K, Partitions<U, K, ?>> partitions = window.getPartitions(); |
| synchronized(partitions){ |
| // operations with partition |
| } |
| </code></pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A map of the window's keys and partitions.</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/Window.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/window/Policies.html" title="class in org.apache.edgent.window"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/edgent/window/Windows.html" title="class in org.apache.edgent.window"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/edgent/window/Window.html" target="_top">Frames</a></li> |
| <li><a href="Window.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> |
