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

Class Capability_impl

    • Constructor Detail

      • Capability_impl

        public Capability_impl()

    • Method Detail

      • getDescription

        public java.lang.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​(java.lang.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.

      • getLanguagesSupported

        public java.lang.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:
        Capability.getLanguagesSupported()

      • getMimeTypesSupported

        public java.lang.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:
        Capability.getMimeTypesSupported()

      • setLanguagesSupported

        public void setLanguagesSupported​(java.lang.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:
        Capability.setLanguagesSupported(String[])

      • setMimeTypesSupported

        public void setMimeTypesSupported​(java.lang.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:
        Capability.setMimeTypesSupported(java.lang.String[])

      • addInputType

        public void addInputType​(java.lang.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:
        Capability.addInputType(java.lang.String, boolean)

      • addOutputType

        public void addOutputType​(java.lang.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:
        Capability.addOutputType(java.lang.String, boolean)

      • removeSupportedLanguage

        public void removeSupportedLanguage​(java.lang.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 java.lang.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 java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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