| <!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>Windows (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="Windows (Apache Edgent (incubating) v1.2.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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/Windows.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/Window.html" title="interface in org.apache.edgent.window"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/edgent/window/Windows.html" target="_top">Frames</a></li> |
| <li><a href="Windows.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><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 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="Class Windows" class="title">Class Windows</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.edgent.window.Windows</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">Windows</span> |
| extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">Factory to create <code>Window</code> implementations.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Windows.html#Windows--">Windows</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>static <T,K> <a href="../../../../org/apache/edgent/window/Window.html" title="interface in org.apache.edgent.window">Window</a><T,K,<a href="http://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html?is-external=true" title="class or interface in java.util">LinkedList</a><T>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Windows.html#lastNProcessOnInsert-int-org.apache.edgent.function.Function-">lastNProcessOnInsert</a></span>(int count, |
| <a href="../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,K> keyFunction)</code> |
| <div class="block">Return a window that maintains the last <code>count</code> tuples inserted |
| with processing triggered on every insert.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <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>><br><a href="../../../../org/apache/edgent/window/Window.html" title="interface in org.apache.edgent.window">Window</a><T,K,L></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Windows.html#window-org.apache.edgent.function.BiFunction-org.apache.edgent.function.BiConsumer-org.apache.edgent.function.Consumer-org.apache.edgent.function.BiConsumer-org.apache.edgent.function.Function-org.apache.edgent.function.Supplier-">window</a></span>(<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><T,K,L>,T,<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>> insertionPolicy, |
| <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><T,K,L>,T> contentsPolicy, |
| <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><T,K,L>> evictDeterminer, |
| <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><T,K,L>,T> triggerPolicy, |
| <a href="../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,K> keyFunction, |
| <a href="../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><L> listSupplier)</code> |
| <div class="block">Create a window using the passed in policies.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Windows--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Windows</h4> |
| <pre>public Windows()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="window-org.apache.edgent.function.BiFunction-org.apache.edgent.function.BiConsumer-org.apache.edgent.function.Consumer-org.apache.edgent.function.BiConsumer-org.apache.edgent.function.Function-org.apache.edgent.function.Supplier-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>window</h4> |
| <pre>public static <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>> <a href="../../../../org/apache/edgent/window/Window.html" title="interface in org.apache.edgent.window">Window</a><T,K,L> window(<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><T,K,L>,T,<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>> insertionPolicy, |
| <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><T,K,L>,T> contentsPolicy, |
| <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><T,K,L>> evictDeterminer, |
| <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><T,K,L>,T> triggerPolicy, |
| <a href="../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,K> keyFunction, |
| <a href="../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><L> listSupplier)</pre> |
| <div class="block">Create a window using the passed in policies.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Tuple type.</dd> |
| <dd><code>K</code> - Key type.</dd> |
| <dd><code>L</code> - List type.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>insertionPolicy</code> - Policy indicating if a tuple should be inserted |
| into the window.</dd> |
| <dd><code>contentsPolicy</code> - Contents policy called prior to insertion of a tuple.</dd> |
| <dd><code>evictDeterminer</code> - Policy that determines action to take when |
| <a href="../../../../org/apache/edgent/window/Partition.html#evict--"><code>Partition.evict()</code></a> is called.</dd> |
| <dd><code>triggerPolicy</code> - Trigger policy that is invoked after the insertion |
| of a tuple into a partition.</dd> |
| <dd><code>keyFunction</code> - Function that gets the partition key from a tuple.</dd> |
| <dd><code>listSupplier</code> - Supplier function for the <code>List</code> that holds |
| tuples within a partition.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Window using the passed in policies.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="lastNProcessOnInsert-int-org.apache.edgent.function.Function-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>lastNProcessOnInsert</h4> |
| <pre>public static <T,K> <a href="../../../../org/apache/edgent/window/Window.html" title="interface in org.apache.edgent.window">Window</a><T,K,<a href="http://docs.oracle.com/javase/8/docs/api/java/util/LinkedList.html?is-external=true" title="class or interface in java.util">LinkedList</a><T>> lastNProcessOnInsert(int count, |
| <a href="../../../../org/apache/edgent/function/Function.html" title="interface in org.apache.edgent.function">Function</a><T,K> keyFunction)</pre> |
| <div class="block">Return a window that maintains the last <code>count</code> tuples inserted |
| with processing triggered on every insert. This provides |
| a continuous processing, where processing is invoked every |
| time the window changes. Since insertion drives eviction |
| there is no need to process on eviction, thus once the window |
| has reached <code>count</code> tuples, each insertion results in an |
| eviction followed by processing of <code>count</code> tuples |
| including the tuple just inserted, which is the definition of |
| the window.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - Tuple type.</dd> |
| <dd><code>K</code> - Key type.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>count</code> - Number of tuple to maintain per partition</dd> |
| <dd><code>keyFunction</code> - Tuple partitioning key function</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>window that maintains the last <code>count</code> tuples on a stream</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/Windows.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/Window.html" title="interface in org.apache.edgent.window"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/edgent/window/Windows.html" target="_top">Frames</a></li> |
| <li><a href="Windows.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><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 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> |