|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface AnalysisEngineMetaData
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 | |
|---|---|
AnalysisEngineMetaData[] |
getDelegateAnalysisEngineMetaData()
For an aggregate AnalysisEngine only, gets the metadata of the delegate AnalysisEngines. |
FlowConstraints |
getFlowConstraints()
For an aggregate AnalysisEngine only, gets the constraints on the execution sequence of the delegate AnalysisEngines within the aggregate. |
boolean |
isAsynchronousModeSupported()
Determines if this AnalysisEngine supports asynchronous communication. |
void |
setAsynchronousModeSupported(boolean aSupported)
Sets whether this AnalysisEngine supports asynchronous communication. |
void |
setFlowConstraints(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.ProcessingResourceMetaData |
|---|
getCapabilities, getFsIndexCollection, getFsIndexes, getOperationalProperties, getTypePriorities, getTypeSystem, isSofaAware, resolveImports, resolveImports, setCapabilities, setFsIndexCollection, setFsIndexes, setOperationalProperties, setTypePriorities, setTypeSystem |
| Methods 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, validateConfigurationParameterSettings |
| 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 |
| Method Detail |
|---|
boolean isAsynchronousModeSupported()
void setAsynchronousModeSupported(boolean aSupported)
AsynchronousAnalysisEngine
interface (not yet impleneted).
aSupported - true if and only if this AnalysisEngine supports asynchronous communication
UIMA_UnsupportedOperationException - if this MetaDataObject is not modifiable.FlowConstraints getFlowConstraints()
FlowController, the component which ultimately
determines the flow.
The returned FlowConstraints object refers to the delgate AnalysisEngines using
String keys. These are the keys used to refer to the delegate AnalysisEngines in the
AnalysisEngineDescription.getDelegateAnalysisEngineSpecifiers()
map.
null if no flow
constraints are published by this AnalysisEngine.void setFlowConstraints(FlowConstraints aFlowConstraints)
FlowController, the component which ultimately
determines the flow.
The returned FlowConstraints object refers to the delgate AnalysisEngines using
String keys. These are the keys used to refer to the delegate AnalysisEngines in the
AnalysisEngineDescription.getDelegateAnalysisEngineSpecifiers()
map.
aFlowConstraints - the flow constraints for the AnalysisEngine, or null if there are no
flow constraints
UIMA_UnsupportedOperationException - if this MetaDataObject is not modifiable.AnalysisEngineMetaData[] getDelegateAnalysisEngineMetaData()
Publishing this information is optional; some implementations may always return null here.
null if that
information is not available.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||