| <!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>OpletContext (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="OpletContext (Quarks v0.4.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/OpletContext.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/Oplet.html" title="interface in quarks.oplet"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?quarks/oplet/OpletContext.html" target="_top">Frames</a></li> |
| <li><a href="OpletContext.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 ="OpletContext" aria-labelledby ="Header1"/> |
| <div class="header"> |
| <div class="subTitle">quarks.oplet</div> |
| <h2 title="Interface OpletContext" class="title" id="Header1">Interface OpletContext<I,O></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>I</code> - </dd> |
| <dd><code>O</code> - </dd> |
| </dl> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../quarks/execution/services/RuntimeServices.html" title="interface in quarks.execution.services">RuntimeServices</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../quarks/runtime/etiao/AbstractContext.html" title="class in quarks.runtime.etiao">AbstractContext</a>, <a href="../../quarks/runtime/etiao/InvocationContext.html" title="class in quarks.runtime.etiao">InvocationContext</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">OpletContext<I,O></span> |
| extends <a href="../../quarks/execution/services/RuntimeServices.html" title="interface in quarks.execution.services">RuntimeServices</a></pre> |
| <div class="block">Context information for the <code>Oplet</code>'s invocation context. |
| <P> |
| At execution time an oplet uses its invocation context to retrieve |
| provided <a href="../../quarks/oplet/OpletContext.html#getService-java.lang.Class-"><code>services</code></a>, |
| <a href="../../quarks/oplet/OpletContext.html#getOutputs--"><code>output ports</code></a> for tuple submission |
| and <a href="../../quarks/oplet/OpletContext.html#getJobContext--"><code>job</code></a> information.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../quarks/oplet/OpletContext.html#getId--">getId</a></span>()</code> |
| <div class="block">Get the unique identifier (within the running job) |
| for this oplet.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../quarks/oplet/OpletContext.html#getInputCount--">getInputCount</a></span>()</code> |
| <div class="block">Get the number of connected inputs to this oplet.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../quarks/oplet/JobContext.html" title="interface in quarks.oplet">JobContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../quarks/oplet/OpletContext.html#getJobContext--">getJobContext</a></span>()</code> |
| <div class="block">Get the job hosting this oplet.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../quarks/oplet/OpletContext.html#getOutputCount--">getOutputCount</a></span>()</code> |
| <div class="block">Get the number of connected outputs to this oplet.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.util.List<? extends <a href="../../quarks/function/Consumer.html" title="interface in quarks.function">Consumer</a><<a href="../../quarks/oplet/OpletContext.html" title="type parameter in OpletContext">O</a>>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../quarks/oplet/OpletContext.html#getOutputs--">getOutputs</a></span>()</code> |
| <div class="block">Get the mechanism to submit tuples on an output port.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../quarks/oplet/OpletContext.html#getService-java.lang.Class-">getService</a></span>(java.lang.Class<T> serviceClass)</code> |
| <div class="block">Get a service for this invocation.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../quarks/oplet/OpletContext.html#uniquify-java.lang.String-">uniquify</a></span>(java.lang.String name)</code> |
| <div class="block">Creates a unique name within the context of the current runtime.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ 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>java.lang.String getId()</pre> |
| <div class="block">Get the unique identifier (within the running job) |
| for this oplet.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>unique identifier for this oplet</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getService-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getService</h4> |
| <pre><T> T getService(java.lang.Class<T> serviceClass)</pre> |
| <div class="block">Get a service for this invocation. |
| <P> |
| These services must be provided by all implementations: |
| <UL> |
| <LI> |
| <code>java.util.concurrent.ThreadFactory</code> - Thread factory, runtime code should |
| create new threads using this factory. |
| </LI> |
| <LI> |
| <code>java.util.concurrent.ScheduledExecutorService</code> - Scheduler, runtime code should |
| execute asynchronous and repeating tasks using this scheduler. |
| </LI> |
| </UL> |
| </P> |
| <P> |
| Get a service for this oplet invocation. |
| |
| An invocation of an oplet may get access to services, |
| which provide specific functionality, such as metrics. |
| </P></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../quarks/execution/services/RuntimeServices.html#getService-java.lang.Class-">getService</a></code> in interface <code><a href="../../quarks/execution/services/RuntimeServices.html" title="interface in quarks.execution.services">RuntimeServices</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serviceClass</code> - Type of the service required.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Service of type implementing <code>serviceClass</code> if the |
| container this invocation runs in supports that service, |
| otherwise <code>null</code>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInputCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInputCount</h4> |
| <pre>int getInputCount()</pre> |
| <div class="block">Get the number of connected inputs to this oplet.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of connected inputs to this oplet.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOutputCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutputCount</h4> |
| <pre>int getOutputCount()</pre> |
| <div class="block">Get the number of connected outputs to this oplet.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of connected outputs to this oplet.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOutputs--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOutputs</h4> |
| <pre>java.util.List<? extends <a href="../../quarks/function/Consumer.html" title="interface in quarks.function">Consumer</a><<a href="../../quarks/oplet/OpletContext.html" title="type parameter in OpletContext">O</a>>> getOutputs()</pre> |
| <div class="block">Get the mechanism to submit tuples on an output port.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>list of consumers</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getJobContext--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJobContext</h4> |
| <pre><a href="../../quarks/oplet/JobContext.html" title="interface in quarks.oplet">JobContext</a> getJobContext()</pre> |
| <div class="block">Get the job hosting this oplet.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="../../quarks/oplet/JobContext.html" title="interface in quarks.oplet"><code>JobContext</code></a> hosting this oplet invocation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="uniquify-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>uniquify</h4> |
| <pre>java.lang.String uniquify(java.lang.String name)</pre> |
| <div class="block">Creates a unique name within the context of the current runtime. |
| <p> |
| The default implementation adds a suffix composed of the package |
| name of this interface, the current job and oplet identifiers, |
| all separated by periods (<code>'.'</code>). Developers should use this |
| method to avoid name clashes when they store or register the name in |
| an external container or registry.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - name (possibly non-unique)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>unique name within the context of the current runtime.</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/OpletContext.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/Oplet.html" title="interface in quarks.oplet"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?quarks/oplet/OpletContext.html" target="_top">Frames</a></li> |
| <li><a href="OpletContext.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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> |
