| <!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>Policies (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="Policies (Apache Edgent (incubating) v1.2.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":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/Policies.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/PartitionedState.html" title="class in org.apache.edgent.window"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/edgent/window/Window.html" title="interface 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/Policies.html" target="_top">Frames</a></li> |
| <li><a href="Policies.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 Policies" class="title">Class Policies</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.Policies</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">Policies</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">Common window policies.</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/Policies.html#Policies--">Policies</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,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/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>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Policies.html#alwaysInsert--">alwaysInsert</a></span>()</code> |
| <div class="block">Returns an insertion policy that indicates the tuple |
| is to be inserted into the partition.</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/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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Policies.html#countContentsPolicy-int-">countContentsPolicy</a></span>(int count)</code> |
| <div class="block">Returns a count-based contents policy.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <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/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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Policies.html#doNothing--">doNothing</a></span>()</code> |
| <div class="block">A <a href="../../../../org/apache/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function"><code>BiConsumer</code></a> policy which does nothing.</div> |
| </td> |
| </tr> |
| <tr id="i3" 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/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>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Policies.html#evictAll--">evictAll</a></span>()</code> |
| <div class="block">Returns a Consumer representing an evict determiner that evict all tuples |
| from the window.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <T,K> <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,<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>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Policies.html#evictAllAndScheduleEvictWithProcess-long-java.util.concurrent.TimeUnit-">evictAllAndScheduleEvictWithProcess</a></span>(long time, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> |
| <div class="block">An eviction policy which processes the window, evicts all tuples, and |
| schedules the next eviction after the appropriate interval.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <T,K> <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,<a href="../../../../org/apache/edgent/window/InsertionTimeList.html" title="class in org.apache.edgent.window">InsertionTimeList</a><T>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Policies.html#evictOlderWithProcess-long-java.util.concurrent.TimeUnit-">evictOlderWithProcess</a></span>(long time, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> |
| <div class="block">An eviction policy which evicts all tuples that are older than a specified time.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <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/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>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Policies.html#evictOldest--">evictOldest</a></span>()</code> |
| <div class="block">Returns an evict determiner that evicts the oldest tuple.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><<a href="../../../../org/apache/edgent/window/InsertionTimeList.html" title="class in org.apache.edgent.window">InsertionTimeList</a><T>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Policies.html#insertionTimeList--">insertionTimeList</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <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/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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Policies.html#processOnInsert--">processOnInsert</a></span>()</code> |
| <div class="block">Returns a trigger policy that triggers |
| processing on every insert.</div> |
| </td> |
| </tr> |
| <tr id="i9" 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/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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Policies.html#processWhenFullAndEvict-int-">processWhenFullAndEvict</a></span>(int size)</code> |
| <div class="block">Returns a trigger policy that triggers when the size of a partition |
| equals or exceeds a value, and then evicts its contents.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <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/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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Policies.html#scheduleEvictIfEmpty-long-java.util.concurrent.TimeUnit-">scheduleEvictIfEmpty</a></span>(long time, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> |
| <div class="block">A policy which schedules a future partition eviction if the partition is empty.</div> |
| </td> |
| </tr> |
| <tr id="i11" 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/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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/edgent/window/Policies.html#scheduleEvictOnFirstInsert-long-java.util.concurrent.TimeUnit-">scheduleEvictOnFirstInsert</a></span>(long time, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> |
| <div class="block">A policy which schedules a future partition eviction on the first insert.</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="Policies--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Policies</h4> |
| <pre>public Policies()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="scheduleEvictIfEmpty-long-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scheduleEvictIfEmpty</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/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> scheduleEvictIfEmpty(long time, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> |
| <div class="block">A policy which schedules a future partition eviction if the partition is empty. |
| This can be used as a contents policy that is scheduling the eviction of |
| the tuple just about to be inserted.</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 for the partition contents.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>time</code> - The time span in which tuple are permitted in the partition.</dd> |
| <dd><code>unit</code> - The units of time.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The time-based contents policy.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="scheduleEvictOnFirstInsert-long-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>scheduleEvictOnFirstInsert</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/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> scheduleEvictOnFirstInsert(long time, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> |
| <div class="block">A policy which schedules a future partition eviction on the first insert. |
| This can be used as a contents policy that schedules the eviction of tuples |
| as a batch.</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 for the partition contents.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>time</code> - The time span in which tuple are permitted in the partition.</dd> |
| <dd><code>unit</code> - The units of time.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The time-based contents policy.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="evictOlderWithProcess-long-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>evictOlderWithProcess</h4> |
| <pre>public static <T,K> <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,<a href="../../../../org/apache/edgent/window/InsertionTimeList.html" title="class in org.apache.edgent.window">InsertionTimeList</a><T>>> evictOlderWithProcess(long time, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> |
| <div class="block">An eviction policy which evicts all tuples that are older than a specified time. |
| If any tuples remain in the partition, it schedules their eviction after |
| an appropriate interval.</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>time</code> - The timespan in which tuple are permitted in the partition.</dd> |
| <dd><code>unit</code> - The units of time.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The time-based eviction policy.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="evictAllAndScheduleEvictWithProcess-long-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>evictAllAndScheduleEvictWithProcess</h4> |
| <pre>public static <T,K> <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,<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>>> evictAllAndScheduleEvictWithProcess(long time, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</pre> |
| <div class="block">An eviction policy which processes the window, evicts all tuples, and |
| schedules the next eviction after the appropriate interval.</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>time</code> - The timespan in which tuple are permitted in the partition.</dd> |
| <dd><code>unit</code> - The units of time.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The time-based eviction policy.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="alwaysInsert--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>alwaysInsert</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/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>> alwaysInsert()</pre> |
| <div class="block">Returns an insertion policy that indicates the tuple |
| is to be inserted into the partition.</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 for the partition contents.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An insertion policy that always inserts.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="countContentsPolicy-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>countContentsPolicy</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/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> countContentsPolicy(int count)</pre> |
| <div class="block">Returns a count-based contents policy. |
| If, when called, the number of tuples in the partition is |
| greater than equal to <code>count</code> then <code>partition.evict()</code> |
| is called.</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 for the partition contents.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>count</code> - the count</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A count-based contents policy.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="evictAll--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>evictAll</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/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>> evictAll()</pre> |
| <div class="block">Returns a Consumer representing an evict determiner that evict all tuples |
| from 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> |
| <dd><code>L</code> - List type for the partition contents.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An evict determiner that evicts all tuples.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="evictOldest--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>evictOldest</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/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>> evictOldest()</pre> |
| <div class="block">Returns an evict determiner that evicts the oldest tuple.</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 for the partition contents.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A evict determiner that evicts the oldest tuple.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="processOnInsert--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>processOnInsert</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/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> processOnInsert()</pre> |
| <div class="block">Returns a trigger policy that triggers |
| processing on every insert.</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 for the partition contents.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A trigger policy that triggers processing on every insert.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="processWhenFullAndEvict-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>processWhenFullAndEvict</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/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> processWhenFullAndEvict(int size)</pre> |
| <div class="block">Returns a trigger policy that triggers when the size of a partition |
| equals or exceeds a value, and then evicts its contents.</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 for the partition contents.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>size</code> - partition size</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A trigger policy that triggers processing when the size of |
| the partition equals or exceets a value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="doNothing--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>doNothing</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/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> doNothing()</pre> |
| <div class="block">A <a href="../../../../org/apache/edgent/function/BiConsumer.html" title="interface in org.apache.edgent.function"><code>BiConsumer</code></a> policy which does nothing.</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 for the partition contents.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A policy which does nothing.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="insertionTimeList--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>insertionTimeList</h4> |
| <pre>public static <T> <a href="../../../../org/apache/edgent/function/Supplier.html" title="interface in org.apache.edgent.function">Supplier</a><<a href="../../../../org/apache/edgent/window/InsertionTimeList.html" title="class in org.apache.edgent.window">InsertionTimeList</a><T>> insertionTimeList()</pre> |
| </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/Policies.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/PartitionedState.html" title="class in org.apache.edgent.window"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/edgent/window/Window.html" title="interface 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/Policies.html" target="_top">Frames</a></li> |
| <li><a href="Policies.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> |
