blob: 3a00710d3050d3f24a24f293d0f798ad55de4959 [file] [log] [blame]
<!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>Uses of Package 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="Uses of Package 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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/windowing/package-use.html" target="_top">Frames</a></li>
<li><a href="package-use.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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="Uses of Package org.apache.storm.windowing" class="title">Uses of Package<br>org.apache.storm.windowing</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../org/apache/storm/windowing/package-summary.html">org.apache.storm.windowing</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.storm.bolt">org.apache.storm.bolt</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#org.apache.storm.flux.examples">org.apache.storm.flux.examples</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.storm.st.topology.window">org.apache.storm.st.topology.window</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#org.apache.storm.starter.bolt">org.apache.storm.starter.bolt</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.storm.topology">org.apache.storm.topology</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#org.apache.storm.topology.base">org.apache.storm.topology.base</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.storm.trident.windowing">org.apache.storm.trident.windowing</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#org.apache.storm.trident.windowing.strategy">org.apache.storm.trident.windowing.strategy</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="#org.apache.storm.windowing">org.apache.storm.windowing</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#org.apache.storm.windowing.persistence">org.apache.storm.windowing.persistence</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.storm.bolt">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../org/apache/storm/windowing/package-summary.html">org.apache.storm.windowing</a> used by <a href="../../../../org/apache/storm/bolt/package-summary.html">org.apache.storm.bolt</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/TimestampExtractor.html#org.apache.storm.bolt">TimestampExtractor</a>
<div class="block">Interface to be implemented for extracting timestamp from a tuple.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/TupleWindow.html#org.apache.storm.bolt">TupleWindow</a>
<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>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.storm.flux.examples">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../org/apache/storm/windowing/package-summary.html">org.apache.storm.windowing</a> used by <a href="../../../../org/apache/storm/flux/examples/package-summary.html">org.apache.storm.flux.examples</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/TupleWindow.html#org.apache.storm.flux.examples">TupleWindow</a>
<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>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.storm.st.topology.window">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../org/apache/storm/windowing/package-summary.html">org.apache.storm.windowing</a> used by <a href="../../../../org/apache/storm/st/topology/window/package-summary.html">org.apache.storm.st.topology.window</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/TupleWindow.html#org.apache.storm.st.topology.window">TupleWindow</a>
<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>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.storm.starter.bolt">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../org/apache/storm/windowing/package-summary.html">org.apache.storm.windowing</a> used by <a href="../../../../org/apache/storm/starter/bolt/package-summary.html">org.apache.storm.starter.bolt</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/TupleWindow.html#org.apache.storm.starter.bolt">TupleWindow</a>
<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>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.storm.topology">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../org/apache/storm/windowing/package-summary.html">org.apache.storm.windowing</a> used by <a href="../../../../org/apache/storm/topology/package-summary.html">org.apache.storm.topology</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/Event.html#org.apache.storm.topology">Event</a>
<div class="block">An event is a wrapper object that gets stored in the window.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/TimestampExtractor.html#org.apache.storm.topology">TimestampExtractor</a>
<div class="block">Interface to be implemented for extracting timestamp from a tuple.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/TupleWindow.html#org.apache.storm.topology">TupleWindow</a>
<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="colOne"><a href="../../../../org/apache/storm/windowing/class-use/WindowLifecycleListener.html#org.apache.storm.topology">WindowLifecycleListener</a>
<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"><a name="org.apache.storm.topology.base">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../org/apache/storm/windowing/package-summary.html">org.apache.storm.windowing</a> used by <a href="../../../../org/apache/storm/topology/base/package-summary.html">org.apache.storm.topology.base</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/TimestampExtractor.html#org.apache.storm.topology.base">TimestampExtractor</a>
<div class="block">Interface to be implemented for extracting timestamp from a tuple.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.storm.trident.windowing">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../org/apache/storm/windowing/package-summary.html">org.apache.storm.windowing</a> used by <a href="../../../../org/apache/storm/trident/windowing/package-summary.html">org.apache.storm.trident.windowing</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/WindowManager.html#org.apache.storm.trident.windowing">WindowManager</a>
<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"><a name="org.apache.storm.trident.windowing.strategy">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../org/apache/storm/windowing/package-summary.html">org.apache.storm.windowing</a> used by <a href="../../../../org/apache/storm/trident/windowing/strategy/package-summary.html">org.apache.storm.trident.windowing.strategy</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/EvictionPolicy.html#org.apache.storm.trident.windowing.strategy">EvictionPolicy</a>
<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="colOne"><a href="../../../../org/apache/storm/windowing/class-use/TriggerHandler.html#org.apache.storm.trident.windowing.strategy">TriggerHandler</a>
<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="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/TriggerPolicy.html#org.apache.storm.trident.windowing.strategy">TriggerPolicy</a>
<div class="block">Triggers the window calculations based on the policy.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.storm.windowing">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../org/apache/storm/windowing/package-summary.html">org.apache.storm.windowing</a> used by <a href="../../../../org/apache/storm/windowing/package-summary.html">org.apache.storm.windowing</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/Event.html#org.apache.storm.windowing">Event</a>
<div class="block">An event is a wrapper object that gets stored in the window.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/EventImpl.html#org.apache.storm.windowing">EventImpl</a>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/EvictionContext.html#org.apache.storm.windowing">EvictionContext</a>
<div class="block">Context information that can be used by the eviction policy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/EvictionPolicy.html#org.apache.storm.windowing">EvictionPolicy</a>
<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="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/EvictionPolicy.Action.html#org.apache.storm.windowing">EvictionPolicy.Action</a>
<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>
<tr class="rowColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/TimeEvictionPolicy.html#org.apache.storm.windowing">TimeEvictionPolicy</a>
<div class="block">Eviction policy that evicts events based on time duration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/TriggerHandler.html#org.apache.storm.windowing">TriggerHandler</a>
<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="colOne"><a href="../../../../org/apache/storm/windowing/class-use/TriggerPolicy.html#org.apache.storm.windowing">TriggerPolicy</a>
<div class="block">Triggers the window calculations based on the policy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/TupleWindow.html#org.apache.storm.windowing">TupleWindow</a>
<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="colOne"><a href="../../../../org/apache/storm/windowing/class-use/Window.html#org.apache.storm.windowing">Window</a>
<div class="block">A view of events in a sliding window.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/WindowLifecycleListener.html#org.apache.storm.windowing">WindowLifecycleListener</a>
<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>
<tr class="rowColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/WindowManager.html#org.apache.storm.windowing">WindowManager</a>
<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"><a name="org.apache.storm.windowing.persistence">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../../org/apache/storm/windowing/package-summary.html">org.apache.storm.windowing</a> used by <a href="../../../../org/apache/storm/windowing/persistence/package-summary.html">org.apache.storm.windowing.persistence</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../../org/apache/storm/windowing/class-use/Event.html#org.apache.storm.windowing.persistence">Event</a>
<div class="block">An event is a wrapper object that gets stored in the window.</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><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/storm/windowing/package-use.html" target="_top">Frames</a></li>
<li><a href="package-use.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.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>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>