blob: b10897064a67a1f3460b416243e3d52bc86de5dd [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:15 PST 2016 -->
<title>Source (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="Source (Quarks v0.4.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":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/Source.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/oplet/core/Sink.html" title="class in quarks.oplet.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../quarks/oplet/core/Split.html" title="class in quarks.oplet.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?quarks/oplet/core/Source.html" target="_top">Frames</a></li>
<li><a href="Source.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>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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div role="main" title ="Source" aria-labelledby ="Header1"/>
<div class="header">
<div class="subTitle">quarks.oplet.core</div>
<h2 title="Class Source" class="title" id="Header1">Class Source&lt;T&gt;</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../quarks/oplet/core/AbstractOplet.html" title="class in quarks.oplet.core">quarks.oplet.core.AbstractOplet</a>&lt;java.lang.Void,T&gt;</li>
<li>
<ul class="inheritance">
<li>quarks.oplet.core.Source&lt;T&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.AutoCloseable, <a href="../../../quarks/oplet/Oplet.html" title="interface in quarks.oplet">Oplet</a>&lt;java.lang.Void,T&gt;</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../quarks/oplet/functional/Events.html" title="class in quarks.oplet.functional">Events</a>, <a href="../../../quarks/oplet/core/PeriodicSource.html" title="class in quarks.oplet.core">PeriodicSource</a>, <a href="../../../quarks/oplet/core/ProcessSource.html" title="class in quarks.oplet.core">ProcessSource</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">Source&lt;T&gt;</span>
extends <a href="../../../quarks/oplet/core/AbstractOplet.html" title="class in quarks.oplet.core">AbstractOplet</a>&lt;java.lang.Void,T&gt;</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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="../../../quarks/oplet/core/Source.html#Source--">Source</a></span>()</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>protected <a href="../../../quarks/function/Consumer.html" title="interface in quarks.function">Consumer</a>&lt;<a href="../../../quarks/oplet/core/Source.html" title="type parameter in Source">T</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/oplet/core/Source.html#getDestination--">getDestination</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../quarks/function/Consumer.html" title="interface in quarks.function">Consumer</a>&lt;java.lang.Void&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/oplet/core/Source.html#getInputs--">getInputs</a></span>()</code>
<div class="block">Get the input stream data handlers for this oplet.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/oplet/core/Source.html#initialize-quarks.oplet.OpletContext-">initialize</a></span>(<a href="../../../quarks/oplet/OpletContext.html" title="interface in quarks.oplet">OpletContext</a>&lt;java.lang.Void,<a href="../../../quarks/oplet/core/Source.html" title="type parameter in Source">T</a>&gt;&nbsp;context)</code>
<div class="block">Initialize the oplet.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../quarks/oplet/core/Source.html#submit-T-">submit</a></span>(<a href="../../../quarks/oplet/core/Source.html" title="type parameter in Source">T</a>&nbsp;tuple)</code>
<div class="block">Submit a tuple to single output.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.quarks.oplet.core.AbstractOplet">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;quarks.oplet.core.<a href="../../../quarks/oplet/core/AbstractOplet.html" title="class in quarks.oplet.core">AbstractOplet</a></h3>
<code><a href="../../../quarks/oplet/core/AbstractOplet.html#getOpletContext--">getOpletContext</a></code></li>
</ul>
<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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.quarks.oplet.Oplet">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;quarks.oplet.<a href="../../../quarks/oplet/Oplet.html" title="interface in quarks.oplet">Oplet</a></h3>
<code><a href="../../../quarks/oplet/Oplet.html#start--">start</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.AutoCloseable">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.AutoCloseable</h3>
<code>close</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Source--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Source</h4>
<pre>public&nbsp;Source()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="initialize-quarks.oplet.OpletContext-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialize</h4>
<pre>public&nbsp;void&nbsp;initialize(<a href="../../../quarks/oplet/OpletContext.html" title="interface in quarks.oplet">OpletContext</a>&lt;java.lang.Void,<a href="../../../quarks/oplet/core/Source.html" title="type parameter in Source">T</a>&gt;&nbsp;context)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../quarks/oplet/Oplet.html#initialize-quarks.oplet.OpletContext-">Oplet</a></code></span></div>
<div class="block">Initialize the oplet.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../quarks/oplet/Oplet.html#initialize-quarks.oplet.OpletContext-">initialize</a></code>&nbsp;in interface&nbsp;<code><a href="../../../quarks/oplet/Oplet.html" title="interface in quarks.oplet">Oplet</a>&lt;java.lang.Void,<a href="../../../quarks/oplet/core/Source.html" title="type parameter in Source">T</a>&gt;</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../quarks/oplet/core/AbstractOplet.html#initialize-quarks.oplet.OpletContext-">initialize</a></code>&nbsp;in class&nbsp;<code><a href="../../../quarks/oplet/core/AbstractOplet.html" title="class in quarks.oplet.core">AbstractOplet</a>&lt;java.lang.Void,<a href="../../../quarks/oplet/core/Source.html" title="type parameter in Source">T</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a name="getDestination--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDestination</h4>
<pre>protected&nbsp;<a href="../../../quarks/function/Consumer.html" title="interface in quarks.function">Consumer</a>&lt;<a href="../../../quarks/oplet/core/Source.html" title="type parameter in Source">T</a>&gt;&nbsp;getDestination()</pre>
</li>
</ul>
<a name="submit-java.lang.Object-">
<!-- -->
</a><a name="submit-T-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>submit</h4>
<pre>protected&nbsp;void&nbsp;submit(<a href="../../../quarks/oplet/core/Source.html" title="type parameter in Source">T</a>&nbsp;tuple)</pre>
<div class="block">Submit a tuple to single output.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tuple</code> - Tuple to be submitted.</dd>
</dl>
</li>
</ul>
<a name="getInputs--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getInputs</h4>
<pre>public final&nbsp;java.util.List&lt;<a href="../../../quarks/function/Consumer.html" title="interface in quarks.function">Consumer</a>&lt;java.lang.Void&gt;&gt;&nbsp;getInputs()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../quarks/oplet/Oplet.html#getInputs--">Oplet</a></code></span></div>
<div class="block">Get the input stream data handlers for this oplet. The number of handlers
must equal the number of configured input ports. Each tuple
arriving on an input port will be sent to the stream handler for that
input port.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of consumers</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/Source.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/oplet/core/Sink.html" title="class in quarks.oplet.core"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../quarks/oplet/core/Split.html" title="class in quarks.oplet.core"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?quarks/oplet/core/Source.html" target="_top">Frames</a></li>
<li><a href="Source.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>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 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>