Interface CapabilityLanguageFlow
-
- All Superinterfaces:
java.lang.Cloneable,FlowConstraints,MetaDataObject,java.io.Serializable,XMLizable
- All Known Implementing Classes:
CapabilityLanguageFlow_impl
public interface CapabilityLanguageFlow extends FlowConstraints
ACapabilityLanguageFlowis a simple type ofFlowConstraintsthat specifies the complete flow as a capabilityLanguage sequence.Each element in the sequence is specified as a String identifier. In a
CapabilityLanguageFlowskipping of the included AnalysisEngines is possible if the document language does not map to the capabilities or the output capability was already done by another AnalysisEngine.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringFLOW_CONSTRAINTS_TYPE
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String[]getCapabilityLanguageFlow()Returns the flow as an array.java.lang.StringgetFlowConstraintsType()Gets the type of thisFlowConstraintsobject.voidsetCapabilityLanguageFlow(java.lang.String[] aFlow)Sets the CapabilityLanguageFlow.-
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
- See Also:
- Constant Field Values
-
-
Method Detail
-
getFlowConstraintsType
java.lang.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
-
getCapabilityLanguageFlow
java.lang.String[] getCapabilityLanguageFlow()
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.
-
setCapabilityLanguageFlow
void setCapabilityLanguageFlow(java.lang.String[] aFlow)
Sets the CapabilityLanguageFlow.- 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.
-
-