Package org.apache.uima.resource.metadata.impl

Class Capability_impl

java.lang.Object
org.apache.uima.resource.metadata.impl.MetaDataObject_impl
org.apache.uima.resource.metadata.impl.Capability_impl
All Implemented Interfaces:
Serializable, Cloneable, Capability, MetaDataObject, XMLizable
public class Capability_impl extends MetaDataObject_impl implements Capability
Reference implementation of Capability
See Also:

  • Constructor Details

    • Capability_impl

      public Capability_impl()

  • Method Details

    • getDescription

      public String getDescription()
      Description copied from interface: Capability
      Gets the description of this Capability.
      Specified by:
      getDescription in interface Capability
      Returns:
      the description of this Capability.

    • setDescription

      public void setDescription(String aDescription)
      Description copied from interface: Capability
      Sets the description of this Capability.
      Specified by:
      setDescription in interface Capability
      Parameters:
      aDescription - aDescription the description of this Capability.

    • getInputs

      public TypeOrFeature[] getInputs()
      Description copied from interface: Capability
      Gets the inputs of this Capability.
      Specified by:
      getInputs in interface Capability
      Returns:
      an array of references to Types or Features in this Resource's Type System.
      See Also:

    • getOutputs

      public TypeOrFeature[] getOutputs()
      Description copied from interface: Capability
      Gets the outputs of this Capability.
      Specified by:
      getOutputs in interface Capability
      Returns:
      an array of references to Types or Features in this Resource's TypeSystem.
      See Also:

    • getPreconditions

      public Precondition[] getPreconditions()
      Description copied from interface: Capability
      Retrieves the preconditions that must be satisfied in order for the Resource to begin processing.
      Specified by:
      getPreconditions in interface Capability
      Returns:
      an unmodifiable list of Preconditions.
      See Also:

    • getLanguagesSupported

      public String[] getLanguagesSupported()
      Description copied from interface: Capability
      A convenience method that analyzes the preconditions of this Capability and returns the ISO language identifiers that the Resource supports. This is only meaningful when analyzing text documents.
      Specified by:
      getLanguagesSupported in interface Capability
      Returns:
      an array of ISO language identifiers. An empty array means that the Resource claims to be language-independent.
      See Also:

    • getMimeTypesSupported

      public String[] getMimeTypesSupported()
      Description copied from interface: Capability
      A convenience method that analyzes the preconditions of this Capability and returns the MIME types that the Resource can take as input.
      Specified by:
      getMimeTypesSupported in interface Capability
      Returns:
      an array of MIME types. This may be empty if the Resource does not declare MIME type preconditions.
      See Also:

    • setInputs

      public void setInputs(TypeOrFeature[] aInputs)
      Description copied from interface: Capability
      Sets the inputs of this Capability.
      Specified by:
      setInputs in interface Capability
      Parameters:
      aInputs - an array of references to Types or Features in this Resource's TypeSystem.
      See Also:

    • setOutputs

      public void setOutputs(TypeOrFeature[] aOutputs)
      Description copied from interface: Capability
      Sets the outputs of this Capability.
      Specified by:
      setOutputs in interface Capability
      Parameters:
      aOutputs - an array of references to Types or Features in this Resource's TypeSystem.
      See Also:

    • setPreconditions

      public void setPreconditions(Precondition[] aPreconditions)
      Description copied from interface: Capability
      Sets the Preconditions of this Capability.
      Specified by:
      setPreconditions in interface Capability
      Parameters:
      aPreconditions - an array of Precondition objects
      See Also:

    • setLanguagesSupported

      public void setLanguagesSupported(String[] aLanguageIDs)
      Description copied from interface: Capability
      A convenience method that sets the languages that this Resource supports. This is only meaningful when text documents are analyzed.

      Calling this method affects the preconditions of this Capability. All other language support preconditions will be removed, but non-language related preconditions will be unaffected.

      Specified by:
      setLanguagesSupported in interface Capability
      Parameters:
      aLanguageIDs - an array of ISO language identifiers. An empty array means that the Resource claims to be language-independent.
      See Also:

    • setMimeTypesSupported

      public void setMimeTypesSupported(String[] aMimeTypes)
      Description copied from interface: Capability
      A convenience method that sets the MIME types that this Resource can take as input.

      Calling this method affects the preconditions of this Capability. All other MIME type preconditions will be removed, but other preconditions will be unaffected.

      Specified by:
      setMimeTypesSupported in interface Capability
      Parameters:
      aMimeTypes - an array of MIME types. This may be empty if the Resource does not declare MIME type preconditions.
      See Also:

    • addInputType

      public void addInputType(String aTypeName, boolean aAllAnnotatorFeatures)
      Description copied from interface: Capability
      A convenience method that adds an input Type to this Capability.
      Specified by:
      addInputType in interface Capability
      Parameters:
      aTypeName - the fully qualified type name
      aAllAnnotatorFeatures - if true, indicates that this Capability requires as input all features of this type that are specified in the same AnalysisEngine descriptor. If false, features must be explicitly declared by calling Capability.addInputFeature(String).
      See Also:

    • addInputFeature

      public void addInputFeature(String aFeatureName)
      Description copied from interface: Capability
      A convenience method that adds an input Feature to this Capability.
      Specified by:
      addInputFeature in interface Capability
      Parameters:
      aFeatureName - the fully qualified feature name
      See Also:

    • addOutputType

      public void addOutputType(String aTypeName, boolean aAllAnnotatorFeatures)
      Description copied from interface: Capability
      A convenience method that adds an output Type to this Capability.
      Specified by:
      addOutputType in interface Capability
      Parameters:
      aTypeName - the fully qualified type name
      aAllAnnotatorFeatures - if true, indicates that this Capability declares as output all features of this type that are specified in the same AnalysisEngine descriptor. If false, features must be explicitly declared by calling Capability.addOutputFeature(String).
      See Also:

    • addOutputFeature

      public void addOutputFeature(String aFeatureName)
      Description copied from interface: Capability
      A convenience method that adds an output Feature to this Capability.
      Specified by:
      addOutputFeature in interface Capability
      Parameters:
      aFeatureName - the fully qualified feature name
      See Also:

    • addSupportedLanguage

      public void addSupportedLanguage(String aLanguage)
      Description copied from interface: Capability
      A convenience method that adds a supported language to this Capability.
      Specified by:
      addSupportedLanguage in interface Capability
      Parameters:
      aLanguage - the ISO language identifier
      See Also:

    • removeSupportedLanguage

      public void removeSupportedLanguage(String aLanguage)
      Description copied from interface: Capability
      A convenience method that removes a supported language from this Capability.
      Specified by:
      removeSupportedLanguage in interface Capability
      Parameters:
      aLanguage - the ISO language identifier

    • getInputSofas

      public String[] getInputSofas()
      Description copied from interface: Capability
      Gets the inputs Sofa names of this Capability.
      Specified by:
      getInputSofas in interface Capability
      Returns:
      an array of strings representing the SofAName

    • getOutputSofas

      public String[] getOutputSofas()
      Description copied from interface: Capability
      Gets the output Sofa names of this Capability.
      Specified by:
      getOutputSofas in interface Capability
      Returns:
      an array of strings representing output SofA names

    • setInputSofas

      public void setInputSofas(String[] aInputSofaNames)
      Description copied from interface: Capability
      Sets the input Sofa names.
      Specified by:
      setInputSofas in interface Capability
      Parameters:
      aInputSofaNames - an array of strings containing SofA names

    • setOutputSofas

      public void setOutputSofas(String[] aOutputSofaNames)
      Description copied from interface: Capability
      Sets the output Sofa names of this capability
      Specified by:
      setOutputSofas in interface Capability
      Parameters:
      aOutputSofaNames - an array of strings containing SoFA name

    • addInputSofa

      public void addInputSofa(String aSofaName)
      Description copied from interface: Capability
      A convenience method that adds an input Sofa name to this Capability.
      Specified by:
      addInputSofa in interface Capability
      Parameters:
      aSofaName - the sofa to add to the inputs

    • addOutputSofa

      public void addOutputSofa(String aSofaName)
      Description copied from interface: Capability
      A convenience method that adds an output Sofa name to this Capability.
      Specified by:
      addOutputSofa in interface Capability
      Parameters:
      aSofaName - the sofa to add as an output

    • 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 class MetaDataObject_impl
      Returns:
      information defining this object's XML representation