| <!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 --> | |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <title>FlowControllerContext (Apache UIMA Java SDK 3.0.2 User-Level API Documentation)</title> | |
| <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="FlowControllerContext (Apache UIMA Java SDK 3.0.2 User-Level API Documentation)"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| var methods = {"i0":6,"i1":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 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/FlowControllerContext.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="../../../../org/apache/uima/flow/FlowController_ImplBase.html" title="class in org.apache.uima.flow"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../org/apache/uima/flow/FlowControllerDescription.html" title="interface in org.apache.uima.flow"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../index.html?org/apache/uima/flow/FlowControllerContext.html" target="_top">Frames</a></li> | |
| <li><a href="FlowControllerContext.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 class="header"> | |
| <div class="subTitle">org.apache.uima.flow</div> | |
| <h2 title="Interface FlowControllerContext" class="title">Interface FlowControllerContext</h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <dl> | |
| <dt>All Superinterfaces:</dt> | |
| <dd><a href="../../../../org/apache/uima/UimaContext.html" title="interface in org.apache.uima">UimaContext</a></dd> | |
| </dl> | |
| <hr> | |
| <br> | |
| <pre>public interface <span class="typeNameLabel">FlowControllerContext</span> | |
| extends <a href="../../../../org/apache/uima/UimaContext.html" title="interface in org.apache.uima">UimaContext</a></pre> | |
| <div class="block">A subtype of <a href="../../../../org/apache/uima/UimaContext.html" title="interface in org.apache.uima"><code>UimaContext</code></a> used by <a href="../../../../org/apache/uima/flow/FlowController.html" title="interface in org.apache.uima.flow"><code>FlowController</code></a> components. In addition to access | |
| to resources and configuration settings (provided by <code>UimaContext</code>), the | |
| <code>FlowControllerContext</code> provides access to other information that the FlowController | |
| can use to make routing decisions. This includes: | |
| <ul> | |
| <li>A map from AnalysisEngine key to AnalysisEngineMetaData for all AnalysisEngines that the | |
| FlowController can route CASes to</li> | |
| <li>Declared Capabilities of the Aggregate AnalysisEngine containing this FlowController.</li> | |
| </ul></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><a href="../../../../org/apache/uima/analysis_engine/metadata/AnalysisEngineMetaData.html" title="interface in org.apache.uima.analysis_engine.metadata">AnalysisEngineMetaData</a></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/flow/FlowControllerContext.html#getAggregateMetadata--">getAggregateMetadata</a></span>()</code> | |
| <div class="block">Gets the metadata of the Aggregate AnalysisEngine containing this FlowController.</div> | |
| </td> | |
| </tr> | |
| <tr id="i1" class="rowColor"> | |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/uima/analysis_engine/metadata/AnalysisEngineMetaData.html" title="interface in org.apache.uima.analysis_engine.metadata">AnalysisEngineMetaData</a>></code></td> | |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/uima/flow/FlowControllerContext.html#getAnalysisEngineMetaDataMap--">getAnalysisEngineMetaDataMap</a></span>()</code> | |
| <div class="block">Gets a map from Analysis Engine key (a String) to <a href="../../../../org/apache/uima/analysis_engine/metadata/AnalysisEngineMetaData.html" title="interface in org.apache.uima.analysis_engine.metadata"><code>AnalysisEngineMetaData</code></a>.</div> | |
| </td> | |
| </tr> | |
| </table> | |
| <ul class="blockList"> | |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.uima.UimaContext"> | |
| <!-- --> | |
| </a> | |
| <h3>Methods inherited from interface org.apache.uima.<a href="../../../../org/apache/uima/UimaContext.html" title="interface in org.apache.uima">UimaContext</a></h3> | |
| <code><a href="../../../../org/apache/uima/UimaContext.html#getConfigParameterNames--">getConfigParameterNames</a>, <a href="../../../../org/apache/uima/UimaContext.html#getConfigParameterNames-java.lang.String-">getConfigParameterNames</a>, <a href="../../../../org/apache/uima/UimaContext.html#getConfigParameterValue-java.lang.String-">getConfigParameterValue</a>, <a href="../../../../org/apache/uima/UimaContext.html#getConfigParameterValue-java.lang.String-java.lang.String-">getConfigParameterValue</a>, <a href="../../../../org/apache/uima/UimaContext.html#getConfigurationGroupNames--">getConfigurationGroupNames</a>, <a href="../../../../org/apache/uima/UimaContext.html#getDataPath--">getDataPath</a>, <a href="../../../../org/apache/uima/UimaContext.html#getEmptyCas-java.lang.Class-">getEmptyCas</a>, <a href="../../../../org/apache/uima/UimaContext.html#getExternalOverrides--">getExternalOverrides</a>, <a href="../../../../org/apache/uima/UimaContext.html#getInstrumentationFacility--">getInstrumentationFacility</a>, <a href="../../../../org/apache/uima/UimaContext.html#getLogger--">getLogger</a>, <a href="../../../../org/apache/uima/UimaContext.html#getResourceAsStream-java.lang.String-">getResourceAsStream</a>, <a href="../../../../org/apache/uima/UimaContext.html#getResourceAsStream-java.lang.String-java.lang.String:A-">getResourceAsStream</a>, <a href="../../../../org/apache/uima/UimaContext.html#getResourceFilePath-java.lang.String-">getResourceFilePath</a>, <a href="../../../../org/apache/uima/UimaContext.html#getResourceFilePath-java.lang.String-java.lang.String:A-">getResourceFilePath</a>, <a href="../../../../org/apache/uima/UimaContext.html#getResourceObject-java.lang.String-">getResourceObject</a>, <a href="../../../../org/apache/uima/UimaContext.html#getResourceObject-java.lang.String-java.lang.String:A-">getResourceObject</a>, <a href="../../../../org/apache/uima/UimaContext.html#getResourceURI-java.lang.String-">getResourceURI</a>, <a href="../../../../org/apache/uima/UimaContext.html#getResourceURI-java.lang.String-java.lang.String:A-">getResourceURI</a>, <a href="../../../../org/apache/uima/UimaContext.html#getResourceURL-java.lang.String-">getResourceURL</a>, <a href="../../../../org/apache/uima/UimaContext.html#getResourceURL-java.lang.String-java.lang.String:A-">getResourceURL</a>, <a href="../../../../org/apache/uima/UimaContext.html#getSession--">getSession</a>, <a href="../../../../org/apache/uima/UimaContext.html#getSharedSettingArray-java.lang.String-">getSharedSettingArray</a>, <a href="../../../../org/apache/uima/UimaContext.html#getSharedSettingNames--">getSharedSettingNames</a>, <a href="../../../../org/apache/uima/UimaContext.html#getSharedSettingValue-java.lang.String-">getSharedSettingValue</a>, <a href="../../../../org/apache/uima/UimaContext.html#getSofaMappings--">getSofaMappings</a>, <a href="../../../../org/apache/uima/UimaContext.html#mapSofaIDToComponentSofaName-java.lang.String-">mapSofaIDToComponentSofaName</a>, <a href="../../../../org/apache/uima/UimaContext.html#mapToSofaID-java.lang.String-">mapToSofaID</a></code></li> | |
| </ul> | |
| </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="getAnalysisEngineMetaDataMap--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getAnalysisEngineMetaDataMap</h4> | |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="../../../../org/apache/uima/analysis_engine/metadata/AnalysisEngineMetaData.html" title="interface in org.apache.uima.analysis_engine.metadata">AnalysisEngineMetaData</a>> getAnalysisEngineMetaDataMap()</pre> | |
| <div class="block">Gets a map from Analysis Engine key (a String) to <a href="../../../../org/apache/uima/analysis_engine/metadata/AnalysisEngineMetaData.html" title="interface in org.apache.uima.analysis_engine.metadata"><code>AnalysisEngineMetaData</code></a>. This map | |
| contains an entry for all Analysis Engines to which the FlowController can route CASes.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>a map with <code>String</code> keys, and <a href="../../../../org/apache/uima/analysis_engine/metadata/AnalysisEngineMetaData.html" title="interface in org.apache.uima.analysis_engine.metadata"><code>AnalysisEngineMetaData</code></a> values</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a name="getAggregateMetadata--"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>getAggregateMetadata</h4> | |
| <pre><a href="../../../../org/apache/uima/analysis_engine/metadata/AnalysisEngineMetaData.html" title="interface in org.apache.uima.analysis_engine.metadata">AnalysisEngineMetaData</a> getAggregateMetadata()</pre> | |
| <div class="block">Gets the metadata of the Aggregate AnalysisEngine containing this FlowController. This includes | |
| the specification of the inputs and outputs of the aggregate, which may be useful for some | |
| FlowController implementations.</div> | |
| <dl> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the Capabilities of the aggregate containing this FlowController.</dd> | |
| </dl> | |
| </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/FlowControllerContext.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="../../../../org/apache/uima/flow/FlowController_ImplBase.html" title="class in org.apache.uima.flow"><span class="typeNameLink">Prev Class</span></a></li> | |
| <li><a href="../../../../org/apache/uima/flow/FlowControllerDescription.html" title="interface in org.apache.uima.flow"><span class="typeNameLink">Next Class</span></a></li> | |
| </ul> | |
| <ul class="navList"> | |
| <li><a href="../../../../index.html?org/apache/uima/flow/FlowControllerContext.html" target="_top">Frames</a></li> | |
| <li><a href="FlowControllerContext.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 ======= --> | |
| <p class="legalCopy"><small>Copyright © 2006–2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> | |
| </body> | |
| </html> |