blob: 9bb71e8ad28cabfab3939fd172c3ae1539532c30 [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>TestWordSpout (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="TestWordSpout (Heron Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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>Nested&nbsp;|&nbsp;</li>
<li>Field&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.storm.examples.spout</a></div>
<h2 title="Class TestWordSpout" class="title">Class TestWordSpout</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../topology/base/BaseComponent.html" title="class in org.apache.storm.topology.base">org.apache.storm.topology.base.BaseComponent</a></li>
<li>
<ul class="inheritance">
<li><a href="../../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">org.apache.storm.topology.base.BaseRichSpout</a></li>
<li>
<ul class="inheritance">
<li>org.apache.storm.examples.spout.TestWordSpout</li>
</ul>
</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="../../spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code>, <code><a href="../../topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></code>, <code><a href="../../topology/IRichSpout.html" title="interface in org.apache.storm.topology">IRichSpout</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">TestWordSpout</span>
extends <a href="../../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">BaseRichSpout</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../serialized-form.html#org.apache.storm.examples.spout.TestWordSpout">Serialized Form</a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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()">TestWordSpout</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.time.Duration)">TestWordSpout</a></span>&#8203;(java.time.Duration&nbsp;throttleDuration)</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="#ack(java.lang.Object)">ack</a></span>&#8203;(java.lang.Object&nbsp;msgId)</code></th>
<td class="colLast">
<div class="block">Storm has determined that the tuple emitted by this spout with the msgId identifier
has been fully processed.</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="#close()">close</a></span>()</code></th>
<td class="colLast">
<div class="block">Called when an ISpout is going to be shutdown.</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="#declareOutputFields(org.apache.storm.topology.OutputFieldsDeclarer)">declareOutputFields</a></span>&#8203;(<a href="../../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="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fail(java.lang.Object)">fail</a></span>&#8203;(java.lang.Object&nbsp;msgId)</code></th>
<td class="colLast">
<div class="block">The tuple emitted by this spout with the msgId identifier has failed to be
fully processed.</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="#nextTuple()">nextTuple</a></span>()</code></th>
<td class="colLast">
<div class="block">When this method is called, Storm is requesting that the Spout emit tuples to the
output collector.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#open(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.spout.SpoutOutputCollector)">open</a></span>&#8203;(java.util.Map&nbsp;conf,
<a href="../../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a>&nbsp;context,
<a href="../../spout/SpoutOutputCollector.html" title="class in org.apache.storm.spout">SpoutOutputCollector</a>&nbsp;acollector)</code></th>
<td class="colLast">
<div class="block">Called when a task for this component is initialized within a worker on the cluster.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.storm.topology.base.BaseRichSpout">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.storm.topology.base.<a href="../../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">BaseRichSpout</a></h3>
<code><a href="../../topology/base/BaseRichSpout.html#activate()">activate</a>, <a href="../../topology/base/BaseRichSpout.html#deactivate()">deactivate</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.storm.topology.base.BaseComponent">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.storm.topology.base.<a href="../../topology/base/BaseComponent.html" title="class in org.apache.storm.topology.base">BaseComponent</a></h3>
<code><a href="../../topology/base/BaseComponent.html#getComponentConfiguration()">getComponentConfiguration</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>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.storm.topology.IComponent">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.storm.topology.<a href="../../topology/IComponent.html" title="interface in org.apache.storm.topology">IComponent</a></h3>
<code><a href="../../topology/IComponent.html#getComponentConfiguration()">getComponentConfiguration</a></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="blockList">
<li class="blockList">
<h4>TestWordSpout</h4>
<pre>public&nbsp;TestWordSpout()</pre>
</li>
</ul>
<a id="&lt;init&gt;(java.time.Duration)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TestWordSpout</h4>
<pre>public&nbsp;TestWordSpout&#8203;(java.time.Duration&nbsp;throttleDuration)</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="open(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.spout.SpoutOutputCollector)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;open&#8203;(java.util.Map&nbsp;conf,
<a href="../../task/TopologyContext.html" title="class in org.apache.storm.task">TopologyContext</a>&nbsp;context,
<a href="../../spout/SpoutOutputCollector.html" title="class in org.apache.storm.spout">SpoutOutputCollector</a>&nbsp;acollector)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spout/ISpout.html#open(java.util.Map,org.apache.storm.task.TopologyContext,org.apache.storm.spout.SpoutOutputCollector)">ISpout</a></code></span></div>
<div class="block">Called when a task for this component is initialized within a worker on the cluster.
It provides the spout with the environment in which the spout executes.
<p>
<p>This includes the:</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - The Storm configuration for this spout. This is the configuration provided to the topology merged in with cluster configuration on this machine.</dd>
<dd><code>context</code> - This object can be used to get information about this task's place within the topology, including the task id and component id of this task, input and output information, etc.</dd>
<dd><code>acollector</code> - The collector is used to emit tuples from this spout. Tuples can be emitted at any time, including the open and close methods. The collector is thread-safe and should be saved as an instance variable of this spout object.</dd>
</dl>
</li>
</ul>
<a id="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;close()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spout/ISpout.html#close()">ISpout</a></code></span></div>
<div class="block">Called when an ISpout is going to be shutdown. There is no guarentee that close
will be called, because the supervisor kill -9's worker processes on the cluster.
<p>
<p>The one context where close is guaranteed to be called is a topology is
killed when running Storm in simulator.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../spout/ISpout.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../topology/base/BaseRichSpout.html#close()">close</a></code>&nbsp;in class&nbsp;<code><a href="../../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">BaseRichSpout</a></code></dd>
</dl>
</li>
</ul>
<a id="nextTuple()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextTuple</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;nextTuple()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spout/ISpout.html#nextTuple()">ISpout</a></code></span></div>
<div class="block">When this method is called, Storm is requesting that the Spout emit tuples to the
output collector. This method should be non-blocking, so if the Spout has no tuples
to emit, this method should return. nextTuple, ack, and fail are all called in a tight
loop in a single thread in the spout task. When there are no tuples to emit, it is courteous
to have nextTuple sleep for a short amount of time (like a single millisecond)
so as not to waste too much CPU.</div>
</li>
</ul>
<a id="ack(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ack</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;ack&#8203;(java.lang.Object&nbsp;msgId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spout/ISpout.html#ack(java.lang.Object)">ISpout</a></code></span></div>
<div class="block">Storm has determined that the tuple emitted by this spout with the msgId identifier
has been fully processed. Typically, an implementation of this method will take that
message off the queue and prevent it from being replayed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../spout/ISpout.html#ack(java.lang.Object)">ack</a></code>&nbsp;in interface&nbsp;<code><a href="../../spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../topology/base/BaseRichSpout.html#ack(java.lang.Object)">ack</a></code>&nbsp;in class&nbsp;<code><a href="../../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">BaseRichSpout</a></code></dd>
</dl>
</li>
</ul>
<a id="fail(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fail</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;fail&#8203;(java.lang.Object&nbsp;msgId)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../spout/ISpout.html#fail(java.lang.Object)">ISpout</a></code></span></div>
<div class="block">The tuple emitted by this spout with the msgId identifier has failed to be
fully processed. Typically, an implementation of this method will put that
message back on the queue to be replayed at a later time.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../spout/ISpout.html#fail(java.lang.Object)">fail</a></code>&nbsp;in interface&nbsp;<code><a href="../../spout/ISpout.html" title="interface in org.apache.storm.spout">ISpout</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../topology/base/BaseRichSpout.html#fail(java.lang.Object)">fail</a></code>&nbsp;in class&nbsp;<code><a href="../../topology/base/BaseRichSpout.html" title="class in org.apache.storm.topology.base">BaseRichSpout</a></code></dd>
</dl>
</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="../../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="../../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="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>Nested&nbsp;|&nbsp;</li>
<li>Field&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>