Google Git
Sign in
apache / incubator-heron / refs/heads/asf-site / . / content / api / java / org / apache / heron / api / windowing / WindowManager.html
blob: d0ab274691e671ef1674b8a4cfb16bb4180fe1ec [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.18) on Wed Mar 01 02:01:42 GMT 2023 -->
<title>WindowManager (Heron Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2023-03-01">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/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="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="WindowManager (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"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";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.heron.api.windowing</a></div>
<h2 title="Class WindowManager" class="title">Class WindowManager&lt;T extends java.io.Serializable&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.heron.api.windowing.WindowManager&lt;T&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - the type of event in the window.</dd>
</dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="TriggerHandler.html" title="interface in org.apache.heron.api.windowing">TriggerHandler</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">WindowManager&lt;T extends java.io.Serializable&gt;</span>
extends java.lang.Object
implements <a href="TriggerHandler.html" title="interface in org.apache.heron.api.windowing">TriggerHandler</a></pre>
<div class="block">Tracks a window of events and fires <a href="WindowLifecycleListener.html" title="interface in org.apache.heron.api.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.heron.api.windowing"><code>TriggerPolicy</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a>,&#8203;?&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#evictionPolicy">evictionPolicy</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#EXPIRE_EVENTS_THRESHOLD">EXPIRE_EVENTS_THRESHOLD</a></span></code></th>
<td class="colLast">
<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 java.util.Collection&lt;<a href="Event.html" title="interface in org.apache.heron.api.windowing">Event</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a>&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queue">queue</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="TriggerPolicy.html" title="interface in org.apache.heron.api.windowing">TriggerPolicy</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a>,&#8203;?&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#triggerPolicy">triggerPolicy</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="WindowLifecycleListener.html" title="interface in org.apache.heron.api.windowing">WindowLifecycleListener</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#windowLifecycleListener">windowLifecycleListener</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.heron.api.windowing.WindowLifecycleListener)">WindowManager</a></span>&#8203;(<a href="WindowLifecycleListener.html" title="interface in org.apache.heron.api.windowing">WindowLifecycleListener</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a>&gt;&nbsp;lifecycleListener)</code></th>
<td class="colLast">
<div class="block">For testing purpose
See <a href="WindowManagerTest.html" title="class in org.apache.heron.api.windowing"><code>WindowManagerTest</code></a></div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.heron.api.windowing.WindowLifecycleListener,java.util.Collection)">WindowManager</a></span>&#8203;(<a href="WindowLifecycleListener.html" title="interface in org.apache.heron.api.windowing">WindowLifecycleListener</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a>&gt;&nbsp;lifecycleListener,
java.util.Collection&lt;<a href="Event.html" title="interface in org.apache.heron.api.windowing">Event</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a>&gt;&gt;&nbsp;queue)</code></th>
<td class="colLast">
<div class="block">Constructs a <a href="WindowManager.html" title="class in org.apache.heron.api.windowing"><code>WindowManager</code></a></div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(org.apache.heron.api.windowing.Event)">add</a></span>&#8203;(<a href="Event.html" title="interface in org.apache.heron.api.windowing">Event</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a>&gt;&nbsp;windowEvent)</code></th>
<td class="colLast">
<div class="block">Tracks a window event</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(T)">add</a></span>&#8203;(<a href="WindowManager.html" title="type parameter in WindowManager">T</a>&nbsp;event)</code></th>
<td class="colLast">
<div class="block">Add an event into the window, with <code>System.currentTimeMillis()</code> as
the tracking ts.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(T,long)">add</a></span>&#8203;(<a href="WindowManager.html" title="type parameter in WindowManager">T</a>&nbsp;event,
long&nbsp;ts)</code></th>
<td class="colLast">
<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>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compactWindow()">compactWindow</a></span>()</code></th>
<td class="colLast">
<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>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEarliestEventTs(long,long)">getEarliestEventTs</a></span>&#8203;(long&nbsp;startTs,
long&nbsp;endTs)</code></th>
<td class="colLast">
<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>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEventCount(long)">getEventCount</a></span>&#8203;(long&nbsp;referenceTime)</code></th>
<td class="colLast">
<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>java.util.List&lt;java.lang.Long&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSlidingCountTimestamps(long,long,int)">getSlidingCountTimestamps</a></span>&#8203;(long&nbsp;startTs,
long&nbsp;endTs,
int&nbsp;slidingCount)</code></th>
<td class="colLast">
<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>java.util.Map&lt;java.lang.String,&#8203;java.io.Serializable&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getState()">getState</a></span>()</code></th>
<td class="colLast">
<div class="block">Get the state of the window manager</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onTrigger()">onTrigger</a></span>()</code></th>
<td class="colLast">
<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>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#restoreState(java.util.Map)">restoreState</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.io.Serializable&gt;&nbsp;state)</code></th>
<td class="colLast">
<div class="block">Restore state associated with the window manager</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEvictionPolicy(org.apache.heron.api.windowing.EvictionPolicy)">setEvictionPolicy</a></span>&#8203;(<a href="EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a>,&#8203;?&gt;&nbsp;evictionPolicy)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTriggerPolicy(org.apache.heron.api.windowing.TriggerPolicy)">setTriggerPolicy</a></span>&#8203;(<a href="TriggerPolicy.html" title="interface in org.apache.heron.api.windowing">TriggerPolicy</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a>,&#8203;?&gt;&nbsp;triggerPolicy)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shutdown()">shutdown</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="EXPIRE_EVENTS_THRESHOLD">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EXPIRE_EVENTS_THRESHOLD</h4>
<pre>public static final&nbsp;int EXPIRE_EVENTS_THRESHOLD</pre>
<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>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.heron.api.windowing.WindowManager.EXPIRE_EVENTS_THRESHOLD">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="queue">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>queue</h4>
<pre>protected final&nbsp;java.util.Collection&lt;<a href="Event.html" title="interface in org.apache.heron.api.windowing">Event</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a> extends java.io.Serializable&gt;&gt; queue</pre>
</li>
</ul>
<a id="evictionPolicy">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>evictionPolicy</h4>
<pre>protected&nbsp;<a href="EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a> extends java.io.Serializable,&#8203;?&gt; evictionPolicy</pre>
</li>
</ul>
<a id="triggerPolicy">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>triggerPolicy</h4>
<pre>protected&nbsp;<a href="TriggerPolicy.html" title="interface in org.apache.heron.api.windowing">TriggerPolicy</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a> extends java.io.Serializable,&#8203;?&gt; triggerPolicy</pre>
</li>
</ul>
<a id="windowLifecycleListener">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>windowLifecycleListener</h4>
<pre>protected final&nbsp;<a href="WindowLifecycleListener.html" title="interface in org.apache.heron.api.windowing">WindowLifecycleListener</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a> extends java.io.Serializable&gt; windowLifecycleListener</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.heron.api.windowing.WindowLifecycleListener,java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WindowManager</h4>
<pre>public&nbsp;WindowManager&#8203;(<a href="WindowLifecycleListener.html" title="interface in org.apache.heron.api.windowing">WindowLifecycleListener</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a>&gt;&nbsp;lifecycleListener,
java.util.Collection&lt;<a href="Event.html" title="interface in org.apache.heron.api.windowing">Event</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a>&gt;&gt;&nbsp;queue)</pre>
<div class="block">Constructs a <a href="WindowManager.html" title="class in org.apache.heron.api.windowing"><code>WindowManager</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lifecycleListener</code> - the <a href="WindowLifecycleListener.html" title="interface in org.apache.heron.api.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>
<a id="&lt;init&gt;(org.apache.heron.api.windowing.WindowLifecycleListener)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WindowManager</h4>
<pre>public&nbsp;WindowManager&#8203;(<a href="WindowLifecycleListener.html" title="interface in org.apache.heron.api.windowing">WindowLifecycleListener</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a>&gt;&nbsp;lifecycleListener)</pre>
<div class="block">For testing purpose
See <a href="WindowManagerTest.html" title="class in org.apache.heron.api.windowing"><code>WindowManagerTest</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lifecycleListener</code> - </dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="setEvictionPolicy(org.apache.heron.api.windowing.EvictionPolicy)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEvictionPolicy</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setEvictionPolicy&#8203;(<a href="EvictionPolicy.html" title="interface in org.apache.heron.api.windowing">EvictionPolicy</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a>,&#8203;?&gt;&nbsp;evictionPolicy)</pre>
</li>
</ul>
<a id="setTriggerPolicy(org.apache.heron.api.windowing.TriggerPolicy)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTriggerPolicy</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setTriggerPolicy&#8203;(<a href="TriggerPolicy.html" title="interface in org.apache.heron.api.windowing">TriggerPolicy</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a>,&#8203;?&gt;&nbsp;triggerPolicy)</pre>
</li>
</ul>
<a id="add(java.io.Serializable)">
<!-- -->
</a><a id="add(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;add&#8203;(<a href="WindowManager.html" title="type parameter in WindowManager">T</a>&nbsp;event)</pre>
<div class="block">Add an event into the window, with <code>System.currentTimeMillis()</code> as
the tracking ts.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - the event to add</dd>
</dl>
</li>
</ul>
<a id="add(java.io.Serializable,long)">
<!-- -->
</a><a id="add(T,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;add&#8203;(<a href="WindowManager.html" title="type parameter in WindowManager">T</a>&nbsp;event,
long&nbsp;ts)</pre>
<div class="block">Add an event into the window, with the given ts as the tracking ts.</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 id="add(org.apache.heron.api.windowing.Event)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;add&#8203;(<a href="Event.html" title="interface in org.apache.heron.api.windowing">Event</a>&lt;<a href="WindowManager.html" title="type parameter in WindowManager">T</a>&gt;&nbsp;windowEvent)</pre>
<div class="block">Tracks a window event</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>windowEvent</code> - the window event to track</dd>
</dl>
</li>
</ul>
<a id="onTrigger()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onTrigger</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;onTrigger()</pre>
<div class="block">The callback invoked by the trigger policy.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="TriggerHandler.html#onTrigger()">onTrigger</a></code>&nbsp;in interface&nbsp;<code><a href="TriggerHandler.html" title="interface in org.apache.heron.api.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 id="shutdown()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shutdown</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;shutdown()</pre>
</li>
</ul>
<a id="compactWindow()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compactWindow</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;compactWindow()</pre>
<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>
</li>
</ul>
<a id="getEarliestEventTs(long,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEarliestEventTs</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getEarliestEventTs&#8203;(long&nbsp;startTs,
long&nbsp;endTs)</pre>
<div class="block">Scans the event queue and returns the next earliest event ts
between the startTs and endTs</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 id="getEventCount(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventCount</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getEventCount&#8203;(long&nbsp;referenceTime)</pre>
<div class="block">Scans the event queue and returns number of events having
timestamp less than or equal to the reference time.</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 id="getSlidingCountTimestamps(long,long,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSlidingCountTimestamps</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;java.lang.Long&gt;&nbsp;getSlidingCountTimestamps&#8203;(long&nbsp;startTs,
long&nbsp;endTs,
int&nbsp;slidingCount)</pre>
<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>
<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 id="toString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="restoreState(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>restoreState</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;restoreState&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.io.Serializable&gt;&nbsp;state)</pre>
<div class="block">Restore state associated with the window manager</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>state</code> - </dd>
</dl>
</li>
</ul>
<a id="getState()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getState</h4>
<pre class="methodSignature">public&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.io.Serializable&gt;&nbsp;getState()</pre>
<div class="block">Get the state of the window manager</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Map representing the state of the window manager</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>