Package org.apache.uima.analysis_engine.metadata

Interface FlowControllerDeclaration

All Superinterfaces:
Cloneable, MetaDataObject, Serializable, XMLizable
All Known Implementing Classes:
FlowControllerDeclaration_impl
public interface FlowControllerDeclaration extends MetaDataObject
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 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

      void setKey(String aKey)
      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

      void setImport(Import aImport)
      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 the ResourceSpecifier used to determine which FlowController is used by the AnalysisEngine.
      Returns:
      the ResourceSpecifier that specifies a FlowController.

    • setSpecifier

      void setSpecifier(ResourceSpecifier aSpecifier)
      Sets the ResourceSpecifier used to determine which FlowController is used by the AnalysisEngine.
      Parameters:
      aSpecifier - a ResourceSpecifier that specifies a FlowController

    • resolveImports

      void resolveImports() throws InvalidXMLException
      Resolves an imported FlowController specifier, if there is one. The specifierproperty 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

      void resolveImports(ResourceManager aResourceManager) throws InvalidXMLException
      Resolves an imported FlowController specifier, if there is one. The specifierproperty 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