| <!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 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>WindowManager (Storm 2.3.0 API)</title> |
| <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="WindowManager (Storm 2.3.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </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/WindowManager.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/storm/windowing/WindowLifecycleListener.html" title="interface in org.apache.storm.windowing"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/storm/windowing/WindowManager.html" target="_top">Frames</a></li> |
| <li><a href="WindowManager.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.storm.windowing</div> |
| <h2 title="Class WindowManager" class="title">Class WindowManager<T></h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://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.storm.windowing.WindowManager<T></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../org/apache/storm/windowing/TriggerHandler.html" title="interface in org.apache.storm.windowing">TriggerHandler</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/apache/storm/windowing/StatefulWindowManager.html" title="class in org.apache.storm.windowing">StatefulWindowManager</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">WindowManager<T></span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../org/apache/storm/windowing/TriggerHandler.html" title="interface in org.apache.storm.windowing">TriggerHandler</a></pre> |
| <div class="block"><p>Tracks a window of events and fires <a href="../../../../org/apache/storm/windowing/WindowLifecycleListener.html" title="interface in org.apache.storm.windowing"><code>WindowLifecycleListener</code></a> callbacks on expiry of events or activation of the window due to <a href="../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing"><code>TriggerPolicy</code></a>.</p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/storm/windowing/EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>,?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#evictionPolicy">evictionPolicy</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#EXPIRE_EVENTS_THRESHOLD">EXPIRE_EVENTS_THRESHOLD</a></span></code> |
| <div class="block">Expire old events every EXPIRE_EVENTS_THRESHOLD to keep the window size in check.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/storm/windowing/Event.html" title="interface in org.apache.storm.windowing">Event</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#queue">queue</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>,?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#triggerPolicy">triggerPolicy</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="../../../../org/apache/storm/windowing/WindowLifecycleListener.html" title="interface in org.apache.storm.windowing">WindowLifecycleListener</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#windowLifecycleListener">windowLifecycleListener</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== 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/storm/windowing/WindowManager.html#WindowManager-org.apache.storm.windowing.WindowLifecycleListener-">WindowManager</a></span>(<a href="../../../../org/apache/storm/windowing/WindowLifecycleListener.html" title="interface in org.apache.storm.windowing">WindowLifecycleListener</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>> lifecycleListener)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#WindowManager-org.apache.storm.windowing.WindowLifecycleListener-java.util.Collection-">WindowManager</a></span>(<a href="../../../../org/apache/storm/windowing/WindowLifecycleListener.html" title="interface in org.apache.storm.windowing">WindowLifecycleListener</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>> lifecycleListener, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/storm/windowing/Event.html" title="interface in org.apache.storm.windowing">Event</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>>> queue)</code> |
| <div class="block">Constructs a <a href="../../../../org/apache/storm/windowing/WindowManager.html" title="class in org.apache.storm.windowing"><code>WindowManager</code></a>.</div> |
| </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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#add-org.apache.storm.windowing.Event-">add</a></span>(<a href="../../../../org/apache/storm/windowing/Event.html" title="interface in org.apache.storm.windowing">Event</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>> windowEvent)</code> |
| <div class="block">Tracks a window event.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#add-T-">add</a></span>(<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a> event)</code> |
| <div class="block">Add an event into the window, with <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#currentTimeMillis--" title="class or interface in java.lang"><code>System.currentTimeMillis()</code></a> as the tracking ts.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#add-T-long-">add</a></span>(<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a> event, |
| long ts)</code> |
| <div class="block">Add an event into the window, with the given ts as the tracking ts.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#compactWindow--">compactWindow</a></span>()</code> |
| <div class="block">expires events that fall out of the window every EXPIRE_EVENTS_THRESHOLD so that the window does not grow too big.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#getEarliestEventTs-long-long-">getEarliestEventTs</a></span>(long startTs, |
| long endTs)</code> |
| <div class="block">Scans the event queue and returns the next earliest event ts between the startTs and endTs.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#getEventCount-long-">getEventCount</a></span>(long referenceTime)</code> |
| <div class="block">Scans the event queue and returns number of events having timestamp less than or equal to the reference time.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="https://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="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#getSlidingCountTimestamps-long-long-int-">getSlidingCountTimestamps</a></span>(long startTs, |
| long endTs, |
| int slidingCount)</code> |
| <div class="block">Scans the event queue and returns the list of event ts falling between startTs (exclusive) and endTs (inclusive) at each sliding interval counts.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><?>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#getState--">getState</a></span>()</code> </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/storm/windowing/WindowManager.html#onTrigger--">onTrigger</a></span>()</code> |
| <div class="block">The callback invoked by the trigger policy.</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/storm/windowing/WindowManager.html#restoreState-java.util.Map-">restoreState</a></span>(<a href="https://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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><?>> state)</code> </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/storm/windowing/WindowManager.html#setEvictionPolicy-org.apache.storm.windowing.EvictionPolicy-">setEvictionPolicy</a></span>(<a href="../../../../org/apache/storm/windowing/EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>,?> evictionPolicy)</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#setTriggerPolicy-org.apache.storm.windowing.TriggerPolicy-">setTriggerPolicy</a></span>(<a href="../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>,?> triggerPolicy)</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#shutdown--">shutdown</a></span>()</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/storm/windowing/WindowManager.html#toString--">toString</a></span>()</code> </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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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="https://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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="EXPIRE_EVENTS_THRESHOLD"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>EXPIRE_EVENTS_THRESHOLD</h4> |
| <pre>public static final int EXPIRE_EVENTS_THRESHOLD</pre> |
| <div class="block"><p>Expire old events every EXPIRE_EVENTS_THRESHOLD to keep the window size in check.</p><p><p>Note that if the eviction policy is based on watermarks, events will not be evicted until a new watermark would cause them to be considered expired anyway, regardless of this limit</p></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.storm.windowing.WindowManager.EXPIRE_EVENTS_THRESHOLD">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="queue"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queue</h4> |
| <pre>protected final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/storm/windowing/Event.html" title="interface in org.apache.storm.windowing">Event</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>>> queue</pre> |
| </li> |
| </ul> |
| <a name="windowLifecycleListener"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>windowLifecycleListener</h4> |
| <pre>protected final <a href="../../../../org/apache/storm/windowing/WindowLifecycleListener.html" title="interface in org.apache.storm.windowing">WindowLifecycleListener</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>> windowLifecycleListener</pre> |
| </li> |
| </ul> |
| <a name="evictionPolicy"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>evictionPolicy</h4> |
| <pre>protected <a href="../../../../org/apache/storm/windowing/EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>,?> evictionPolicy</pre> |
| </li> |
| </ul> |
| <a name="triggerPolicy"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>triggerPolicy</h4> |
| <pre>protected <a href="../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>,?> triggerPolicy</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="WindowManager-org.apache.storm.windowing.WindowLifecycleListener-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>WindowManager</h4> |
| <pre>public WindowManager(<a href="../../../../org/apache/storm/windowing/WindowLifecycleListener.html" title="interface in org.apache.storm.windowing">WindowLifecycleListener</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>> lifecycleListener)</pre> |
| </li> |
| </ul> |
| <a name="WindowManager-org.apache.storm.windowing.WindowLifecycleListener-java.util.Collection-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WindowManager</h4> |
| <pre>public WindowManager(<a href="../../../../org/apache/storm/windowing/WindowLifecycleListener.html" title="interface in org.apache.storm.windowing">WindowLifecycleListener</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>> lifecycleListener, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../org/apache/storm/windowing/Event.html" title="interface in org.apache.storm.windowing">Event</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>>> queue)</pre> |
| <div class="block"><p>Constructs a <a href="../../../../org/apache/storm/windowing/WindowManager.html" title="class in org.apache.storm.windowing"><code>WindowManager</code></a>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>lifecycleListener</code> - the <a href="../../../../org/apache/storm/windowing/WindowLifecycleListener.html" title="interface in org.apache.storm.windowing"><code>WindowLifecycleListener</code></a></dd> |
| <dd><code>queue</code> - a collection where the events in the window can be enqueued. <br/> <b>Note:</b> This collection has to be thread safe.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setEvictionPolicy-org.apache.storm.windowing.EvictionPolicy-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEvictionPolicy</h4> |
| <pre>public void setEvictionPolicy(<a href="../../../../org/apache/storm/windowing/EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>,?> evictionPolicy)</pre> |
| </li> |
| </ul> |
| <a name="setTriggerPolicy-org.apache.storm.windowing.TriggerPolicy-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTriggerPolicy</h4> |
| <pre>public void setTriggerPolicy(<a href="../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>,?> triggerPolicy)</pre> |
| </li> |
| </ul> |
| <a name="add-java.lang.Object-"> |
| <!-- --> |
| </a><a name="add-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre>public void add(<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a> event)</pre> |
| <div class="block"><p>Add an event into the window, with <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/System.html?is-external=true#currentTimeMillis--" title="class or interface in java.lang"><code>System.currentTimeMillis()</code></a> as the tracking ts.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the event to add</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="add-java.lang.Object-long-"> |
| <!-- --> |
| </a><a name="add-T-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre>public void add(<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a> event, |
| long ts)</pre> |
| <div class="block"><p>Add an event into the window, with the given ts as the tracking ts.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>event</code> - the event to track</dd> |
| <dd><code>ts</code> - the timestamp</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="add-org.apache.storm.windowing.Event-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>add</h4> |
| <pre>public void add(<a href="../../../../org/apache/storm/windowing/Event.html" title="interface in org.apache.storm.windowing">Event</a><<a href="../../../../org/apache/storm/windowing/WindowManager.html" title="type parameter in WindowManager">T</a>> windowEvent)</pre> |
| <div class="block"><p>Tracks a window event.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>windowEvent</code> - the window event to track</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="onTrigger--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>onTrigger</h4> |
| <pre>public boolean onTrigger()</pre> |
| <div class="block"><p>The callback invoked by the trigger policy.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/storm/windowing/TriggerHandler.html#onTrigger--">onTrigger</a></code> in interface <code><a href="../../../../org/apache/storm/windowing/TriggerHandler.html" title="interface in org.apache.storm.windowing">TriggerHandler</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the window was evaluated with at least one event in the window, false otherwise</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="shutdown--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shutdown</h4> |
| <pre>public void shutdown()</pre> |
| </li> |
| </ul> |
| <a name="compactWindow--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compactWindow</h4> |
| <pre>protected void compactWindow()</pre> |
| <div class="block"><p>expires events that fall out of the window every EXPIRE_EVENTS_THRESHOLD so that the window does not grow too big.</p></div> |
| </li> |
| </ul> |
| <a name="getEarliestEventTs-long-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEarliestEventTs</h4> |
| <pre>public long getEarliestEventTs(long startTs, |
| long endTs)</pre> |
| <div class="block"><p>Scans the event queue and returns the next earliest event ts between the startTs and endTs.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startTs</code> - the start ts (exclusive)</dd> |
| <dd><code>endTs</code> - the end ts (inclusive)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the earliest event ts between startTs and endTs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEventCount-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEventCount</h4> |
| <pre>public int getEventCount(long referenceTime)</pre> |
| <div class="block"><p>Scans the event queue and returns number of events having timestamp less than or equal to the reference time.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>referenceTime</code> - the reference timestamp in millis</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the count of events with timestamp less than or equal to referenceTime</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSlidingCountTimestamps-long-long-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSlidingCountTimestamps</h4> |
| <pre>public <a href="https://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="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</a>> getSlidingCountTimestamps(long startTs, |
| long endTs, |
| int slidingCount)</pre> |
| <div class="block"><p>Scans the event queue and returns the list of event ts falling between startTs (exclusive) and endTs (inclusive) at each sliding interval counts.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>startTs</code> - the start timestamp (exclusive)</dd> |
| <dd><code>endTs</code> - the end timestamp (inclusive)</dd> |
| <dd><code>slidingCount</code> - the sliding interval count</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of event ts</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="restoreState-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>restoreState</h4> |
| <pre>public void restoreState(<a href="https://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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><?>> state)</pre> |
| </li> |
| </ul> |
| <a name="getState--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getState</h4> |
| <pre>public <a href="https://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="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><?>> getState()</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/WindowManager.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 class="aboutLanguage"><script type="text/javascript" src="../../../../highlight.pack.js"></script> |
| <script type="text/javascript"><!-- |
| hljs.initHighlightingOnLoad(); |
| //--></script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/storm/windowing/WindowLifecycleListener.html" title="interface in org.apache.storm.windowing"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/storm/windowing/WindowManager.html" target="_top">Frames</a></li> |
| <li><a href="WindowManager.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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 © 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |