Package org.apache.uima.resource

Interface ExternalResourceDependency

  • All Superinterfaces:
    java.lang.Cloneable, MetaDataObject, java.io.Serializable, XMLizable
    All Known Implementing Classes:
    ExternalResourceDependency_impl
    public interface ExternalResourceDependency
extends MetaDataObject
    An ExternalResourceDependency object describes an resources's requirements on an external resource. This object has four properties:
    • A key, by which the annotator will identify the resource.
    • A textual description of the resource dependency.
    • The name of a Java interface through which the data will be accessed. This is optional; if not specified, the default DataResource interface will be used.
    • Whether the resource is required or optional.

    • Method Detail

      • getKey

        java.lang.String getKey()
        Retrieves the key by which the resource is identified.
        Returns:
        the key for this resource.

      • setKey

        void setKey​(java.lang.String aKey)
        Sets the key by which the resource is identified.
        Parameters:
        aKey - the key for this resource.

      • getDescription

        java.lang.String getDescription()
        Retrieves the textual description of the resource.
        Returns:
        the textual description of the resource.

      • setDescription

        void setDescription​(java.lang.String aDescription)
        Retrieves the textual description of the resource.
        Parameters:
        aDescription - the textual description of the resource.

      • getInterfaceName

        java.lang.String getInterfaceName()
        Retrieves the name of the Java interface through which this resource will be accessed.
        Returns:
        the name of the Java interface for this external resource, null if none.

      • setInterfaceName

        void setInterfaceName​(java.lang.String aName)
        Sets the name of the Java interface through which this resource will be accessed.
        Parameters:
        aName - the name of the Java interface for this external resource, null if none.
        Throws:
        UIMA_UnsupportedOperationException - if this object is not modifiable

      • isOptional

        boolean isOptional()
        Gets whether this resource dependency is optional. Dependencies that are not optional must be linked to resource definitions prior to instantiating the Analysis Engine, or an exception will be thrown.
        Returns:
        true if this resource dependency is optional, false if not

      • setOptional

        void setOptional​(boolean aOptional)
        Sets whether this resource dependency is optional. Dependencies that are not optional must be linked to resource definitions prior to instantiating the Analysis Engine, or an exception will be thrown.
        Parameters:
        aOptional - true if this resource dependency is optional, false if not