Package org.apache.uima.flow
Interface FlowControllerContext
-
- All Superinterfaces:
UimaContext
- All Known Implementing Classes:
FlowControllerContext_impl
public interface FlowControllerContext extends UimaContext
A subtype ofUimaContext
used byFlowController
components. In addition to access to resources and configuration settings (provided byUimaContext
), theFlowControllerContext
provides access to other information that the FlowController can use to make routing decisions. This includes:- A map from AnalysisEngine key to AnalysisEngineMetaData for all AnalysisEngines that the FlowController can route CASes to
- Declared Capabilities of the Aggregate AnalysisEngine containing this FlowController.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AnalysisEngineMetaData
getAggregateMetadata()
Gets the metadata of the Aggregate AnalysisEngine containing this FlowController.java.util.Map<java.lang.String,AnalysisEngineMetaData>
getAnalysisEngineMetaDataMap()
Gets a map from Analysis Engine key (a String) toAnalysisEngineMetaData
.-
Methods inherited from interface org.apache.uima.UimaContext
getConfigParameterNames, getConfigParameterNames, getConfigParameterValue, getConfigParameterValue, getConfigurationGroupNames, getDataPath, getDataPathElements, getEmptyCas, getExternalOverrides, getInstrumentationFacility, getLogger, getResourceAsStream, getResourceAsStream, getResourceFilePath, getResourceFilePath, getResourceObject, getResourceObject, getResourceURI, getResourceURI, getResourceURL, getResourceURL, getSession, getSharedSettingArray, getSharedSettingNames, getSharedSettingValue, getSofaMappings, mapSofaIDToComponentSofaName, mapToSofaID
-
-
-
-
Method Detail
-
getAnalysisEngineMetaDataMap
java.util.Map<java.lang.String,AnalysisEngineMetaData> getAnalysisEngineMetaDataMap()
Gets a map from Analysis Engine key (a String) toAnalysisEngineMetaData
. This map contains an entry for all Analysis Engines to which the FlowController can route CASes.- Returns:
- a map with
String
keys, andAnalysisEngineMetaData
values
-
getAggregateMetadata
AnalysisEngineMetaData getAggregateMetadata()
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.- Returns:
- the Capabilities of the aggregate containing this FlowController.
-
-