Google Git
Sign in
apache / incubator-heron / refs/heads/asf-site / . / content / api / java / org / apache / storm / topology / base / BaseWindowedBolt.html
blob: 9df351fb6a3f9ebbab36029b439ad512a36fbded [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>BaseWindowedBolt (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="BaseWindowedBolt (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,"i14":10,"i15":10,"i16":10,"i17":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><a href="#nested.class.summary">Nested</a>&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.storm.topology.base</a></div>
<h2 title="Class BaseWindowedBolt" class="title">Class BaseWindowedBolt</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.storm.topology.base.BaseWindowedBolt</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.io.Serializable</code>, <code><a href="../IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code>, <code><a href="../IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../../examples/bolt/SlidingWindowSumBolt.html" title="class in org.apache.storm.examples.bolt">SlidingWindowSumBolt</a></code>, <code><a href="../../../heron/examples/eco/TestWindowBolt.html" title="class in org.apache.heron.examples.eco">TestWindowBolt</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">BaseWindowedBolt</span>
extends java.lang.Object
implements <a href="../IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.storm.topology.base.BaseWindowedBolt">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a></span></code></th>
<td class="colLast">
<div class="block">Holds a count value for count based windows and sliding intervals.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a></span></code></th>
<td class="colLast">
<div class="block">Holds a Time duration for time based windows and sliding intervals.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== 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="../../../heron/api/windowing/TimestampExtractor.html" title="interface in org.apache.heron.api.windowing">TimestampExtractor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#timestampExtractor">timestampExtractor</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../heron/api/windowing/WindowingConfigs.html" title="class in org.apache.heron.api.windowing">WindowingConfigs</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#windowConfiguration">windowConfiguration</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">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">BaseWindowedBolt</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#cleanup()">cleanup</a></span>()</code></th>
<td class="colLast">&nbsp;</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="#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">declareOutputFields</a></span>&#8203;(<a href="../OutputFieldsDeclarer.html" title="interface in org.apache.storm.topology">OutputFieldsDeclarer</a>&nbsp;declarer)</code></th>
<td class="colLast">
<div class="block">Declare the output schema for all the streams of this topology.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getComponentConfiguration()">getComponentConfiguration</a></span>()</code></th>
<td class="colLast">
<div class="block">Declare configuration specific to this component.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTimestampExtractor()">getTimestampExtractor</a></span>()</code></th>
<td class="colLast">
<div class="block">Return a <a href="../../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing"><code>TimestampExtractor</code></a> for extracting timestamps from a
tuple for event time based processing, or null for processing time.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)">prepare</a></span>&#8203;(java.util.Map&nbsp;topoConf,
<a href="../../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a>&nbsp;context,
<a href="../../task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a>&nbsp;collector)</code></th>
<td class="colLast">
<div class="block">This is similar to the
<a href="../../task/IBolt.html#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)"><code>IBolt.prepare(Map, TopologyContext, OutputCollector)</code></a> except
that while emitting, the tuples are automatically anchored to the tuples in the inputWindow.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withLag(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">withLag</a></span>&#8203;(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;duration)</code></th>
<td class="colLast">
<div class="block">Specify the maximum time lag of the tuple timestamp in milliseconds.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withLateTupleStream(java.lang.String)">withLateTupleStream</a></span>&#8203;(java.lang.String&nbsp;streamId)</code></th>
<td class="colLast">
<div class="block">Specify a stream id on which late tuples are going to be emitted.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withTimestampExtractor(org.apache.storm.windowing.TimestampExtractor)">withTimestampExtractor</a></span>&#8203;(<a href="../../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a>&nbsp;timestampExtractor)</code></th>
<td class="colLast">
<div class="block">Specify the timestamp extractor implementation.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withTimestampField(java.lang.String)">withTimestampField</a></span>&#8203;(java.lang.String&nbsp;fieldName)</code></th>
<td class="colLast">
<div class="block">Specify a field in the tuple that represents the timestamp as a long value.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)">withTumblingWindow</a></span>&#8203;(<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>&nbsp;count)</code></th>
<td class="colLast">
<div class="block">A count based tumbling window.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">withTumblingWindow</a></span>&#8203;(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;duration)</code></th>
<td class="colLast">
<div class="block">A time duration based tumbling window.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withWatermarkInterval(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">withWatermarkInterval</a></span>&#8203;(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;interval)</code></th>
<td class="colLast">
<div class="block">Specify the watermark event generation interval.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)">withWindow</a></span>&#8203;(<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>&nbsp;windowLength)</code></th>
<td class="colLast">
<div class="block">A tuple count based window that slides with every incoming tuple.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Count)">withWindow</a></span>&#8203;(<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>&nbsp;windowLength,
<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>&nbsp;slidingInterval)</code></th>
<td class="colLast">
<div class="block">Tuple count based sliding window configuration.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Duration)">withWindow</a></span>&#8203;(<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>&nbsp;windowLength,
<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;slidingInterval)</code></th>
<td class="colLast">
<div class="block">Tuple count and time duration based sliding window configuration.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">withWindow</a></span>&#8203;(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;windowLength)</code></th>
<td class="colLast">
<div class="block">A time duration based window that slides with every incoming tuple.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Count)">withWindow</a></span>&#8203;(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;windowLength,
<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>&nbsp;slidingInterval)</code></th>
<td class="colLast">
<div class="block">Time duration and count based sliding window configuration.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Duration)">withWindow</a></span>&#8203;(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;windowLength,
<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;slidingInterval)</code></th>
<td class="colLast">
<div class="block">Time duration based sliding window configuration.</div>
</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, toString, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.storm.topology.IWindowedBolt">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.storm.topology.<a href="../IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></h3>
<code><a href="../IWindowedBolt.html#execute(org.apache.storm.windowing.TupleWindow)">execute</a></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="windowConfiguration">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>windowConfiguration</h4>
<pre>protected final transient&nbsp;<a href="../../../heron/api/windowing/WindowingConfigs.html" title="class in org.apache.heron.api.windowing">WindowingConfigs</a> windowConfiguration</pre>
</li>
</ul>
<a id="timestampExtractor">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>timestampExtractor</h4>
<pre>protected&nbsp;<a href="../../../heron/api/windowing/TimestampExtractor.html" title="interface in org.apache.heron.api.windowing">TimestampExtractor</a> timestampExtractor</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;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BaseWindowedBolt</h4>
<pre>protected&nbsp;BaseWindowedBolt()</pre>
</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="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Count)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withWindow</h4>
<pre class="methodSignature">public&nbsp;<a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a>&nbsp;withWindow&#8203;(<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>&nbsp;windowLength,
<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>&nbsp;slidingInterval)</pre>
<div class="block">Tuple count based sliding window configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>windowLength</code> - the number of tuples in the window</dd>
<dd><code>slidingInterval</code> - the number of tuples after which the window slides</dd>
</dl>
</li>
</ul>
<a id="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Duration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withWindow</h4>
<pre class="methodSignature">public&nbsp;<a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a>&nbsp;withWindow&#8203;(<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>&nbsp;windowLength,
<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;slidingInterval)</pre>
<div class="block">Tuple count and time duration based sliding window configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>windowLength</code> - the number of tuples in the window</dd>
<dd><code>slidingInterval</code> - the time duration after which the window slides</dd>
</dl>
</li>
</ul>
<a id="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Count)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withWindow</h4>
<pre class="methodSignature">public&nbsp;<a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a>&nbsp;withWindow&#8203;(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;windowLength,
<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>&nbsp;slidingInterval)</pre>
<div class="block">Time duration and count based sliding window configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>windowLength</code> - the time duration of the window</dd>
<dd><code>slidingInterval</code> - the number of tuples after which the window slides</dd>
</dl>
</li>
</ul>
<a id="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Duration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withWindow</h4>
<pre class="methodSignature">public&nbsp;<a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a>&nbsp;withWindow&#8203;(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;windowLength,
<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;slidingInterval)</pre>
<div class="block">Time duration based sliding window configuration.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>windowLength</code> - the time duration of the window</dd>
<dd><code>slidingInterval</code> - the time duration after which the window slides</dd>
</dl>
</li>
</ul>
<a id="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withWindow</h4>
<pre class="methodSignature">public&nbsp;<a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a>&nbsp;withWindow&#8203;(<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>&nbsp;windowLength)</pre>
<div class="block">A tuple count based window that slides with every incoming tuple.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>windowLength</code> - the number of tuples in the window</dd>
</dl>
</li>
</ul>
<a id="withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withWindow</h4>
<pre class="methodSignature">public&nbsp;<a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a>&nbsp;withWindow&#8203;(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;windowLength)</pre>
<div class="block">A time duration based window that slides with every incoming tuple.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>windowLength</code> - the time duration of the window</dd>
</dl>
</li>
</ul>
<a id="withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withTumblingWindow</h4>
<pre class="methodSignature">public&nbsp;<a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a>&nbsp;withTumblingWindow&#8203;(<a href="BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>&nbsp;count)</pre>
<div class="block">A count based tumbling window.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>count</code> - the number of tuples after which the window tumbles</dd>
</dl>
</li>
</ul>
<a id="withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withTumblingWindow</h4>
<pre class="methodSignature">public&nbsp;<a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a>&nbsp;withTumblingWindow&#8203;(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;duration)</pre>
<div class="block">A time duration based tumbling window.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>duration</code> - the time duration after which the window tumbles</dd>
</dl>
</li>
</ul>
<a id="withTimestampField(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withTimestampField</h4>
<pre class="methodSignature">public&nbsp;<a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a>&nbsp;withTimestampField&#8203;(java.lang.String&nbsp;fieldName)</pre>
<div class="block">Specify a field in the tuple that represents the timestamp as a long value. If this
field is not present in the incoming tuple, an <code>IllegalArgumentException</code> will be thrown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>fieldName</code> - the name of the field that contains the timestamp</dd>
</dl>
</li>
</ul>
<a id="withTimestampExtractor(org.apache.storm.windowing.TimestampExtractor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withTimestampExtractor</h4>
<pre class="methodSignature">public&nbsp;<a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a>&nbsp;withTimestampExtractor&#8203;(<a href="../../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a>&nbsp;timestampExtractor)</pre>
<div class="block">Specify the timestamp extractor implementation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>timestampExtractor</code> - the <a href="../../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing"><code>TimestampExtractor</code></a> implementation</dd>
</dl>
</li>
</ul>
<a id="getTimestampExtractor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTimestampExtractor</h4>
<pre class="methodSignature">public&nbsp;<a href="../../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing">TimestampExtractor</a>&nbsp;getTimestampExtractor()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../IWindowedBolt.html#getTimestampExtractor()">IWindowedBolt</a></code></span></div>
<div class="block">Return a <a href="../../windowing/TimestampExtractor.html" title="interface in org.apache.storm.windowing"><code>TimestampExtractor</code></a> for extracting timestamps from a
tuple for event time based processing, or null for processing time.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../IWindowedBolt.html#getTimestampExtractor()">getTimestampExtractor</a></code>&nbsp;in interface&nbsp;<code><a href="../IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the timestamp extractor</dd>
</dl>
</li>
</ul>
<a id="withLateTupleStream(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withLateTupleStream</h4>
<pre class="methodSignature">public&nbsp;<a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a>&nbsp;withLateTupleStream&#8203;(java.lang.String&nbsp;streamId)</pre>
<div class="block">Specify a stream id on which late tuples are going to be emitted.
It must be defined on a per-component basis, and in conjunction with the
<a href="#withTimestampField(java.lang.String)"><code>withTimestampField(java.lang.String)</code></a>, otherwise <code>IllegalArgumentException</code> will
be thrown.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>streamId</code> - the name of the stream used to emit late tuples on</dd>
</dl>
</li>
</ul>
<a id="withLag(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withLag</h4>
<pre class="methodSignature">public&nbsp;<a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a>&nbsp;withLag&#8203;(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;duration)</pre>
<div class="block">Specify the maximum time lag of the tuple timestamp in milliseconds. It means that the tuple
timestamps
cannot be out of order by more than this amount.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>duration</code> - the max lag duration</dd>
</dl>
</li>
</ul>
<a id="withWatermarkInterval(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withWatermarkInterval</h4>
<pre class="methodSignature">public&nbsp;<a href="BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a>&nbsp;withWatermarkInterval&#8203;(<a href="BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a>&nbsp;interval)</pre>
<div class="block">Specify the watermark event generation interval. For tuple based timestamps, watermark events
are used to track the progress of time</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>interval</code> - the interval at which watermark events are generated</dd>
</dl>
</li>
</ul>
<a id="prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>prepare</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;prepare&#8203;(java.util.Map&nbsp;topoConf,
<a href="../../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a>&nbsp;context,
<a href="../../task/OutputCollector.html" title="class in org.apache.storm.task">OutputCollector</a>&nbsp;collector)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../IWindowedBolt.html#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)">IWindowedBolt</a></code></span></div>
<div class="block">This is similar to the
<a href="../../task/IBolt.html#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)"><code>IBolt.prepare(Map, TopologyContext, OutputCollector)</code></a> except
that while emitting, the tuples are automatically anchored to the tuples in the inputWindow.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../IWindowedBolt.html#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)">prepare</a></code>&nbsp;in interface&nbsp;<code><a href="../IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></code></dd>
</dl>
</li>
</ul>
<a id="cleanup()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cleanup</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;cleanup()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../IWindowedBolt.html#cleanup()">cleanup</a></code>&nbsp;in interface&nbsp;<code><a href="../IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></code></dd>
</dl>
</li>
</ul>
<a id="declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>declareOutputFields</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;declareOutputFields&#8203;(<a href="../OutputFieldsDeclarer.html" title="interface in org.apache.storm.topology">OutputFieldsDeclarer</a>&nbsp;declarer)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../IComponent.html#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">IComponent</a></code></span></div>
<div class="block">Declare the output schema for all the streams of this topology.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../IComponent.html#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">declareOutputFields</a></code>&nbsp;in interface&nbsp;<code><a href="../IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>declarer</code> - this is used to declare output stream ids, output fields, and whether or not each output stream is a direct stream</dd>
</dl>
</li>
</ul>
<a id="getComponentConfiguration()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getComponentConfiguration</h4>
<pre class="methodSignature">public&nbsp;java.util.Map&lt;java.lang.String,&#8203;java.lang.Object&gt;&nbsp;getComponentConfiguration()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../IComponent.html#getComponentConfiguration()">IComponent</a></code></span></div>
<div class="block">Declare configuration specific to this component. Only a subset of the "topology.*" configs can
be overridden. The component configuration can be further overridden when constructing the
topology using <a href="../TopologyBuilder.html" title="class in org.apache.storm.topology"><code>TopologyBuilder</code></a></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../IComponent.html#getComponentConfiguration()">getComponentConfiguration</a></code>&nbsp;in interface&nbsp;<code><a href="../IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code></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><a href="#nested.class.summary">Nested</a>&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>