Interface AnalysisEngineMetaData
- All Superinterfaces:
Cloneable,MetaDataObject,ProcessingResourceMetaData,ResourceMetaData,Serializable,XMLizable
- All Known Implementing Classes:
AnalysisEngineMetaData_impl,ProcessingResourceMetaData_impl
Encapsulates all of the metadata for an Analysis Engine.
As with all
MetaDataObjects, an
AnalysisEngineMetaData may or may not be modifiable. An application can find out by
calling the MetaDataObject.isModifiable() method.-
Method Summary
Modifier and TypeMethodDescriptionFor an aggregate AnalysisEngine only, gets the metadata of the delegate AnalysisEngines.For an aggregate AnalysisEngine only, gets the constraints on the execution sequence of the delegate AnalysisEngines within the aggregate.booleanDetermines if this AnalysisEngine supports asynchronous communication.voidsetAsynchronousModeSupported(boolean aSupported) Sets whether this AnalysisEngine supports asynchronous communication.voidsetFlowConstraints(FlowConstraints aFlowConstraints) For an aggregate AnalysisEngine only, sets the constraints on the execution sequence of the delegate AnalysisEngines within the aggregate.Flow constraints are optional.Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlMethods inherited from interface org.apache.uima.resource.metadata.ProcessingResourceMetaData
getCapabilities, getFsIndexCollection, getFsIndexes, getOperationalProperties, getTypePriorities, getTypeSystem, isSofaAware, resolveImports, resolveImports, setCapabilities, setFsIndexCollection, setFsIndexes, setOperationalProperties, setTypePriorities, setTypeSystemMethods inherited from interface org.apache.uima.resource.metadata.ResourceMetaData
getConfigurationParameterDeclarations, getConfigurationParameterSettings, getCopyright, getDescription, getName, getUUID, getVendor, getVersion, setConfigurationParameterDeclarations, setConfigurationParameterSettings, setCopyright, setDescription, setName, setUUID, setVendor, setVersion, validateConfigurationParameterSettingsMethods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
Method Details
-
isAsynchronousModeSupported
boolean isAsynchronousModeSupported()Determines if this AnalysisEngine supports asynchronous communication. Not yet implemented; reserved for future use.- Returns:
- true if and only if this AnalysisEngine supports asynchronous communication
-
setAsynchronousModeSupported
void setAsynchronousModeSupported(boolean aSupported) Sets whether this AnalysisEngine supports asynchronous communication. If this is set to true then the AnalysisEngine should implement theAsynchronousAnalysisEngineinterface (not yet implemented).- Parameters:
aSupported- true if and only if this AnalysisEngine supports asynchronous communication- Throws:
UIMA_UnsupportedOperationException- if thisMetaDataObjectis not modifiable.
-
getFlowConstraints
FlowConstraints getFlowConstraints()For an aggregate AnalysisEngine only, gets the constraints on the execution sequence of the delegate AnalysisEngines within the aggregate. Flow constraints are optional. If provided they may be used by theFlowController, the component which ultimately determines the flow.The returned
FlowConstraintsobject refers to the delegate AnalysisEngines using String keys. These are the keys used to refer to the delegate AnalysisEngines in theAnalysisEngineDescription.getDelegateAnalysisEngineSpecifiers()map.- Returns:
- the flow constraints for the AnalysisEngine, or
nullif no flow constraints are published by this AnalysisEngine.
-
setFlowConstraints
For an aggregate AnalysisEngine only, sets the constraints on the execution sequence of the delegate AnalysisEngines within the aggregate.Flow constraints are optional. If provided they may be used by theFlowController, the component which ultimately determines the flow.The returned
FlowConstraintsobject refers to the delgate AnalysisEngines using String keys. These are the keys used to refer to the delegate AnalysisEngines in theAnalysisEngineDescription.getDelegateAnalysisEngineSpecifiers()map.- Parameters:
aFlowConstraints- the flow constraints for the AnalysisEngine, ornullif there are no flow constraints- Throws:
UIMA_UnsupportedOperationException- if thisMetaDataObjectis not modifiable.
-
getDelegateAnalysisEngineMetaData
AnalysisEngineMetaData[] getDelegateAnalysisEngineMetaData()For an aggregate AnalysisEngine only, gets the metadata of the delegate AnalysisEngines.Publishing this information is optional; some implementations may always return null here.
- Returns:
- an array of delegate AnalysisEngine metadata, or
nullif that information is not available.
-