Google Git
Sign in
apache / incubator-heron / refs/heads/asf-site / . / content / api / java / org / apache / heron / examples / eco / TestWindowBolt.html
blob: d47ba9684738299cfa6183d504fb9ebba89394b2 [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>TestWindowBolt (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="TestWindowBolt (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":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>Field&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.heron.examples.eco</a></div>
<h2 title="Class TestWindowBolt" class="title">Class TestWindowBolt</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">org.apache.storm.topology.base.BaseWindowedBolt</a></li>
<li>
<ul class="inheritance">
<li>org.apache.heron.examples.eco.TestWindowBolt</li>
</ul>
</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="../../../storm/topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code>, <code><a href="../../../storm/topology/IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">TestWindowBolt</span>
extends <a href="../../../storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.heron.examples.eco.TestWindowBolt">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>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.storm.topology.base.BaseWindowedBolt">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;org.apache.storm.topology.base.<a href="../../../storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></h3>
<code><a href="../../../storm/topology/base/BaseWindowedBolt.Count.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Count</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.Duration.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt.Duration</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.storm.topology.base.BaseWindowedBolt">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.storm.topology.base.<a href="../../../storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></h3>
<code><a href="../../../storm/topology/base/BaseWindowedBolt.html#timestampExtractor">timestampExtractor</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.html#windowConfiguration">windowConfiguration</a></code></li>
</ul>
</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">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">TestWindowBolt</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="#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">declareOutputFields</a></span>&#8203;(<a href="../../../storm/topology/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="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#execute(org.apache.storm.windowing.TupleWindow)">execute</a></span>&#8203;(<a href="../../../storm/windowing/TupleWindow.html" title="interface in org.apache.storm.windowing">TupleWindow</a>&nbsp;inputWindow)</code></th>
<td class="colLast">
<div class="block">Process the tuple window and optionally emit new tuples based on the tuples in the input
window.</div>
</td>
</tr>
<tr id="i2" 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="../../../storm/task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a>&nbsp;context,
<a href="../../../storm/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="../../../storm/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>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.storm.topology.base.BaseWindowedBolt">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.storm.topology.base.<a href="../../../storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></h3>
<code><a href="../../../storm/topology/base/BaseWindowedBolt.html#cleanup()">cleanup</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.html#getComponentConfiguration()">getComponentConfiguration</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.html#getTimestampExtractor()">getTimestampExtractor</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.html#withLag(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">withLag</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.html#withLateTupleStream(java.lang.String)">withLateTupleStream</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.html#withTimestampExtractor(org.apache.storm.windowing.TimestampExtractor)">withTimestampExtractor</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.html#withTimestampField(java.lang.String)">withTimestampField</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.html#withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)">withTumblingWindow</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.html#withTumblingWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">withTumblingWindow</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.html#withWatermarkInterval(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">withWatermarkInterval</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.html#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count)">withWindow</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.html#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Count)">withWindow</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.html#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Count,org.apache.storm.topology.base.BaseWindowedBolt.Duration)">withWindow</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.html#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration)">withWindow</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.html#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Count)">withWindow</a>, <a href="../../../storm/topology/base/BaseWindowedBolt.html#withWindow(org.apache.storm.topology.base.BaseWindowedBolt.Duration,org.apache.storm.topology.base.BaseWindowedBolt.Duration)">withWindow</a></code></li>
</ul>
<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>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= 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>TestWindowBolt</h4>
<pre>public&nbsp;TestWindowBolt()</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="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="../../../storm/task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a>&nbsp;context,
<a href="../../../storm/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="../../../storm/topology/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="../../../storm/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="../../../storm/topology/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="../../../storm/topology/IWindowedBolt.html" title="interface in org.apache.storm.topology">IWindowedBolt</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../storm/topology/base/BaseWindowedBolt.html#prepare(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.task.OutputCollector)">prepare</a></code>&nbsp;in class&nbsp;<code><a href="../../../storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</a></code></dd>
</dl>
</li>
</ul>
<a id="execute(org.apache.storm.windowing.TupleWindow)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;execute&#8203;(<a href="../../../storm/windowing/TupleWindow.html" title="interface in org.apache.storm.windowing">TupleWindow</a>&nbsp;inputWindow)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../storm/topology/IWindowedBolt.html#execute(org.apache.storm.windowing.TupleWindow)">IWindowedBolt</a></code></span></div>
<div class="block">Process the tuple window and optionally emit new tuples based on the tuples in the input
window.</div>
</li>
</ul>
<a id="declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>declareOutputFields</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;declareOutputFields&#8203;(<a href="../../../storm/topology/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="../../../storm/topology/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="../../../storm/topology/IComponent.html#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">declareOutputFields</a></code>&nbsp;in interface&nbsp;<code><a href="../../../storm/topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../storm/topology/base/BaseWindowedBolt.html#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">declareOutputFields</a></code>&nbsp;in class&nbsp;<code><a href="../../../storm/topology/base/BaseWindowedBolt.html" title="class in org.apache.storm.topology.base">BaseWindowedBolt</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>
</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>Field&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>