Google Git
Sign in
apache / streams / refs/heads/asf-site / . / streams-runtimes / streams-runtime-local / apidocs / org / apache / streams / local / tasks / BaseStreamsTask.html
blob: c3fb68854a3d6274713584b79adfd1a68f633124 [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 (1.8.0_152) on Mon Apr 02 22:41:53 UTC 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BaseStreamsTask (streams-runtime-local 0.5.2-SNAPSHOT API)</title>
<meta name="date" content="2018-04-02">
<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="BaseStreamsTask (streams-runtime-local 0.5.2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":42,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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="navBarCell1Rev">Class</li>
<li><a href="class-use/BaseStreamsTask.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/streams/local/tasks/LocalStreamProcessMonitorThread.html" title="class in org.apache.streams.local.tasks"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/streams/local/tasks/BaseStreamsTask.html" target="_top">Frames</a></li>
<li><a href="BaseStreamsTask.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.streams.local.tasks</div>
<h2 title="Class BaseStreamsTask" class="title">Class BaseStreamsTask</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.streams.local.tasks.BaseStreamsTask</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a>, <a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html" title="interface in org.apache.streams.local.tasks">StreamsTask</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/streams/local/tasks/StreamsMergeTask.html" title="class in org.apache.streams.local.tasks">StreamsMergeTask</a>, <a href="../../../../../org/apache/streams/local/tasks/StreamsPersistWriterTask.html" title="class in org.apache.streams.local.tasks">StreamsPersistWriterTask</a>, <a href="../../../../../org/apache/streams/local/tasks/StreamsProcessorTask.html" title="class in org.apache.streams.local.tasks">StreamsProcessorTask</a>, <a href="../../../../../org/apache/streams/local/tasks/StreamsProviderTask.html" title="class in org.apache.streams.local.tasks">StreamsProviderTask</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">BaseStreamsTask</span>
extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html" title="interface in org.apache.streams.local.tasks">StreamsTask</a></pre>
<div class="block">BaseStreamsTask is the primary abstract StreamsTask.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.apache.streams.config.StreamsConfiguration</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/local/tasks/BaseStreamsTask.html#streamConfig">streamConfig</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/local/tasks/BaseStreamsTask.html#BaseStreamsTask-org.apache.streams.config.StreamsConfiguration-">BaseStreamsTask</a></span>(org.apache.streams.config.StreamsConfiguration&nbsp;config)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/local/tasks/BaseStreamsTask.html#addInputQueue-java.util.concurrent.BlockingQueue-">addInputQueue</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/BlockingQueue.html?is-external=true" title="class or interface in java.util.concurrent">BlockingQueue</a>&lt;<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&gt;&nbsp;inputQueue)</code>
<div class="block">Add an input <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util"><code>Queue</code></a> for this task.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/local/tasks/BaseStreamsTask.html#addOutputQueue-java.util.concurrent.BlockingQueue-">addOutputQueue</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/BlockingQueue.html?is-external=true" title="class or interface in java.util.concurrent">BlockingQueue</a>&lt;<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&gt;&nbsp;outputQueue)</code>
<div class="block">Add an output <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util"><code>Queue</code></a> for this task.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/local/tasks/BaseStreamsTask.html#addToOutgoingQueue-org.apache.streams.core.StreamsDatum-">addToOutgoingQueue</a></span>(<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&nbsp;datum)</code>
<div class="block">Adds a StreamDatum to the outgoing queues.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected <a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/local/tasks/BaseStreamsTask.html#cloneStreamsDatum-org.apache.streams.core.StreamsDatum-">cloneStreamsDatum</a></span>(<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&nbsp;datum)</code>
<div class="block">//TODO LOCAL MODE HACK.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/BlockingQueue.html?is-external=true" title="class or interface in java.util.concurrent">BlockingQueue</a>&lt;<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/local/tasks/BaseStreamsTask.html#getInputQueues--">getInputQueues</a></span>()</code>
<div class="block">Returns the input queues that have been set for this task.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected <a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/local/tasks/BaseStreamsTask.html#getNextDatum--">getNextDatum</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/BlockingQueue.html?is-external=true" title="class or interface in java.util.concurrent">BlockingQueue</a>&lt;<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/local/tasks/BaseStreamsTask.html#getOutputQueues--">getOutputQueues</a></span>()</code>
<div class="block">Returns the output queues that have been set for this task</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/local/tasks/BaseStreamsTask.html#getStartedAt--">getStartedAt</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/local/tasks/BaseStreamsTask.html#getStreamIdentifier--">getStreamIdentifier</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/local/tasks/BaseStreamsTask.html#isWaiting--">isWaiting</a></span>()</code>
<div class="block">Returns true if the task is waiting on more data to process</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/streams/local/tasks/BaseStreamsTask.html#setStartedAt--">setStartedAt</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.streams.local.tasks.StreamsTask">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.streams.local.tasks.<a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html" title="interface in org.apache.streams.local.tasks">StreamsTask</a></h3>
<code><a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html#isRunning--">isRunning</a>, <a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html#setStreamConfig-org.apache.streams.config.StreamsConfiguration-">setStreamConfig</a>, <a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html#setStreamsTaskCounter-org.apache.streams.local.counters.StreamsTaskCounter-">setStreamsTaskCounter</a>, <a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html#stopTask--">stopTask</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Runnable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true" title="class or interface in java.lang">Runnable</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html?is-external=true#run--" title="class or interface in java.lang">run</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="streamConfig">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>streamConfig</h4>
<pre>protected&nbsp;org.apache.streams.config.StreamsConfiguration streamConfig</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="BaseStreamsTask-org.apache.streams.config.StreamsConfiguration-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BaseStreamsTask</h4>
<pre>public&nbsp;BaseStreamsTask(org.apache.streams.config.StreamsConfiguration&nbsp;config)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addInputQueue-java.util.concurrent.BlockingQueue-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addInputQueue</h4>
<pre>public&nbsp;void&nbsp;addInputQueue(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/BlockingQueue.html?is-external=true" title="class or interface in java.util.concurrent">BlockingQueue</a>&lt;<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&gt;&nbsp;inputQueue)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html#addInputQueue-java.util.concurrent.BlockingQueue-">StreamsTask</a></code></span></div>
<div class="block">Add an input <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util"><code>Queue</code></a> for this task.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html#addInputQueue-java.util.concurrent.BlockingQueue-">addInputQueue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html" title="interface in org.apache.streams.local.tasks">StreamsTask</a></code></dd>
</dl>
</li>
</ul>
<a name="addOutputQueue-java.util.concurrent.BlockingQueue-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOutputQueue</h4>
<pre>public&nbsp;void&nbsp;addOutputQueue(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/BlockingQueue.html?is-external=true" title="class or interface in java.util.concurrent">BlockingQueue</a>&lt;<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&gt;&nbsp;outputQueue)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html#addOutputQueue-java.util.concurrent.BlockingQueue-">StreamsTask</a></code></span></div>
<div class="block">Add an output <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Queue.html?is-external=true" title="class or interface in java.util"><code>Queue</code></a> for this task.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html#addOutputQueue-java.util.concurrent.BlockingQueue-">addOutputQueue</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html" title="interface in org.apache.streams.local.tasks">StreamsTask</a></code></dd>
</dl>
</li>
</ul>
<a name="getInputQueues--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputQueues</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/BlockingQueue.html?is-external=true" title="class or interface in java.util.concurrent">BlockingQueue</a>&lt;<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&gt;&gt;&nbsp;getInputQueues()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html#getInputQueues--">StreamsTask</a></code></span></div>
<div class="block">Returns the input queues that have been set for this task.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html#getInputQueues--">getInputQueues</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html" title="interface in org.apache.streams.local.tasks">StreamsTask</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of input queues</dd>
</dl>
</li>
</ul>
<a name="getOutputQueues--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputQueues</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/concurrent/BlockingQueue.html?is-external=true" title="class or interface in java.util.concurrent">BlockingQueue</a>&lt;<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&gt;&gt;&nbsp;getOutputQueues()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html#getOutputQueues--">StreamsTask</a></code></span></div>
<div class="block">Returns the output queues that have been set for this task</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html#getOutputQueues--">getOutputQueues</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html" title="interface in org.apache.streams.local.tasks">StreamsTask</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of output queues</dd>
</dl>
</li>
</ul>
<a name="getNextDatum--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNextDatum</h4>
<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
protected&nbsp;<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&nbsp;getNextDatum()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">SHOULD NOT BE NECCESARY, WILL REMOVE.
Round Robins through input queues to get the next StreamsDatum. If all input queues are empty, it will return null.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the next StreamsDatum or null if all input queues are empty.</dd>
</dl>
</li>
</ul>
<a name="addToOutgoingQueue-org.apache.streams.core.StreamsDatum-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addToOutgoingQueue</h4>
<pre>protected&nbsp;void&nbsp;addToOutgoingQueue(<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&nbsp;datum)
throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre>
<div class="block">Adds a StreamDatum to the outgoing queues. If there are multiple queues, it uses serialization to create
clones of the datum and adds a new clone to each queue.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>datum</code> - </dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd>
</dl>
</li>
</ul>
<a name="isWaiting--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWaiting</h4>
<pre>public&nbsp;boolean&nbsp;isWaiting()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html#isWaiting--">StreamsTask</a></code></span></div>
<div class="block">Returns true if the task is waiting on more data to process</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html#isWaiting--">isWaiting</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/streams/local/tasks/StreamsTask.html" title="interface in org.apache.streams.local.tasks">StreamsTask</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true, if waiting on more data to process</dd>
</dl>
</li>
</ul>
<a name="cloneStreamsDatum-org.apache.streams.core.StreamsDatum-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cloneStreamsDatum</h4>
<pre>protected&nbsp;<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&nbsp;cloneStreamsDatum(<a href="https://github.com/apache/streams/streams-core/apidocs/org/apache/streams/core/StreamsDatum.html?is-external=true" title="class or interface in org.apache.streams.core">StreamsDatum</a>&nbsp;datum)</pre>
<div class="block">//TODO LOCAL MODE HACK. Need to fix
In order for our data streams to ported to other data flow frame works(Storm, Hadoop, Spark, etc) we need to be able to
enforce the serialization required by each framework. This needs some thought and design before a final solution is
made.
In order to be able to copy/clone StreamDatums the orginal idea was to force all StreamsDatums to be java serializable.
This was seen as unacceptable for local mode. So until we come up with a solution to enforce serialization and be
compatiable across multiple frame works, this hack is in place.
If datum.document is Serializable, we use serialization to clone a new copy. If it is not Serializable we attempt
different methods using an com.fasterxml.jackson.databind.ObjectMapper to copy/clone the StreamsDatum. If the object
is not clonable by these methods, an error is reported to the logging and a NULL object is returned.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>datum</code> - </dd>
<dt><span class="returnLabel">Returns:</span></dt>
</dl>
</li>
</ul>
<a name="getStartedAt--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartedAt</h4>
<pre>public&nbsp;long&nbsp;getStartedAt()</pre>
</li>
</ul>
<a name="setStartedAt--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStartedAt</h4>
<pre>public&nbsp;void&nbsp;setStartedAt()</pre>
</li>
</ul>
<a name="getStreamIdentifier--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getStreamIdentifier</h4>
<pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getStreamIdentifier()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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="navBarCell1Rev">Class</li>
<li><a href="class-use/BaseStreamsTask.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/streams/local/tasks/LocalStreamProcessMonitorThread.html" title="class in org.apache.streams.local.tasks"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/streams/local/tasks/BaseStreamsTask.html" target="_top">Frames</a></li>
<li><a href="BaseStreamsTask.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>