blob: 826ab3920208ca893863f086e7bfc6629203da24 [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) on Mon Mar 07 09:03:16 PST 2016 -->
<title>Invocation (Quarks v0.4.0)</title>
<meta name="date" content="2016-03-07">
<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="Invocation (Quarks v0.4.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div role="navigation" title ="TOP_Navigation" aria-label ="Top Navigation Bar"/>
<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/Invocation.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><a href="../../../quarks/runtime/etiao/Executable.html" title="class in quarks.runtime.etiao"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../quarks/runtime/etiao/InvocationContext.html" title="class in quarks.runtime.etiao"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?quarks/runtime/etiao/Invocation.html" target="_top">Frames</a></li>
<li><a href="Invocation.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 role="main" title ="Invocation" aria-labelledby ="Header1"/>
<div class="header">
<div class="subTitle">quarks.runtime.etiao</div>
<h2 title="Class Invocation" class="title" id="Header1">Class Invocation&lt;T extends <a href="../../../quarks/oplet/Oplet.html" title="interface in quarks.oplet">Oplet</a>&lt;I,O&gt;,I,O&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>quarks.runtime.etiao.Invocation&lt;T,I,O&gt;</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>T</code> - Oplet type.</dd>
<dd><code>I</code> - Data container type for input tuples.</dd>
<dd><code>O</code> - Data container type for output tuples.</dd>
</dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.AutoCloseable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">Invocation&lt;T extends <a href="../../../quarks/oplet/Oplet.html" title="interface in quarks.oplet">Oplet</a>&lt;I,O&gt;,I,O&gt;</span>
extends java.lang.Object
implements java.lang.AutoCloseable</pre>
<div class="block">An <a href="../../../quarks/oplet/Oplet.html" title="interface in quarks.oplet"><code>Oplet</code></a> invocation in the context of the
<a href="../../../quarks/runtime/etiao/package-summary.html">ETIAO</a> runtime.</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>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/runtime/etiao/Invocation.html#ID_PREFIX">ID_PREFIX</a></span></code>
<div class="block">Prefix used by oplet unique identifiers.</div>
</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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/runtime/etiao/Invocation.html#Invocation-java.lang.String-T-int-int-">Invocation</a></span>(java.lang.String&nbsp;id,
<a href="../../../quarks/runtime/etiao/Invocation.html" title="type parameter in Invocation">T</a>&nbsp;oplet,
int&nbsp;inputCount,
int&nbsp;outputCount)</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></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>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/runtime/etiao/Invocation.html#addOutput--">addOutput</a></span>()</code>
<div class="block">Adds a new output.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/runtime/etiao/Invocation.html#close--">close</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/runtime/etiao/Invocation.html#disconnect-int-">disconnect</a></span>(int&nbsp;port)</code>
<div class="block">Disconnects the specified port by connecting to a no-op <code>Consumer</code> implementation.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/runtime/etiao/Invocation.html#getId--">getId</a></span>()</code>
<div class="block">Returns the unique identifier associated with this <code>Invocation</code>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.util.List&lt;? extends <a href="../../../quarks/function/Consumer.html" title="interface in quarks.function">Consumer</a>&lt;<a href="../../../quarks/runtime/etiao/Invocation.html" title="type parameter in Invocation">I</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/runtime/etiao/Invocation.html#getInputs--">getInputs</a></span>()</code>
<div class="block">Returns the list of input stream forwarders for this invocation.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../quarks/runtime/etiao/Invocation.html" title="type parameter in Invocation">T</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/runtime/etiao/Invocation.html#getOplet--">getOplet</a></span>()</code>
<div class="block">Returns the oplet associated with this <code>Invocation</code>.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/runtime/etiao/Invocation.html#getOutputCount--">getOutputCount</a></span>()</code>
<div class="block">Returns the number of outputs for this invocation.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/runtime/etiao/Invocation.html#initialize-quarks.oplet.JobContext-quarks.execution.services.RuntimeServices-">initialize</a></span>(<a href="../../../quarks/oplet/JobContext.html" title="interface in quarks.oplet">JobContext</a>&nbsp;job,
<a href="../../../quarks/execution/services/RuntimeServices.html" title="interface in quarks.execution.services">RuntimeServices</a>&nbsp;services)</code>
<div class="block">Initialize the invocation.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/runtime/etiao/Invocation.html#setTarget-int-quarks.function.Consumer-">setTarget</a></span>(int&nbsp;port,
<a href="../../../quarks/function/Consumer.html" title="interface in quarks.function">Consumer</a>&lt;<a href="../../../quarks/runtime/etiao/Invocation.html" title="type parameter in Invocation">O</a>&gt;&nbsp;target)</code>
<div class="block">Disconnects the specified port and reconnects it to the specified target.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/runtime/etiao/Invocation.html#start--">start</a></span>()</code>
<div class="block">Start the oplet.</div>
</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.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="ID_PREFIX">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ID_PREFIX</h4>
<pre>public static final&nbsp;java.lang.String ID_PREFIX</pre>
<div class="block">Prefix used by oplet unique identifiers.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#quarks.runtime.etiao.Invocation.ID_PREFIX">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Invocation-java.lang.String-quarks.oplet.Oplet-int-int-">
<!-- -->
</a><a name="Invocation-java.lang.String-T-int-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Invocation</h4>
<pre>protected&nbsp;Invocation(java.lang.String&nbsp;id,
<a href="../../../quarks/runtime/etiao/Invocation.html" title="type parameter in Invocation">T</a>&nbsp;oplet,
int&nbsp;inputCount,
int&nbsp;outputCount)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>public&nbsp;java.lang.String&nbsp;getId()</pre>
<div class="block">Returns the unique identifier associated with this <code>Invocation</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>unique identifier</dd>
</dl>
</li>
</ul>
<a name="getOplet--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOplet</h4>
<pre>public&nbsp;<a href="../../../quarks/runtime/etiao/Invocation.html" title="type parameter in Invocation">T</a>&nbsp;getOplet()</pre>
<div class="block">Returns the oplet associated with this <code>Invocation</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the oplet associated with this invocation</dd>
</dl>
</li>
</ul>
<a name="getOutputCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputCount</h4>
<pre>public&nbsp;int&nbsp;getOutputCount()</pre>
<div class="block">Returns the number of outputs for this invocation.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of outputs</dd>
</dl>
</li>
</ul>
<a name="addOutput--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addOutput</h4>
<pre>public&nbsp;int&nbsp;addOutput()</pre>
<div class="block">Adds a new output. By default, the output is connected to a Consumer
that discards all items passed to it.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the index of the new output</dd>
</dl>
</li>
</ul>
<a name="disconnect-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>disconnect</h4>
<pre>public&nbsp;void&nbsp;disconnect(int&nbsp;port)</pre>
<div class="block">Disconnects the specified port by connecting to a no-op <code>Consumer</code> implementation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>port</code> - the port index</dd>
</dl>
</li>
</ul>
<a name="setTarget-int-quarks.function.Consumer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTarget</h4>
<pre>public&nbsp;void&nbsp;setTarget(int&nbsp;port,
<a href="../../../quarks/function/Consumer.html" title="interface in quarks.function">Consumer</a>&lt;<a href="../../../quarks/runtime/etiao/Invocation.html" title="type parameter in Invocation">O</a>&gt;&nbsp;target)</pre>
<div class="block">Disconnects the specified port and reconnects it to the specified target.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>port</code> - index of the port which is reconnected</dd>
<dd><code>target</code> - target the port gets connected to</dd>
</dl>
</li>
</ul>
<a name="getInputs--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputs</h4>
<pre>public&nbsp;java.util.List&lt;? extends <a href="../../../quarks/function/Consumer.html" title="interface in quarks.function">Consumer</a>&lt;<a href="../../../quarks/runtime/etiao/Invocation.html" title="type parameter in Invocation">I</a>&gt;&gt;&nbsp;getInputs()</pre>
<div class="block">Returns the list of input stream forwarders for this invocation.</div>
</li>
</ul>
<a name="initialize-quarks.oplet.JobContext-quarks.execution.services.RuntimeServices-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre>public&nbsp;void&nbsp;initialize(<a href="../../../quarks/oplet/JobContext.html" title="interface in quarks.oplet">JobContext</a>&nbsp;job,
<a href="../../../quarks/execution/services/RuntimeServices.html" title="interface in quarks.execution.services">RuntimeServices</a>&nbsp;services)</pre>
<div class="block">Initialize the invocation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>job</code> - the context of the current job</dd>
<dd><code>services</code> - service provider for this invocation</dd>
</dl>
</li>
</ul>
<a name="start--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public&nbsp;void&nbsp;start()</pre>
<div class="block">Start the oplet. Oplets must not submit any tuples not derived from
input tuples until this method is called.</div>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
throws java.lang.Exception</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div role="navigation" title ="Bottom_NAVIGATION" aria-label ="Bottom Navigation Bar"/>
<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/Invocation.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 class="aboutLanguage"><a href="http://quarks-edge.github.io">quarks-edge community @ github.com</a></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../quarks/runtime/etiao/Executable.html" title="class in quarks.runtime.etiao"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../quarks/runtime/etiao/InvocationContext.html" title="class in quarks.runtime.etiao"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?quarks/runtime/etiao/Invocation.html" target="_top">Frames</a></li>
<li><a href="Invocation.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 ======= -->
<div role="contentinfo" title ="contentinfo_title" aria-label ="Contains footer note"/>
<p class="legalCopy"><small>Copyright IBM 2015,2016 - 2f6ad0e-20160307-0902</small></p>
</body>
</html>