| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>WindowManager (Storm 2.6.2 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.storm.windowing, class: WindowManager"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <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="sub-nav-list"> |
| <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> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.storm.windowing</a></div> |
| <h1 title="Class WindowManager" class="title">Class WindowManager<T></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.storm.windowing.WindowManager<T></div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - the type of event in the window.</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="TriggerHandler.html" title="interface in org.apache.storm.windowing">TriggerHandler</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="StatefulWindowManager.html" title="class in org.apache.storm.windowing">StatefulWindowManager</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">WindowManager<T></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="TriggerHandler.html" title="interface in org.apache.storm.windowing">TriggerHandler</a></span></div> |
| <div class="block">Tracks a window of events and fires <a href="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="TriggerPolicy.html" title="interface in org.apache.storm.windowing"><code>TriggerPolicy</code></a>.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected <a href="EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>,<wbr>?></code></div> |
| <div class="col-second even-row-color"><code><a href="#evictionPolicy" class="member-name-link">evictionPolicy</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#EXPIRE_EVENTS_THRESHOLD" class="member-name-link">EXPIRE_EVENTS_THRESHOLD</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Expire old events every EXPIRE_EVENTS_THRESHOLD to keep the window size in check.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="Event.html" title="interface in org.apache.storm.windowing">Event</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>>></code></div> |
| <div class="col-second even-row-color"><code><a href="#queue" class="member-name-link">queue</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected <a href="TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>,<wbr>?></code></div> |
| <div class="col-second odd-row-color"><code><a href="#triggerPolicy" class="member-name-link">triggerPolicy</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected final <a href="WindowLifecycleListener.html" title="interface in org.apache.storm.windowing">WindowLifecycleListener</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#windowLifecycleListener" class="member-name-link">windowLifecycleListener</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.storm.windowing.WindowLifecycleListener)" class="member-name-link">WindowManager</a><wbr>(<a href="WindowLifecycleListener.html" title="interface in org.apache.storm.windowing">WindowLifecycleListener</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>> lifecycleListener)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.storm.windowing.WindowLifecycleListener,java.util.Collection)" class="member-name-link">WindowManager</a><wbr>(<a href="WindowLifecycleListener.html" title="interface in org.apache.storm.windowing">WindowLifecycleListener</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>> lifecycleListener, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="Event.html" title="interface in org.apache.storm.windowing">Event</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>>> queue)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Constructs a <a href="WindowManager.html" title="class in org.apache.storm.windowing"><code>WindowManager</code></a>.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(org.apache.storm.windowing.Event)" class="member-name-link">add</a><wbr>(<a href="Event.html" title="interface in org.apache.storm.windowing">Event</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>> windowEvent)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Tracks a window event.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(T)" class="member-name-link">add</a><wbr>(<a href="WindowManager.html" title="type parameter in WindowManager">T</a> event)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add an event into the window, with <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#currentTimeMillis()" title="class or interface in java.lang" class="external-link"><code>System.currentTimeMillis()</code></a> as the tracking ts.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(T,long)" class="member-name-link">add</a><wbr>(<a href="WindowManager.html" title="type parameter in WindowManager">T</a> event, |
| long ts)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add an event into the window, with the given ts as the tracking ts.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#compactWindow()" class="member-name-link">compactWindow</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEarliestEventTs(long,long)" class="member-name-link">getEarliestEventTs</a><wbr>(long startTs, |
| long endTs)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Scans the event queue and returns the next earliest event ts between the startTs and endTs.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEventCount(long)" class="member-name-link">getEventCount</a><wbr>(long referenceTime)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Scans the event queue and returns number of events having timestamp less than or equal to the reference time.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSlidingCountTimestamps(long,long,int)" class="member-name-link">getSlidingCountTimestamps</a><wbr>(long startTs, |
| long endTs, |
| int slidingCount)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><?>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getState()" class="member-name-link">getState</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onTrigger()" class="member-name-link">onTrigger</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The callback invoked by the trigger policy.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#restoreState(java.util.Map)" class="member-name-link">restoreState</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><?>> state)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEvictionPolicy(org.apache.storm.windowing.EvictionPolicy)" class="member-name-link">setEvictionPolicy</a><wbr>(<a href="EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>,<wbr>?> evictionPolicy)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTriggerPolicy(org.apache.storm.windowing.TriggerPolicy)" class="member-name-link">setTriggerPolicy</a><wbr>(<a href="TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>,<wbr>?> triggerPolicy)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shutdown()" class="member-name-link">shutdown</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="EXPIRE_EVENTS_THRESHOLD"> |
| <h3>EXPIRE_EVENTS_THRESHOLD</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">EXPIRE_EVENTS_THRESHOLD</span></div> |
| <div class="block">Expire old events every EXPIRE_EVENTS_THRESHOLD to keep the window size in check. |
| |
| <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</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../constant-values.html#org.apache.storm.windowing.WindowManager.EXPIRE_EVENTS_THRESHOLD">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="queue"> |
| <h3>queue</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="Event.html" title="interface in org.apache.storm.windowing">Event</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>>></span> <span class="element-name">queue</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="windowLifecycleListener"> |
| <h3>windowLifecycleListener</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="WindowLifecycleListener.html" title="interface in org.apache.storm.windowing">WindowLifecycleListener</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>></span> <span class="element-name">windowLifecycleListener</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="evictionPolicy"> |
| <h3>evictionPolicy</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>,<wbr>?></span> <span class="element-name">evictionPolicy</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="triggerPolicy"> |
| <h3>triggerPolicy</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>,<wbr>?></span> <span class="element-name">triggerPolicy</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.storm.windowing.WindowLifecycleListener)"> |
| <h3>WindowManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">WindowManager</span><wbr><span class="parameters">(<a href="WindowLifecycleListener.html" title="interface in org.apache.storm.windowing">WindowLifecycleListener</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>> lifecycleListener)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.storm.windowing.WindowLifecycleListener,java.util.Collection)"> |
| <h3>WindowManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">WindowManager</span><wbr><span class="parameters">(<a href="WindowLifecycleListener.html" title="interface in org.apache.storm.windowing">WindowLifecycleListener</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>> lifecycleListener, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="Event.html" title="interface in org.apache.storm.windowing">Event</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>>> queue)</span></div> |
| <div class="block">Constructs a <a href="WindowManager.html" title="class in org.apache.storm.windowing"><code>WindowManager</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>lifecycleListener</code> - the <a href="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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setEvictionPolicy(org.apache.storm.windowing.EvictionPolicy)"> |
| <h3>setEvictionPolicy</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setEvictionPolicy</span><wbr><span class="parameters">(<a href="EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>,<wbr>?> evictionPolicy)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTriggerPolicy(org.apache.storm.windowing.TriggerPolicy)"> |
| <h3>setTriggerPolicy</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setTriggerPolicy</span><wbr><span class="parameters">(<a href="TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>,<wbr>?> triggerPolicy)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(T)"> |
| <h3 id="add(java.lang.Object)">add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="WindowManager.html" title="type parameter in WindowManager">T</a> event)</span></div> |
| <div class="block">Add an event into the window, with <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html#currentTimeMillis()" title="class or interface in java.lang" class="external-link"><code>System.currentTimeMillis()</code></a> as the tracking ts.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - the event to add</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(T,long)"> |
| <h3 id="add(java.lang.Object,long)">add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="WindowManager.html" title="type parameter in WindowManager">T</a> event, |
| long ts)</span></div> |
| <div class="block">Add an event into the window, with the given ts as the tracking ts.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - the event to track</dd> |
| <dd><code>ts</code> - the timestamp</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(org.apache.storm.windowing.Event)"> |
| <h3>add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="Event.html" title="interface in org.apache.storm.windowing">Event</a><<a href="WindowManager.html" title="type parameter in WindowManager">T</a>> windowEvent)</span></div> |
| <div class="block">Tracks a window event.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>windowEvent</code> - the window event to track</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="onTrigger()"> |
| <h3>onTrigger</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">onTrigger</span>()</div> |
| <div class="block">The callback invoked by the trigger policy.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="TriggerHandler.html#onTrigger()">onTrigger</a></code> in interface <code><a href="TriggerHandler.html" title="interface in org.apache.storm.windowing">TriggerHandler</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>true if the window was evaluated with at least one event in the window, false otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="shutdown()"> |
| <h3>shutdown</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">shutdown</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="compactWindow()"> |
| <h3>compactWindow</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name">compactWindow</span>()</div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEarliestEventTs(long,long)"> |
| <h3>getEarliestEventTs</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getEarliestEventTs</span><wbr><span class="parameters">(long startTs, |
| long endTs)</span></div> |
| <div class="block">Scans the event queue and returns the next earliest event ts between the startTs and endTs.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>startTs</code> - the start ts (exclusive)</dd> |
| <dd><code>endTs</code> - the end ts (inclusive)</dd> |
| <dt>Returns:</dt> |
| <dd>the earliest event ts between startTs and endTs</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEventCount(long)"> |
| <h3>getEventCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getEventCount</span><wbr><span class="parameters">(long referenceTime)</span></div> |
| <div class="block">Scans the event queue and returns number of events having timestamp less than or equal to the reference time.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>referenceTime</code> - the reference timestamp in millis</dd> |
| <dt>Returns:</dt> |
| <dd>the count of events with timestamp less than or equal to referenceTime</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSlidingCountTimestamps(long,long,int)"> |
| <h3>getSlidingCountTimestamps</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></span> <span class="element-name">getSlidingCountTimestamps</span><wbr><span class="parameters">(long startTs, |
| long endTs, |
| int slidingCount)</span></div> |
| <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> |
| <dl class="notes"> |
| <dt>Parameters:</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>Returns:</dt> |
| <dd>the list of event ts</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="restoreState(java.util.Map)"> |
| <h3>restoreState</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">restoreState</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><?>> state)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getState()"> |
| <h3>getState</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><?>></span> <span class="element-name">getState</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
