Class FlowControllerDeclaration_impl
- java.lang.Object
-
- org.apache.uima.resource.metadata.impl.MetaDataObject_impl
-
- org.apache.uima.analysis_engine.metadata.impl.FlowControllerDeclaration_impl
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,FlowControllerDeclaration
,MetaDataObject
,XMLizable
public class FlowControllerDeclaration_impl extends MetaDataObject_impl implements FlowControllerDeclaration
Declares which FlowController is used by the Aggregate Analysis Engine.- See Also:
- Serialized Form
-
-
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 Constructor Description FlowControllerDeclaration_impl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
buildFromXMLElement(org.w3c.dom.Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions)
Initializes this object from its XML DOM representation.Import
getImport()
Gets the import that references the FlowController specifier.java.lang.String
getKey()
Gets the key that can be used to refer to the FlowController in configuration parameter overrides and Sofa mappings.ResourceSpecifier
getSpecifier()
Retrieves theResourceSpecifier
used to determine which FlowController is used by the AnalysisEngine.protected org.xml.sax.helpers.AttributesImpl
getXMLAttributes()
Called by theMetaDataObject_impl.toXML(ContentHandler, boolean)
method to get the XML attributes that will be written as part of the element's tag.protected XmlizationInfo
getXmlizationInfo()
To be implemented by subclasses to return information describing how to represent this object in XML.void
resolveImports()
Resolves an imported FlowController specifier, if there is one.void
resolveImports(ResourceManager aResourceManager)
Resolves an imported FlowController specifier, if there is one.void
setImport(Import aImport)
Sets the import that references the FlowController specifier.void
setKey(java.lang.String aKey)
Sets the key that can be used to refer to the FlowController in configuration parameter overrides and Sofa mappings.void
setSpecifier(ResourceSpecifier aSpecifier)
Sets theResourceSpecifier
used to determine which FlowController is used by the AnalysisEngine.-
Methods 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, hashCode, isModifiable, listAttributes, readArrayPropertyValueFromXMLElement, readMapPropertyFromXml, readPropertyValueFromXMLElement, readUnknownPropertyValueFromXMLElement, resolveSettings, setAttributeValue, setInfoset, setSourceUrl, setSourceUrlIfNull, toString, toXML, toXML, toXML, toXML, valueIsNullOrEmptyArray, writeArrayPropertyAsElement, writeMapPropertyToXml, writePropertyAsElement
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrl
-
-
-
-
Method Detail
-
getKey
public java.lang.String getKey()
Description copied from interface:FlowControllerDeclaration
Gets the key that can be used to refer to the FlowController in configuration parameter overrides and Sofa mappings.- Specified by:
getKey
in interfaceFlowControllerDeclaration
- Returns:
- the key assigned to the FlowController
-
setKey
public void setKey(java.lang.String aKey)
Description copied from interface:FlowControllerDeclaration
Sets the key that can be used to refer to the FlowController in configuration parameter overrides and Sofa mappings.- Specified by:
setKey
in interfaceFlowControllerDeclaration
- Parameters:
aKey
- the key to assign to the FlowController
-
getImport
public Import getImport()
Description copied from interface:FlowControllerDeclaration
Gets the import that references the FlowController specifier.- Specified by:
getImport
in interfaceFlowControllerDeclaration
- Returns:
- an object containing the import information, or null if no import was used
-
setImport
public void setImport(Import aImport)
Description copied from interface:FlowControllerDeclaration
Sets the import that references the FlowController specifier.- Specified by:
setImport
in interfaceFlowControllerDeclaration
- Parameters:
aImport
- an object containing the import information, or null if no import is to be used
-
getSpecifier
public ResourceSpecifier getSpecifier()
Description copied from interface:FlowControllerDeclaration
Retrieves theResourceSpecifier
used to determine which FlowController is used by the AnalysisEngine.- Specified by:
getSpecifier
in interfaceFlowControllerDeclaration
- Returns:
- the
ResourceSpecifier
that specifies a FlowController.
-
setSpecifier
public void setSpecifier(ResourceSpecifier aSpecifier)
Description copied from interface:FlowControllerDeclaration
Sets theResourceSpecifier
used to determine which FlowController is used by the AnalysisEngine.- Specified by:
setSpecifier
in interfaceFlowControllerDeclaration
- Parameters:
aSpecifier
- aResourceSpecifier
that specifies a FlowController
-
resolveImports
public void resolveImports() throws InvalidXMLException
Description copied from interface:FlowControllerDeclaration
Resolves an imported FlowController specifier, if there is one. Thespecifier
property of this object is set to the result of parsing the imported descriptor. The import is then deleted.- Specified by:
resolveImports
in interfaceFlowControllerDeclaration
- Throws:
InvalidXMLException
- if either the import target does not exist or is invalid
-
resolveImports
public void resolveImports(ResourceManager aResourceManager) throws InvalidXMLException
Description copied from interface:FlowControllerDeclaration
Resolves an imported FlowController specifier, if there is one. Thespecifier
property of this object is set to the result of parsing the imported descriptor. The import is then deleted.- Specified by:
resolveImports
in interfaceFlowControllerDeclaration
- Parameters:
aResourceManager
- the Resource Manager used to locate an XML file imported by name- Throws:
InvalidXMLException
- if either the import target does not exist or is invalid
-
buildFromXMLElement
public void buildFromXMLElement(org.w3c.dom.Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) throws InvalidXMLException
Description copied from class:MetaDataObject_impl
Initializes this object from its XML DOM representation. This method is typically called from theXMLParser
. It is overridden by specific Java impl classes to provide additional defaulting (e.g. see AnalysisEngineDescription_impl)- Specified by:
buildFromXMLElement
in interfaceXMLizable
- Overrides:
buildFromXMLElement
in classMetaDataObject_impl
- Parameters:
aElement
- the XML element that represents this object.aParser
- a reference to the UIMAXMLParser
. TheXMLParser.buildObject(Element)
method can be used to construct sub-objects.aOptions
- option settings- Throws:
InvalidXMLException
- if the input XML element does not specify a valid object
-
getXMLAttributes
protected org.xml.sax.helpers.AttributesImpl getXMLAttributes()
Description copied from class:MetaDataObject_impl
Called by theMetaDataObject_impl.toXML(ContentHandler, boolean)
method to get the XML attributes that will be written as part of the element's tag. By default this method returns an empty Attributes object. Subclasses may override it in order to write attributes to the XML.- Overrides:
getXMLAttributes
in classMetaDataObject_impl
- Returns:
- an object defining the attributes to be written to the XML
-
getXmlizationInfo
protected XmlizationInfo getXmlizationInfo()
Description copied from class:MetaDataObject_impl
To be implemented by subclasses to return information describing how to represent this object in XML.- Specified by:
getXmlizationInfo
in classMetaDataObject_impl
- Returns:
- information defining this object's XML representation
-
-