| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>EvictionPolicy (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, interface: EvictionPolicy"> |
| <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/EvictionPolicy.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface EvictionPolicy" class="title">Interface EvictionPolicy<T,<wbr>S></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - the type of event that is tracked.</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="CountEvictionPolicy.html" title="class in org.apache.storm.windowing">CountEvictionPolicy</a></code>, <code><a href="TimeEvictionPolicy.html" title="class in org.apache.storm.windowing">TimeEvictionPolicy</a></code>, <code><a href="WatermarkCountEvictionPolicy.html" title="class in org.apache.storm.windowing">WatermarkCountEvictionPolicy</a></code>, <code><a href="WatermarkTimeEvictionPolicy.html" title="class in org.apache.storm.windowing">WatermarkTimeEvictionPolicy</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">EvictionPolicy<T,<wbr>S></span></div> |
| <div class="block">Eviction policy tracks events and decides whether an event should be evicted from the window or not.</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="caption"><span>Nested Classes</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">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static enum </code></div> |
| <div class="col-second even-row-color"><code><a href="EvictionPolicy.Action.html" class="type-name-link" title="enum in org.apache.storm.windowing">EvictionPolicy.Action</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The action to be taken when <a href="#evict(org.apache.storm.windowing.Event)"><code>evict(Event)</code></a> is invoked.</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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><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-tab3"><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="EvictionPolicy.html" title="type parameter in EvictionPolicy">T</a>> event)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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-tab3"><code><a href="EvictionContext.html" title="interface in org.apache.storm.windowing">EvictionContext</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getContext()" class="member-name-link">getContext</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the current context that is part of this eviction policy.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="EvictionPolicy.html" title="type parameter in EvictionPolicy">S</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getState()" class="member-name-link">getState</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return runtime state to be checkpointed by the framework for restoring the eviction policy in case of failures.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#reset()" class="member-name-link">reset</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Resets the eviction policy.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#restoreState(S)" class="member-name-link">restoreState</a><wbr>(<a href="EvictionPolicy.html" title="type parameter in EvictionPolicy">S</a> state)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Restore the eviction policy from the state that was earlier checkpointed by the framework.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setContext(org.apache.storm.windowing.EvictionContext)" class="member-name-link">setContext</a><wbr>(<a href="EvictionContext.html" title="interface in org.apache.storm.windowing">EvictionContext</a> context)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Sets a context in the eviction policy that can be used while evicting the events.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#track(org.apache.storm.windowing.Event)" class="member-name-link">track</a><wbr>(<a href="Event.html" title="interface in org.apache.storm.windowing">Event</a><<a href="EvictionPolicy.html" title="type parameter in EvictionPolicy">T</a>> event)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Tracks the event to later decide whether <a href="#evict(org.apache.storm.windowing.Event)"><code>evict(Event)</code></a> should evict it or not.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ 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="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="EvictionPolicy.html" title="type parameter in EvictionPolicy">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.</div> |
| <dl class="notes"> |
| <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="track(org.apache.storm.windowing.Event)"> |
| <h3>track</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">track</span><wbr><span class="parameters">(<a href="Event.html" title="interface in org.apache.storm.windowing">Event</a><<a href="EvictionPolicy.html" title="type parameter in EvictionPolicy">T</a>> event)</span></div> |
| <div class="block">Tracks the event to later decide whether <a href="#evict(org.apache.storm.windowing.Event)"><code>evict(Event)</code></a> should evict it or not.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>event</code> - the input event to be tracked</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getContext()"> |
| <h3>getContext</h3> |
| <div class="member-signature"><span class="return-type"><a href="EvictionContext.html" title="interface in org.apache.storm.windowing">EvictionContext</a></span> <span class="element-name">getContext</span>()</div> |
| <div class="block">Returns the current context that is part of this eviction policy.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the eviction context</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setContext(org.apache.storm.windowing.EvictionContext)"> |
| <h3>setContext</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setContext</span><wbr><span class="parameters">(<a href="EvictionContext.html" title="interface in org.apache.storm.windowing">EvictionContext</a> context)</span></div> |
| <div class="block">Sets a context in the eviction policy that can be used while evicting the events. E.g. For TimeEvictionPolicy, this could be used to |
| set the reference timestamp.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>context</code> - the eviction context</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reset()"> |
| <h3>reset</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">reset</span>()</div> |
| <div class="block">Resets the eviction policy.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getState()"> |
| <h3>getState</h3> |
| <div class="member-signature"><span class="return-type"><a href="EvictionPolicy.html" title="type parameter in EvictionPolicy">S</a></span> <span class="element-name">getState</span>()</div> |
| <div class="block">Return runtime state to be checkpointed by the framework for restoring the eviction policy in case of failures.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the state</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="restoreState(S)"> |
| <h3 id="restoreState(java.lang.Object)">restoreState</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">restoreState</span><wbr><span class="parameters">(<a href="EvictionPolicy.html" title="type parameter in EvictionPolicy">S</a> state)</span></div> |
| <div class="block">Restore the eviction policy from the state that was earlier checkpointed by the framework.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>state</code> - the state</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> |
