Interface CapabilityLanguageFlow

All Superinterfaces:
Cloneable, FlowConstraints, MetaDataObject, Serializable, XMLizable

public interface CapabilityLanguageFlow
extends FlowConstraints

A CapabilityLanguageFlow is a simple type of FlowConstraints that specifies the complete flow as a capabilityLanguage sequence.

Each element in the sequence is specified as a String identifier. In a CapabilityLanguageFlow skipping 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
Method Summary
 String[] getCapabilityLanguageFlow()
          Returns the flow as an array.
 String getFlowConstraintsType()
          Gets the type of this FlowConstraints object.
 void setCapabilityLanguageFlow(String[] aFlow)
          Sets the CapabilityLanguageFlow.
Methods inherited from interface org.apache.uima.analysis_engine.metadata.FlowConstraints
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


static final String FLOW_CONSTRAINTS_TYPE
See Also:
Constant Field Values
Method Detail


String getFlowConstraintsType()
Gets the type of this FlowConstraints object. Each sub-interface of FlowConstraints 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 interface FlowConstraints


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.

an array of AE identifiers.


void setCapabilityLanguageFlow(String[] aFlow)
Sets the CapabilityLanguageFlow.

aFlow - an array of Strings, each of which identifies the AnalysisEngine to invoke at that position in the flow.
UIMA_UnsupportedOperationException - if this MetaDataObject is not modifiable.

Copyright © 2010 The Apache Software Foundation. All Rights Reserved.