Interface FixedFlow
- All Superinterfaces:
Cloneable,FlowConstraints,MetaDataObject,Serializable,XMLizable
- All Known Implementing Classes:
FixedFlow_impl
A
FixedFlow is a simple type of FlowConstraints that specifies the complete
flow as a fixed sequence.
Each element in the sequence is specified as a String identifier. The FixedFlow
object does not assign any particular meaning to these Strings - it is the user of the
FixedFlow object that must understand how to map them to AnalysisEngines themselves.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe type identifier for this class ofFlowConstraints. -
Method Summary
Modifier and TypeMethodDescriptionString[]Returns the flow as an array.Gets the type of thisFlowConstraintsobject.voidsetFixedFlow(String[] aFlow) Sets the fixed flow.Methods inherited from interface org.apache.uima.analysis_engine.metadata.FlowConstraints
remapIDsMethods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlMethods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
Field Details
-
FLOW_CONSTRAINTS_TYPE
The type identifier for this class ofFlowConstraints. This is the return value ofgetFlowConstraintsType().- See Also:
-
-
Method Details
-
getFlowConstraintsType
String getFlowConstraintsType()Gets the type of thisFlowConstraintsobject. Each sub-interface ofFlowConstraintshas its own standard type identifier String. These identifier Strings are used instead of Java class names in order to ease portability of metadata to other languages.- Specified by:
getFlowConstraintsTypein interfaceFlowConstraints- Returns:
FLOW_CONSTRAINTS_TYPE
-
getFixedFlow
String[] getFixedFlow()Returns the flow as an array. Each element of the array is a String that identifies the AnalysisEngine to invoke at that position in the flow.- Returns:
- an array of AE identifiers.
-
setFixedFlow
Sets the fixed flow.- Parameters:
aFlow- an array of Strings, each of which identifies the AnalysisEngine to invoke at that position in the flow.- Throws:
UIMA_UnsupportedOperationException- if thisMetaDataObjectis not modifiable.
-