Interface ResourceMetaData

    • Method Detail

      • getUUID

        String getUUID()
        Gets the UUID (Universally Unique Identifier) for this Resource.
        Returns:
        the UUID for this Resource
      • setUUID

        void setUUID​(String aUUID)
        Sets the UUID (Universally Unique Identifier) for this Resource.
        Parameters:
        aUUID - the UUID for this Resource
        Throws:
        UIMA_UnsupportedOperationException - if this object is not modifiable
      • getName

        String getName()
        Gets the name of this Resource.
        Returns:
        the name of this Resource
      • getVersion

        String getVersion()
        Gets the version number of this Resource.
        Returns:
        the version number of this Resource, as a String
      • setVersion

        void setVersion​(String aVersion)
        Sets the version number of this Resource.
        Parameters:
        aVersion - the version number of this Resource, as a String
        Throws:
        UIMA_UnsupportedOperationException - if this object is not modifiable
      • getDescription

        String getDescription()
        Gets the description of this Resource.
        Returns:
        the description of this Resource
      • setDescription

        void setDescription​(String aDescription)
        Sets the description of this Resource.
        Parameters:
        aDescription - the description of this Resource
        Throws:
        UIMA_UnsupportedOperationException - if this object is not modifiable
      • getVendor

        String getVendor()
        Gets the vendor of this Resource.
        Returns:
        the vendor of this Resource, as a String
      • setVendor

        void setVendor​(String aVendor)
        Sets the vendor of this Resource.
        Parameters:
        aVendor - the vendor of this Resource, as a String
        Throws:
        UIMA_UnsupportedOperationException - if this object is not modifiable
      • getCopyright

        String getCopyright()
        Gets the copyright notice for this Resource.
        Returns:
        the copyright notice for this Resource
      • setCopyright

        void setCopyright​(String aCopyright)
        Sets the copyright notice for this Resource.
        Parameters:
        aCopyright - the copyright notice for this Resource
        Throws:
        UIMA_UnsupportedOperationException - if this object is not modifiable
      • getConfigurationParameterDeclarations

        ConfigurationParameterDeclarations getConfigurationParameterDeclarations()
        Gets the configuration parameter declarations for this Resource.
        Returns:
        an object containing the configuration parameter declarations
      • setConfigurationParameterDeclarations

        void setConfigurationParameterDeclarations​(ConfigurationParameterDeclarations aDeclarations)
        Gets the configuration parameter declarations for this Resource.
        Parameters:
        aDeclarations - an object containing the configuration parameter declarations
      • getConfigurationParameterSettings

        ConfigurationParameterSettings getConfigurationParameterSettings()
        Gets the configuration parameter settings for this Resource.
        Returns:
        an object containing the settings for this Resource's configuration parameters.
      • setConfigurationParameterSettings

        void setConfigurationParameterSettings​(ConfigurationParameterSettings aSettings)
        Sets the configuration parameter settings for this Resource.
        Parameters:
        aSettings - an object containing the settings for this Resource's configuration parameters.
        Throws:
        UIMA_UnsupportedOperationException - if this object is not modifiable
      • validateConfigurationParameterSettings

        void validateConfigurationParameterSettings()
                                             throws ResourceConfigurationException
        Validates configuration parameter settings within this Resource MetaData, and throws an exception if they are not valid.

        This method checks to make sure that each configuration parameter setting corresponds to an declared configuration parameter, and that the data types are compatible. It does NOT check that all mandatory parameters have been assigned values - this should be done at resource initialization time and not before.

        Throws:
        ResourceConfigurationException - if the configuration parameter settings are invalid
      • resolveImports

        void resolveImports()
                     throws InvalidXMLException
        Resolves any import declarations throughout this metadata. This base interface cannot contain any interfaces, but subinterfaces may introduce new properties that can have imports that need to be resolved.
        Throws:
        InvalidXMLException - if either the import target does not exist or is invalid
      • resolveImports

        void resolveImports​(ResourceManager aResourceManager)
                     throws InvalidXMLException
        Resolves any import declarations throughout this metadata. This base interface cannot contain any interfaces, but subinterfaces may introduce new properties that can have imports that need to be resolved.
        Parameters:
        aResourceManager - the Resource Manager used to locate descriptors imported by name. For example, the path in which to locate these descriptors can be set via the ResourceManager.setDataPath(String) method.
        Throws:
        InvalidXMLException - if either the import target does not exist or is invalid