public class AnalysisEngineMetaData_impl extends ResourceMetaData_impl implements AnalysisEngineMetaData
AnalysisEngineMetaData
.MetaDataObject_impl.MetaDataAttr, MetaDataObject_impl.SerialContext, MetaDataObject_impl.Serializer
serialContext
Constructor and Description |
---|
AnalysisEngineMetaData_impl() |
Modifier and Type | Method and Description |
---|---|
void |
_setDelegateAnalysisEngineMetaData(AnalysisEngineMetaData[] aMetaData)
Used internally to set the AnalysisEngine metadata.
|
Capability[] |
getCapabilities()
Retrieves this Processing Resource's
Capabilities . |
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.
|
FsIndexCollection |
getFsIndexCollection()
Retrieves the FS Index collection used by this Processing Resource.
|
FsIndexDescription[] |
getFsIndexes()
Retrieves the Feature Structure indexes by this Processing Resource.
|
OperationalProperties |
getOperationalProperties()
Gets this Processing Resource's
OperationalProperties . |
TypePriorities |
getTypePriorities()
Retrieves the Type Priorites for this Processing Resource.
|
TypeSystemDescription |
getTypeSystem()
Retrieves the Type System used by this Processing Resource.
|
protected XmlizationInfo |
getXmlizationInfo()
To be implemented by subclasses to return information describing how to represent this object
in XML.
|
protected static XmlizationInfo |
getXmlizationInfoForClass()
Static method to get XmlizationInfo, used by subclasses to set up their own XmlizationInfo.
|
boolean |
isAsynchronousModeSupported()
Determines if this AnalysisEngine supports asynchronous communication.
|
boolean |
isSofaAware()
Gets whether this AE is sofa-aware.
|
protected void |
readPropertyValueFromXMLElement(PropertyXmlInfo aPropXmlInfo,
Element aElement,
XMLParser aParser,
XMLParser.ParsingOptions aOptions)
Utility method to read an attribute's value from its DOM representation.
|
protected void |
readUnknownPropertyValueFromXMLElement(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.
|
void |
resolveImports()
Resolves any import declarations throughout this metadata.
|
void |
resolveImports(ResourceManager aResourceManager)
Resolves any import declarations throughout this metadata.
|
void |
setAsynchronousModeSupported(boolean aSupported)
Sets whether this AnalysisEngine supports asynchronous communication.
|
void |
setCapabilities(Capability[] aCapabilities)
Sets this Processing Resource's
Capabilities . |
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.
|
void |
setFsIndexCollection(FsIndexCollection aFsIndexCollection)
Sets the Feature Structure Index collection used by this Processing Resource.
|
void |
setFsIndexes(FsIndexDescription[] aFsIndexes)
Sets the Feature Structure indexes by this Processing Resource.
|
void |
setOperationalProperties(OperationalProperties aOperationalProperties)
Sets this Processing Resource's
OperationalProperties . |
void |
setTypePriorities(TypePriorities aTypePriorities)
Retrieves the Type Priorites for this Processing Resource.
|
void |
setTypeSystem(TypeSystemDescription aTypeSystem)
Retrieves the Type System used by this Processing Resource.
|
protected void |
writePropertyAsElement(PropertyXmlInfo aPropInfo,
String aNamespace)
Utility method used to write a property out as an XML element.
|
buildFromXMLElement, getClassForParameterType, getConfigurationParameterDeclarations, getConfigurationParameterSettings, getCopyright, getDescription, getName, getUUID, getVendor, getVersion, setConfigurationParameterDeclarations, setConfigurationParameterSettings, setCopyright, setDescription, setName, setUUID, setVendor, setVersion, validateConfigurationParameterDataTypeMatch, validateConfigurationParameterSettings, validateConfigurationParameterSettings
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, writeMapPropertyToXml
finalize, getClass, notify, notifyAll, wait, wait, wait
getConfigurationParameterDeclarations, getConfigurationParameterSettings, getCopyright, getDescription, getName, getUUID, getVendor, getVersion, setConfigurationParameterDeclarations, setConfigurationParameterSettings, setCopyright, setDescription, setName, setUUID, setVendor, setVersion, validateConfigurationParameterSettings
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
public void resolveImports() throws InvalidXMLException
ResourceMetaData
resolveImports
in interface ProcessingResourceMetaData
resolveImports
in interface ResourceMetaData
resolveImports
in class ResourceMetaData_impl
InvalidXMLException
- if either the import target does not exist or is invalidResourceMetaData.resolveImports()
public void resolveImports(ResourceManager aResourceManager) throws InvalidXMLException
ResourceMetaData
resolveImports
in interface ProcessingResourceMetaData
resolveImports
in interface ResourceMetaData
resolveImports
in class ResourceMetaData_impl
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 the
ResourceManager.setDataPath(String)
method.InvalidXMLException
- if either the import target does not exist or is invalidResourceMetaData.resolveImports(ResourceManager)
public Capability[] getCapabilities()
ProcessingResourceMetaData
Capabilities
. 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.getCapabilities
in interface ProcessingResourceMetaData
Capabilities
.ProcessingResourceMetaData.getCapabilities()
public void setCapabilities(Capability[] aCapabilities)
ProcessingResourceMetaData
Capabilities
. 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.setCapabilities
in interface ProcessingResourceMetaData
aCapabilities
- an array of Capabilities
.ProcessingResourceMetaData.setCapabilities(Capability[])
public TypeSystemDescription getTypeSystem()
ProcessingResourceMetaData
TypeDescription
s and FeatureDescription
s 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 return null
.getTypeSystem
in interface ProcessingResourceMetaData
ProcessingResourceMetaData.getTypeSystem()
public void setTypeSystem(TypeSystemDescription aTypeSystem)
ProcessingResourceMetaData
TypeDescription
s and FeatureDescription
s that are the inputs and/or outputs
of this Resource.setTypeSystem
in interface ProcessingResourceMetaData
aTypeSystem
- a description of the type system used by this Resource.ProcessingResourceMetaData.setTypeSystem(TypeSystemDescription)
public TypePriorities getTypePriorities()
ProcessingResourceMetaData
ProcessingResourceMetaData.getFsIndexes()
.getTypePriorities
in interface ProcessingResourceMetaData
ProcessingResourceMetaData.getTypePriorities()
public void setTypePriorities(TypePriorities aTypePriorities)
ProcessingResourceMetaData
ProcessingResourceMetaData.getFsIndexes()
.setTypePriorities
in interface ProcessingResourceMetaData
aTypePriorities
- the Type Priorities for this ResourceProcessingResourceMetaData.setTypePriorities(TypePriorities)
public FsIndexCollection getFsIndexCollection()
ProcessingResourceMetaData
CAS
.getFsIndexCollection
in interface ProcessingResourceMetaData
ProcessingResourceMetaData.getFsIndexCollection()
public void setFsIndexCollection(FsIndexCollection aFsIndexCollection)
ProcessingResourceMetaData
CAS
.setFsIndexCollection
in interface ProcessingResourceMetaData
aFsIndexCollection
- a description of the Feature Structure indexes used by this Resource.ProcessingResourceMetaData.setFsIndexCollection(FsIndexCollection)
public FsIndexDescription[] getFsIndexes()
ProcessingResourceMetaData
CAS
.
NOTE: this method predates the FsIndexCollection
object, which may define additional
information (name, description, vendor, version) and import other FsIndexCollections, and
provides direct access to the FsIndexDescription
objects. To access the
FsIndexCollection
object, call ProcessingResourceMetaData.getFsIndexCollection()
.
getFsIndexes
in interface ProcessingResourceMetaData
ProcessingResourceMetaData.getFsIndexes()
public void setFsIndexes(FsIndexDescription[] aFsIndexes)
ProcessingResourceMetaData
CAS
.
NOTE: this method predates the FsIndexCollection
object, which may define additional
information (name, description, vendor, version) and import other FsIndexCollections, and
provides direct access to the FsIndexDescription
objects. To access the
FsIndexCollection
object, call ProcessingResourceMetaData.getFsIndexCollection()
.
setFsIndexes
in interface ProcessingResourceMetaData
aFsIndexes
- a description of the Feature Structure indexes used by this Resource.ProcessingResourceMetaData.setFsIndexes(FsIndexDescription[])
public OperationalProperties getOperationalProperties()
ProcessingResourceMetaData
OperationalProperties
. This includes information such
as whether this component will modify the CAS, and whether multiple instances of this component
can be run in parallel.getOperationalProperties
in interface ProcessingResourceMetaData
public void setOperationalProperties(OperationalProperties aOperationalProperties)
ProcessingResourceMetaData
OperationalProperties
. This includes information such
as whether this component will modify the CAS, and whether multiple instances of this component
can be run in parallel.setOperationalProperties
in interface ProcessingResourceMetaData
aOperationalProperties
- operational properties for this componentprotected void writePropertyAsElement(PropertyXmlInfo aPropInfo, String aNamespace) throws SAXException
MetaDataObject_impl
writePropertyAsElement
in class MetaDataObject_impl
aPropInfo
- information on how to represent the property in XMLaNamespace
- XML namespace URI for this object
representationSAXException
- -protected void readPropertyValueFromXMLElement(PropertyXmlInfo aPropXmlInfo, Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) throws InvalidXMLException
MetaDataObject_impl
readPropertyValueFromXMLElement
in class MetaDataObject_impl
aPropXmlInfo
- information about the property to readaElement
- DOM element to read fromaParser
- parser to use to construct complex valuesaOptions
- option settingsInvalidXMLException
- -protected void readUnknownPropertyValueFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions, List<String> aKnownPropertyNames) throws InvalidXMLException
MetaDataObject_impl
readUnknownPropertyValueFromXMLElement
in class MetaDataObject_impl
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)InvalidXMLException
- if no acceptable object is described by aElementpublic boolean isAsynchronousModeSupported()
AnalysisEngineMetaData
isAsynchronousModeSupported
in interface AnalysisEngineMetaData
AnalysisEngineMetaData.isAsynchronousModeSupported()
public void setAsynchronousModeSupported(boolean aSupported)
AnalysisEngineMetaData
AsynchronousAnalysisEngine
interface (not yet implemented).setAsynchronousModeSupported
in interface AnalysisEngineMetaData
aSupported
- true if and only if this AnalysisEngine supports asynchronous communicationAnalysisEngineMetaData.setAsynchronousModeSupported(boolean)
public FlowConstraints getFlowConstraints()
AnalysisEngineMetaData
FlowController
, the component which ultimately
determines the flow.
The returned FlowConstraints
object refers to the delegate AnalysisEngines using
String keys. These are the keys used to refer to the delegate AnalysisEngines in the
AnalysisEngineDescription.getDelegateAnalysisEngineSpecifiers()
map.
getFlowConstraints
in interface AnalysisEngineMetaData
null
if no flow
constraints are published by this AnalysisEngine.AnalysisEngineMetaData.getFlowConstraints()
public void setFlowConstraints(FlowConstraints aFlowConstraints)
AnalysisEngineMetaData
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.
setFlowConstraints
in interface AnalysisEngineMetaData
aFlowConstraints
- the flow constraints for the AnalysisEngine, or null
if there are no
flow constraintsAnalysisEngineMetaData.setFlowConstraints(FlowConstraints)
public AnalysisEngineMetaData[] getDelegateAnalysisEngineMetaData()
AnalysisEngineMetaData
Publishing this information is optional; some implementations may always return null here.
getDelegateAnalysisEngineMetaData
in interface AnalysisEngineMetaData
null
if that
information is not available.AnalysisEngineMetaData.getDelegateAnalysisEngineMetaData()
public void _setDelegateAnalysisEngineMetaData(AnalysisEngineMetaData[] aMetaData)
aMetaData
- metadata for the delegate AnalysisEnginespublic boolean isSofaAware()
isSofaAware
in interface ProcessingResourceMetaData
protected XmlizationInfo getXmlizationInfo()
MetaDataObject_impl
getXmlizationInfo
in class ResourceMetaData_impl
protected static XmlizationInfo getXmlizationInfoForClass()
Copyright © 2006–2021 The Apache Software Foundation. All rights reserved.