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:
Serializable,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:
-
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 TypeMethodDescriptionvoidbuildFromXMLElement(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) Initializes this object from its XML DOM representation.Gets the import that references the FlowController specifier.getKey()Gets the key that can be used to refer to the FlowController in configuration parameter overrides and Sofa mappings.Retrieves theResourceSpecifierused to determine which FlowController is used by the AnalysisEngine.protected AttributesImplCalled by theMetaDataObject_impl.toXML(ContentHandler, boolean)method to get the XML attributes that will be written as part of the element's tag.protected XmlizationInfoTo be implemented by subclasses to return information describing how to represent this object in XML.voidResolves an imported FlowController specifier, if there is one.voidresolveImports(ResourceManager aResourceManager) Resolves an imported FlowController specifier, if there is one.voidSets the import that references the FlowController specifier.voidSets the key that can be used to refer to the FlowController in configuration parameter overrides and Sofa mappings.voidsetSpecifier(ResourceSpecifier aSpecifier) Sets theResourceSpecifierused 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, writePropertyAsElementMethods 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, setSourceUrl
-
Constructor Details
-
FlowControllerDeclaration_impl
public FlowControllerDeclaration_impl()
-
-
Method Details
-
getKey
Description copied from interface:FlowControllerDeclarationGets the key that can be used to refer to the FlowController in configuration parameter overrides and Sofa mappings.- Specified by:
getKeyin interfaceFlowControllerDeclaration- Returns:
- the key assigned to the FlowController
-
setKey
Description copied from interface:FlowControllerDeclarationSets the key that can be used to refer to the FlowController in configuration parameter overrides and Sofa mappings.- Specified by:
setKeyin interfaceFlowControllerDeclaration- Parameters:
aKey- the key to assign to the FlowController
-
getImport
Description copied from interface:FlowControllerDeclarationGets the import that references the FlowController specifier.- Specified by:
getImportin interfaceFlowControllerDeclaration- Returns:
- an object containing the import information, or null if no import was used
-
setImport
Description copied from interface:FlowControllerDeclarationSets the import that references the FlowController specifier.- Specified by:
setImportin interfaceFlowControllerDeclaration- Parameters:
aImport- an object containing the import information, or null if no import is to be used
-
getSpecifier
Description copied from interface:FlowControllerDeclarationRetrieves theResourceSpecifierused to determine which FlowController is used by the AnalysisEngine.- Specified by:
getSpecifierin interfaceFlowControllerDeclaration- Returns:
- the
ResourceSpecifierthat specifies a FlowController.
-
setSpecifier
Description copied from interface:FlowControllerDeclarationSets theResourceSpecifierused to determine which FlowController is used by the AnalysisEngine.- Specified by:
setSpecifierin interfaceFlowControllerDeclaration- Parameters:
aSpecifier- aResourceSpecifierthat specifies a FlowController
-
resolveImports
Description copied from interface:FlowControllerDeclarationResolves an imported FlowController specifier, if there is one. Thespecifierproperty of this object is set to the result of parsing the imported descriptor. The import is then deleted.- Specified by:
resolveImportsin interfaceFlowControllerDeclaration- Throws:
InvalidXMLException- if either the import target does not exist or is invalid
-
resolveImports
Description copied from interface:FlowControllerDeclarationResolves an imported FlowController specifier, if there is one. Thespecifierproperty of this object is set to the result of parsing the imported descriptor. The import is then deleted.- Specified by:
resolveImportsin 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(Element aElement, XMLParser aParser, XMLParser.ParsingOptions aOptions) throws InvalidXMLException Description copied from class:MetaDataObject_implInitializes 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:
buildFromXMLElementin interfaceXMLizable- Overrides:
buildFromXMLElementin 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
Description copied from class:MetaDataObject_implCalled 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:
getXMLAttributesin classMetaDataObject_impl- Returns:
- an object defining the attributes to be written to the XML
-
getXmlizationInfo
Description copied from class:MetaDataObject_implTo be implemented by subclasses to return information describing how to represent this object in XML.- Specified by:
getXmlizationInfoin classMetaDataObject_impl- Returns:
- information defining this object's XML representation
-