| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>org.apache.storm.windowing (Storm 2.4.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.storm.windowing (Storm 2.4.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/storm/validation/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/apache/storm/windowing/persistence/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/storm/windowing/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.storm.windowing</h1> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/Event.html" title="interface in org.apache.storm.windowing">Event</a><T></td> |
| <td class="colLast"> |
| <div class="block">An event is a wrapper object that gets stored in the window.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/EvictionContext.html" title="interface in org.apache.storm.windowing">EvictionContext</a></td> |
| <td class="colLast"> |
| <div class="block">Context information that can be used by the eviction policy.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/EvictionPolicy.html" title="interface in org.apache.storm.windowing">EvictionPolicy</a><T,S></td> |
| <td class="colLast"> |
| <div class="block">Eviction policy tracks events and decides whether an event should be evicted from the window or not.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a></td> |
| <td class="colLast"> |
| <div class="block">Interface to be implemented for extracting timestamp from a tuple.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/TriggerHandler.html" title="interface in org.apache.storm.windowing">TriggerHandler</a></td> |
| <td class="colLast"> |
| <div class="block">The callback fired by <a href="../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing"><code>TriggerPolicy</code></a> when the trigger condition is satisfied.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing">TriggerPolicy</a><T,S></td> |
| <td class="colLast"> |
| <div class="block">Triggers the window calculations based on the policy.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/TupleWindow.html" title="interface in org.apache.storm.windowing">TupleWindow</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../../../org/apache/storm/windowing/Window.html" title="interface in org.apache.storm.windowing"><code>Window</code></a> that contains <a href="../../../../org/apache/storm/tuple/Tuple.html" title="interface in org.apache.storm.tuple"><code>Tuple</code></a> objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/Window.html" title="interface in org.apache.storm.windowing">Window</a><T></td> |
| <td class="colLast"> |
| <div class="block">A view of events in a sliding window.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/WindowLifecycleListener.html" title="interface in org.apache.storm.windowing">WindowLifecycleListener</a><T></td> |
| <td class="colLast"> |
| <div class="block">A callback for expiry, activation of events tracked by the <a href="../../../../org/apache/storm/windowing/WindowManager.html" title="class in org.apache.storm.windowing"><code>WindowManager</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/CountEvictionPolicy.html" title="class in org.apache.storm.windowing">CountEvictionPolicy</a><T></td> |
| <td class="colLast"> |
| <div class="block">An eviction policy that tracks event counts and can evict based on a threshold count.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/CountTriggerPolicy.html" title="class in org.apache.storm.windowing">CountTriggerPolicy</a><T></td> |
| <td class="colLast"> |
| <div class="block">A trigger that tracks event counts and calls back <a href="../../../../org/apache/storm/windowing/TriggerHandler.html#onTrigger--"><code>TriggerHandler.onTrigger()</code></a> when the count threshold is hit.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/DefaultEvictionContext.html" title="class in org.apache.storm.windowing">DefaultEvictionContext</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/EventImpl.html" title="class in org.apache.storm.windowing">EventImpl</a><T></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/StatefulWindowManager.html" title="class in org.apache.storm.windowing">StatefulWindowManager</a><T></td> |
| <td class="colLast"> |
| <div class="block">Window manager that handles windows with state persistence.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/TimeEvictionPolicy.html" title="class in org.apache.storm.windowing">TimeEvictionPolicy</a><T></td> |
| <td class="colLast"> |
| <div class="block">Eviction policy that evicts events based on time duration.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/TimeTriggerPolicy.html" title="class in org.apache.storm.windowing">TimeTriggerPolicy</a><T></td> |
| <td class="colLast"> |
| <div class="block">Invokes <a href="../../../../org/apache/storm/windowing/TriggerHandler.html#onTrigger--"><code>TriggerHandler.onTrigger()</code></a> after the duration.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/TupleWindowImpl.html" title="class in org.apache.storm.windowing">TupleWindowImpl</a></td> |
| <td class="colLast"> |
| <div class="block">Holds the expired, new and current tuples in a window.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/TupleWindowIterImpl.html" title="class in org.apache.storm.windowing">TupleWindowIterImpl</a></td> |
| <td class="colLast"> |
| <div class="block">An iterator based implementation over the events in a window.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/WatermarkCountEvictionPolicy.html" title="class in org.apache.storm.windowing">WatermarkCountEvictionPolicy</a><T></td> |
| <td class="colLast"> |
| <div class="block">An eviction policy that tracks count based on watermark ts and evicts events up to the watermark based on a threshold count.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/WatermarkCountTriggerPolicy.html" title="class in org.apache.storm.windowing">WatermarkCountTriggerPolicy</a><T></td> |
| <td class="colLast"> |
| <div class="block">A trigger policy that tracks event counts and sets the context for eviction policy to evict based on latest watermark time.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/WaterMarkEvent.html" title="class in org.apache.storm.windowing">WaterMarkEvent</a><T></td> |
| <td class="colLast"> |
| <div class="block">Watermark event used for tracking progress of time when processing event based ts.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/WaterMarkEventGenerator.html" title="class in org.apache.storm.windowing">WaterMarkEventGenerator</a><T></td> |
| <td class="colLast"> |
| <div class="block">Tracks tuples across input streams and periodically emits watermark events.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/WatermarkTimeEvictionPolicy.html" title="class in org.apache.storm.windowing">WatermarkTimeEvictionPolicy</a><T></td> |
| <td class="colLast"> |
| <div class="block">An eviction policy that evicts events based on time duration taking watermark time and event lag into account.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/WatermarkTimeTriggerPolicy.html" title="class in org.apache.storm.windowing">WatermarkTimeTriggerPolicy</a><T></td> |
| <td class="colLast"> |
| <div class="block">Handles watermark events and triggers <a href="../../../../org/apache/storm/windowing/TriggerHandler.html#onTrigger--"><code>TriggerHandler.onTrigger()</code></a> for each window interval that has events to be processed up to the watermark ts.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/WindowManager.html" title="class in org.apache.storm.windowing">WindowManager</a><T></td> |
| <td class="colLast"> |
| <div class="block">Tracks a window of events and fires <a href="../../../../org/apache/storm/windowing/WindowLifecycleListener.html" title="interface in org.apache.storm.windowing"><code>WindowLifecycleListener</code></a> callbacks on expiry of events or activation of the window due to <a href="../../../../org/apache/storm/windowing/TriggerPolicy.html" title="interface in org.apache.storm.windowing"><code>TriggerPolicy</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../org/apache/storm/windowing/EvictionPolicy.Action.html" title="enum in org.apache.storm.windowing">EvictionPolicy.Action</a></td> |
| <td class="colLast"> |
| <div class="block">The action to be taken when <a href="../../../../org/apache/storm/windowing/EvictionPolicy.html#evict-org.apache.storm.windowing.Event-"><code>EvictionPolicy.evict(Event)</code></a> is invoked.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><script type="text/javascript" src="../../../../highlight.pack.js"></script> |
| <script type="text/javascript"><!-- |
| hljs.initHighlightingOnLoad(); |
| //--></script></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/storm/validation/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../org/apache/storm/windowing/persistence/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/storm/windowing/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
