| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>WatermarkTimeEvictionPolicy (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: WatermarkTimeEvictionPolicy"> |
| <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/WatermarkTimeEvictionPolicy.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><a href="#nested-class-summary">Nested</a> | </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>Field | </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 WatermarkTimeEvictionPolicy" class="title">Class WatermarkTimeEvictionPolicy<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"><a href="TimeEvictionPolicy.html" title="class in org.apache.storm.windowing">org.apache.storm.windowing.TimeEvictionPolicy</a><T> |
| <div class="inheritance">org.apache.storm.windowing.WatermarkTimeEvictionPolicy<T></div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a><T,<wbr><a href="EvictionContext.html" title="interface in org.apache.storm.windowing">EvictionContext</a>></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">WatermarkTimeEvictionPolicy<T></span> |
| <span class="extends-implements">extends <a href="TimeEvictionPolicy.html" title="class in org.apache.storm.windowing">TimeEvictionPolicy</a><T></span></div> |
| <div class="block">An eviction policy that evicts events based on time duration taking watermark time and event lag into account.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.storm.windowing.EvictionPolicy">Nested classes/interfaces inherited from interface org.apache.storm.windowing.<a href="EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a></h2> |
| <code><a href="EvictionPolicy.Action.html" title="enum in org.apache.storm.windowing">EvictionPolicy.Action</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.storm.windowing.TimeEvictionPolicy">Fields inherited from class org.apache.storm.windowing.<a href="TimeEvictionPolicy.html" title="class in org.apache.storm.windowing">TimeEvictionPolicy</a></h3> |
| <code><a href="TimeEvictionPolicy.html#evictionContext">evictionContext</a></code></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(int)" class="member-name-link">WatermarkTimeEvictionPolicy</a><wbr>(int windowLength)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructs a WatermarkTimeEvictionPolicy that evicts events older than the given window length in millis.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int,int)" class="member-name-link">WatermarkTimeEvictionPolicy</a><wbr>(int windowLength, |
| int lag)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Constructs a WatermarkTimeEvictionPolicy that evicts events older than the given window length in millis.</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><a href="EvictionPolicy.Action.html" title="enum in org.apache.storm.windowing">EvictionPolicy.Action</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#evict(org.apache.storm.windowing.Event)" class="member-name-link">evict</a><wbr>(<a href="Event.html" title="interface in org.apache.storm.windowing">Event</a><<a href="WatermarkTimeEvictionPolicy.html" title="type parameter in WatermarkTimeEvictionPolicy">T</a>> event)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Decides if an event should be expired from the window, processed in the current window or kept for later processing.</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/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-org.apache.storm.windowing.TimeEvictionPolicy">Methods inherited from class org.apache.storm.windowing.<a href="TimeEvictionPolicy.html" title="class in org.apache.storm.windowing">TimeEvictionPolicy</a></h3> |
| <code><a href="TimeEvictionPolicy.html#getContext()">getContext</a>, <a href="TimeEvictionPolicy.html#getState()">getState</a>, <a href="TimeEvictionPolicy.html#reset()">reset</a>, <a href="TimeEvictionPolicy.html#restoreState(org.apache.storm.windowing.EvictionContext)">restoreState</a>, <a href="TimeEvictionPolicy.html#setContext(org.apache.storm.windowing.EvictionContext)">setContext</a>, <a href="TimeEvictionPolicy.html#track(org.apache.storm.windowing.Event)">track</a></code></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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(int)"> |
| <h3>WatermarkTimeEvictionPolicy</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">WatermarkTimeEvictionPolicy</span><wbr><span class="parameters">(int windowLength)</span></div> |
| <div class="block">Constructs a WatermarkTimeEvictionPolicy that evicts events older than the given window length in millis.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>windowLength</code> - the window length in milliseconds</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(int,int)"> |
| <h3>WatermarkTimeEvictionPolicy</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">WatermarkTimeEvictionPolicy</span><wbr><span class="parameters">(int windowLength, |
| int lag)</span></div> |
| <div class="block">Constructs a WatermarkTimeEvictionPolicy that evicts events older than the given window length in millis. The lag parameter can be |
| used in the case of event based ts to break the queue scan early.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>windowLength</code> - the window length in milliseconds</dd> |
| <dd><code>lag</code> - the max event lag in milliseconds</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="evict(org.apache.storm.windowing.Event)"> |
| <h3>evict</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="EvictionPolicy.Action.html" title="enum in org.apache.storm.windowing">EvictionPolicy.Action</a></span> <span class="element-name">evict</span><wbr><span class="parameters">(<a href="Event.html" title="interface in org.apache.storm.windowing">Event</a><<a href="WatermarkTimeEvictionPolicy.html" title="type parameter in WatermarkTimeEvictionPolicy">T</a>> event)</span></div> |
| <div class="block">Decides if an event should be expired from the window, processed in the current window or kept for later processing. |
| <p/> |
| Keeps events with future ts in the queue for processing in the next window. If the ts difference is more than the lag, stops scanning |
| the queue for the current window.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="EvictionPolicy.html#evict(org.apache.storm.windowing.Event)">evict</a></code> in interface <code><a href="EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a><<a href="WatermarkTimeEvictionPolicy.html" title="type parameter in WatermarkTimeEvictionPolicy">T</a>,<wbr><a href="EvictionContext.html" title="interface in org.apache.storm.windowing">EvictionContext</a>></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="TimeEvictionPolicy.html#evict(org.apache.storm.windowing.Event)">evict</a></code> in class <code><a href="TimeEvictionPolicy.html" title="class in org.apache.storm.windowing">TimeEvictionPolicy</a><<a href="WatermarkTimeEvictionPolicy.html" title="type parameter in WatermarkTimeEvictionPolicy">T</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - the input event</dd> |
| <dt>Returns:</dt> |
| <dd>the <a href="EvictionPolicy.Action.html" title="enum in org.apache.storm.windowing"><code>EvictionPolicy.Action</code></a> to be taken based on the input event</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="TimeEvictionPolicy.html#toString()">toString</a></code> in class <code><a href="TimeEvictionPolicy.html" title="class in org.apache.storm.windowing">TimeEvictionPolicy</a><<a href="WatermarkTimeEvictionPolicy.html" title="type parameter in WatermarkTimeEvictionPolicy">T</a>></code></dd> |
| </dl> |
| </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> |
