Class AnalysisEngineMetaData_impl
- All Implemented Interfaces:
Serializable,Cloneable,AnalysisEngineMetaData,MetaDataObject,ProcessingResourceMetaData,ResourceMetaData,XMLizable
- Direct Known Subclasses:
ProcessingResourceMetaData_impl
AnalysisEngineMetaData.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
MetaDataObject_impl.MetaDataAttr, MetaDataObject_impl.SerialContext, MetaDataObject_impl.Serializer -
Field Summary
Fields inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
serialContext -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid_setDelegateAnalysisEngineMetaData(AnalysisEngineMetaData[] aMetaData) Used internally to set the AnalysisEngine metadata.Retrieves this Processing Resource'sCapabilities.For 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.Retrieves the FS Index collection used by this Processing Resource.Retrieves the Feature Structure indexes by this Processing Resource.Gets this Processing Resource'sOperationalProperties.Retrieves the Type Priorites for this Processing Resource.Retrieves the Type System used by this Processing Resource.protected XmlizationInfoTo be implemented by subclasses to return information describing how to represent this object in XML.protected static XmlizationInfoStatic method to get XmlizationInfo, used by subclasses to set up their own XmlizationInfo.booleanDetermines if this AnalysisEngine supports asynchronous communication.booleanGets whether this AE is sofa-aware.protected voidreadPropertyValueFromXMLElement(PropertyXmlInfo aPropXmlInfo, Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) Utility method to read an attribute's value from its DOM representation.protected voidreadUnknownPropertyValueFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions, List<String> aKnownPropertyNames) Utility method that attempts to read a property value from an XML element even though it is not known to which property the value should be assigned.voidResolves any import declarations throughout this metadata.voidresolveImports(ResourceManager aResourceManager) Resolves any import declarations throughout this metadata.voidsetAsynchronousModeSupported(boolean aSupported) Sets whether this AnalysisEngine supports asynchronous communication.voidsetCapabilities(Capability[] aCapabilities) Sets this Processing Resource'sCapabilities.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.voidsetFsIndexCollection(FsIndexCollection aFsIndexCollection) Sets the Feature Structure Index collection used by this Processing Resource.voidsetFsIndexes(FsIndexDescription[] aFsIndexes) Sets the Feature Structure indexes by this Processing Resource.voidsetOperationalProperties(OperationalProperties aOperationalProperties) Sets this Processing Resource'sOperationalProperties.voidsetTypePriorities(TypePriorities aTypePriorities) Retrieves the Type Priorites for this Processing Resource.voidsetTypeSystem(TypeSystemDescription aTypeSystem) Retrieves the Type System used by this Processing Resource.protected voidwritePropertyAsElement(PropertyXmlInfo aPropInfo, String aNamespace) Utility method used to write a property out as an XML element.Methods inherited from class org.apache.uima.resource.metadata.impl.ResourceMetaData_impl
buildFromXMLElement, getClassForParameterType, getConfigurationParameterDeclarations, getConfigurationParameterSettings, getCopyright, getDescription, getName, getUUID, getVendor, getVersion, setConfigurationParameterDeclarations, setConfigurationParameterSettings, setCopyright, setDescription, setName, setUUID, setVendor, setVersion, validateConfigurationParameterDataTypeMatch, validateConfigurationParameterSettings, validateConfigurationParameterSettingsMethods inherited from class org.apache.uima.resource.metadata.impl.MetaDataObject_impl
buildFromXMLElement, clone, equals, getAdditionalAttributes, getAttributeClass, getAttributeValue, getInfoset, getMatchingNode, getPropertyDescriptors, getPropertyXmlInfo, getRelativePathBase, getSerialContext, getSourceUrl, getSourceUrlString, getWrapperClass, getXMLAttributes, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, resolveSettings, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXmlMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods 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.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
-
Constructor Details
-
AnalysisEngineMetaData_impl
public AnalysisEngineMetaData_impl()
-
-
Method Details
-
resolveImports
Description copied from interface:ResourceMetaDataResolves any import declarations throughout this metadata. This base interface cannot contain any interfaces, but subinterfaces may introduce new properties that can have imports that need to be resolved.- Specified by:
resolveImportsin interfaceProcessingResourceMetaData- Specified by:
resolveImportsin interfaceResourceMetaData- Overrides:
resolveImportsin classResourceMetaData_impl- Throws:
InvalidXMLException- if either the import target does not exist or is invalid- See Also:
-
resolveImports
Description copied from interface:ResourceMetaDataResolves any import declarations throughout this metadata. This base interface cannot contain any interfaces, but subinterfaces may introduce new properties that can have imports that need to be resolved.- Specified by:
resolveImportsin interfaceProcessingResourceMetaData- Specified by:
resolveImportsin interfaceResourceMetaData- Overrides:
resolveImportsin classResourceMetaData_impl- Parameters:
aResourceManager- the Resource Manager used to locate descriptors imported by name. For example, the path in which to locate these descriptors can be set via theResourceManager.setDataPath(String)method.- Throws:
InvalidXMLException- if either the import target does not exist or is invalid- See Also:
-
getCapabilities
Description copied from interface:ProcessingResourceMetaDataRetrieves this Processing Resource'sCapabilities. Each capability consists of a set of features or types that this Resource inputs and outputs, along with the preconditions (e.g. language or mime type) on the input Entity.- Specified by:
getCapabilitiesin interfaceProcessingResourceMetaData- Returns:
- an array of
Capabilities. - See Also:
-
setCapabilities
Description copied from interface:ProcessingResourceMetaDataSets this Processing Resource'sCapabilities. Each capability consists of a set of features or types that this Resource inputs and outputs, along with the preconditions (e.g. language or mime type) on the input Entity.- Specified by:
setCapabilitiesin interfaceProcessingResourceMetaData- Parameters:
aCapabilities- an array ofCapabilities.- See Also:
-
getTypeSystem
Description copied from interface:ProcessingResourceMetaDataRetrieves the Type System used by this Processing Resource. The Type System containsTypeDescriptions andFeatureDescriptions that are the inputs and/or outputs of this Resource. Some Processing Resources, such as aggregate analysis engines, may not contain a type system and returnnull.- Specified by:
getTypeSystemin interfaceProcessingResourceMetaData- Returns:
- a description of the type system used by this Resource
- See Also:
-
setTypeSystem
Description copied from interface:ProcessingResourceMetaDataRetrieves the Type System used by this Processing Resource. The Type System containsTypeDescriptions andFeatureDescriptions that are the inputs and/or outputs of this Resource.- Specified by:
setTypeSystemin interfaceProcessingResourceMetaData- Parameters:
aTypeSystem- a description of the type system used by this Resource.- See Also:
-
getTypePriorities
Description copied from interface:ProcessingResourceMetaDataRetrieves the Type Priorites for this Processing Resource. Type Priorities may be used to determine the sort order of CAS indexes - seeProcessingResourceMetaData.getFsIndexes().- Specified by:
getTypePrioritiesin interfaceProcessingResourceMetaData- Returns:
- the Type Priorities for Resource
- See Also:
-
setTypePriorities
Description copied from interface:ProcessingResourceMetaDataRetrieves the Type Priorites for this Processing Resource. Type Priorities may be used to determine the sort order of CAS indexes - seeProcessingResourceMetaData.getFsIndexes().- Specified by:
setTypePrioritiesin interfaceProcessingResourceMetaData- Parameters:
aTypePriorities- the Type Priorities for this Resource- See Also:
-
getFsIndexCollection
Description copied from interface:ProcessingResourceMetaDataRetrieves the FS Index collection used by this Processing Resource. FS Indexes are used to iterate over annotations in theCAS.- Specified by:
getFsIndexCollectionin interfaceProcessingResourceMetaData- Returns:
- a description of the Feature Structure indexes used by this Resource.
- See Also:
-
setFsIndexCollection
Description copied from interface:ProcessingResourceMetaDataSets the Feature Structure Index collection used by this Processing Resource. FS Indexes are used to iterate over annotations in theCAS.- Specified by:
setFsIndexCollectionin interfaceProcessingResourceMetaData- Parameters:
aFsIndexCollection- a description of the Feature Structure indexes used by this Resource.- See Also:
-
getFsIndexes
Description copied from interface:ProcessingResourceMetaDataRetrieves the Feature Structure indexes by this Processing Resource. These are used to iterate over annotations in theCAS.NOTE: this method predates the
FsIndexCollectionobject, which may define additional information (name, description, vendor, version) and import other FsIndexCollections, and provides direct access to theFsIndexDescriptionobjects. To access theFsIndexCollectionobject, callProcessingResourceMetaData.getFsIndexCollection().- Specified by:
getFsIndexesin interfaceProcessingResourceMetaData- Returns:
- a description of the Feature Structure indexes used by this Resource.
- See Also:
-
setFsIndexes
Description copied from interface:ProcessingResourceMetaDataSets the Feature Structure indexes by this Processing Resource. These are used to iterate over annotations in theCAS.NOTE: this method predates the
FsIndexCollectionobject, which may define additional information (name, description, vendor, version) and import other FsIndexCollections, and provides direct access to theFsIndexDescriptionobjects. To access theFsIndexCollectionobject, callProcessingResourceMetaData.getFsIndexCollection().- Specified by:
setFsIndexesin interfaceProcessingResourceMetaData- Parameters:
aFsIndexes- a description of the Feature Structure indexes used by this Resource.- See Also:
-
getOperationalProperties
Description copied from interface:ProcessingResourceMetaDataGets this Processing Resource'sOperationalProperties. This includes information such as whether this component will modify the CAS, and whether multiple instances of this component can be run in parallel.- Specified by:
getOperationalPropertiesin interfaceProcessingResourceMetaData- Returns:
- operational properties for this component
-
setOperationalProperties
Description copied from interface:ProcessingResourceMetaDataSets this Processing Resource'sOperationalProperties. This includes information such as whether this component will modify the CAS, and whether multiple instances of this component can be run in parallel.- Specified by:
setOperationalPropertiesin interfaceProcessingResourceMetaData- Parameters:
aOperationalProperties- operational properties for this component
-
writePropertyAsElement
protected void writePropertyAsElement(PropertyXmlInfo aPropInfo, String aNamespace) throws SAXException Description copied from class:MetaDataObject_implUtility method used to write a property out as an XML element.- Overrides:
writePropertyAsElementin classMetaDataObject_impl- Parameters:
aPropInfo- information on how to represent the property in XMLaNamespace- XML namespace URI for this object representation- Throws:
SAXException- -
-
readPropertyValueFromXMLElement
protected void readPropertyValueFromXMLElement(PropertyXmlInfo aPropXmlInfo, Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) throws InvalidXMLException Description copied from class:MetaDataObject_implUtility method to read an attribute's value from its DOM representation.- Overrides:
readPropertyValueFromXMLElementin classMetaDataObject_impl- Parameters:
aPropXmlInfo- information about the property to readaElement- DOM element to read fromaParser- parser to use to construct complex valuesaOptions- option settings- Throws:
InvalidXMLException- -
-
readUnknownPropertyValueFromXMLElement
protected void readUnknownPropertyValueFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions, List<String> aKnownPropertyNames) throws InvalidXMLException Description copied from class:MetaDataObject_implUtility method that attempts to read a property value from an XML element even though it is not known to which property the value should be assigned. If an object can be constructed from the XML element, it will be assigned to any unasigned property that can accept it.- Overrides:
readUnknownPropertyValueFromXMLElementin classMetaDataObject_impl- Parameters:
aElement- DOM element to read fromaParser- parser to use to construct complex valuesaOptions- -aKnownPropertyNames- List of propertiees that we've already values for (these values will not be overwritten)- Throws:
InvalidXMLException- if no acceptable object is described by aElement
-
isAsynchronousModeSupported
public boolean isAsynchronousModeSupported()Description copied from interface:AnalysisEngineMetaDataDetermines if this AnalysisEngine supports asynchronous communication. Not yet implemented; reserved for future use.- Specified by:
isAsynchronousModeSupportedin interfaceAnalysisEngineMetaData- Returns:
- true if and only if this AnalysisEngine supports asynchronous communication
- See Also:
-
setAsynchronousModeSupported
public void setAsynchronousModeSupported(boolean aSupported) Description copied from interface:AnalysisEngineMetaDataSets whether this AnalysisEngine supports asynchronous communication. If this is set to true then the AnalysisEngine should implement theAsynchronousAnalysisEngineinterface (not yet implemented).- Specified by:
setAsynchronousModeSupportedin interfaceAnalysisEngineMetaData- Parameters:
aSupported- true if and only if this AnalysisEngine supports asynchronous communication- See Also:
-
getFlowConstraints
Description copied from interface:AnalysisEngineMetaDataFor 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.- Specified by:
getFlowConstraintsin interfaceAnalysisEngineMetaData- Returns:
- the flow constraints for the AnalysisEngine, or
nullif no flow constraints are published by this AnalysisEngine. - See Also:
-
setFlowConstraints
Description copied from interface:AnalysisEngineMetaDataFor 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.- Specified by:
setFlowConstraintsin interfaceAnalysisEngineMetaData- Parameters:
aFlowConstraints- the flow constraints for the AnalysisEngine, ornullif there are no flow constraints- See Also:
-
getDelegateAnalysisEngineMetaData
Description copied from interface:AnalysisEngineMetaDataFor an aggregate AnalysisEngine only, gets the metadata of the delegate AnalysisEngines.Publishing this information is optional; some implementations may always return null here.
- Specified by:
getDelegateAnalysisEngineMetaDatain interfaceAnalysisEngineMetaData- Returns:
- an array of delegate AnalysisEngine metadata, or
nullif that information is not available. - See Also:
-
_setDelegateAnalysisEngineMetaData
Used internally to set the AnalysisEngine metadata. Not published through the interface or available to the JavaBeans introspector.- Parameters:
aMetaData- metadata for the delegate AnalysisEngines
-
isSofaAware
public boolean isSofaAware()Gets whether this AE is sofa-aware. This is a derived property that cannot be set directly. An AE is sofa-aware if and only if it declares at least one input sofa or output sofa.- Specified by:
isSofaAwarein interfaceProcessingResourceMetaData- Returns:
- true if this component is sofa-aware, false if it is sofa-unaware.
-
getXmlizationInfo
Description copied from class:MetaDataObject_implTo be implemented by subclasses to return information describing how to represent this object in XML.- Overrides:
getXmlizationInfoin classResourceMetaData_impl- Returns:
- information defining this object's XML representation
-
getXmlizationInfoForClass
Static method to get XmlizationInfo, used by subclasses to set up their own XmlizationInfo.- Returns:
- XmlizationInfo, used by subclasses to set up their own XmlizationInfo.
-