Interface FlowControllerDeclaration
- All Superinterfaces:
Cloneable,MetaDataObject,Serializable,XMLizable
- All Known Implementing Classes:
FlowControllerDeclaration_impl
Declares which FlowController is used by the Aggregate Analysis Engine. This can be done either
by import or by direct inclusion of a ResourceSpecifier (descriptor) for the FlowController.
If an import is used, it is not automatically resolved when this object is deserialized from XML.
To resolve the imports, call the resolveImports() method. Import resolution is done
automatically during AnalysisEngine instantiation.
-
Method Summary
Modifier and TypeMethodDescriptionGets 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.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 interface org.apache.uima.resource.metadata.MetaDataObject
clone, equals, getAttributeValue, getSourceUrl, getSourceUrlString, isModifiable, listAttributes, setAttributeValue, setSourceUrlMethods inherited from interface org.apache.uima.util.XMLizable
buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML
-
Method Details
-
getKey
String getKey()Gets the key that can be used to refer to the FlowController in configuration parameter overrides and Sofa mappings.- Returns:
- the key assigned to the FlowController
-
setKey
Sets the key that can be used to refer to the FlowController in configuration parameter overrides and Sofa mappings.- Parameters:
aKey- the key to assign to the FlowController
-
getImport
Import getImport()Gets the import that references the FlowController specifier.- Returns:
- an object containing the import information, or null if no import was used
-
setImport
Sets the import that references the FlowController specifier.- Parameters:
aImport- an object containing the import information, or null if no import is to be used
-
getSpecifier
ResourceSpecifier getSpecifier()Retrieves theResourceSpecifierused to determine which FlowController is used by the AnalysisEngine.- Returns:
- the
ResourceSpecifierthat specifies a FlowController.
-
setSpecifier
Sets theResourceSpecifierused to determine which FlowController is used by the AnalysisEngine.- Parameters:
aSpecifier- aResourceSpecifierthat specifies a FlowController
-
resolveImports
Resolves 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.- Throws:
InvalidXMLException- if either the import target does not exist or is invalid
-
resolveImports
Resolves 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.- 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
-