Interface FixedFlow
-
- All Superinterfaces:
java.lang.Cloneable
,FlowConstraints
,MetaDataObject
,java.io.Serializable
,XMLizable
- All Known Implementing Classes:
FixedFlow_impl
public interface FixedFlow extends FlowConstraints
AFixedFlow
is a simple type ofFlowConstraints
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 theFixedFlow
object that must understand how to map them to AnalysisEngines themselves.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
FLOW_CONSTRAINTS_TYPE
The type identifier for this class ofFlowConstraints
.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String[]
getFixedFlow()
Returns the flow as an array.java.lang.String
getFlowConstraintsType()
Gets the type of thisFlowConstraints
object.void
setFixedFlow(java.lang.String[] aFlow)
Sets the fixed flow.-
Methods inherited from interface org.apache.uima.analysis_engine.metadata.FlowConstraints
remapIDs
-
Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl
-
Methods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
-
-
-
Field Detail
-
FLOW_CONSTRAINTS_TYPE
static final java.lang.String FLOW_CONSTRAINTS_TYPE
The type identifier for this class ofFlowConstraints
. This is the return value ofgetFlowConstraintsType()
.- See Also:
- Constant Field Values
-
-
Method Detail
-
getFlowConstraintsType
java.lang.String getFlowConstraintsType()
Gets the type of thisFlowConstraints
object. Each sub-interface ofFlowConstraints
has 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:
getFlowConstraintsType
in interfaceFlowConstraints
- Returns:
FLOW_CONSTRAINTS_TYPE
-
getFixedFlow
java.lang.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
void setFixedFlow(java.lang.String[] aFlow)
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 thisMetaDataObject
is not modifiable.
-
-