Package org.corpus_tools.pepper.common

Class PepperModuleDesc

    • Field Detail

      • supplierContact

        protected org.eclipse.emf.common.util.URI supplierContact

      • hp

        protected org.eclipse.emf.common.util.URI hp

    • Constructor Detail

      • PepperModuleDesc

        public PepperModuleDesc()

    • Method Detail

      • getName

        public String getName()
        Returns the name of a Pepper module described by this PepperModuleDesc object.
        Returns:
        name of the Pepper module

      • setName

        public void setName​(String moduleName)
        Sets the name of a Pepper module described by this PepperModuleDesc object.
        Parameters:
        moduleName - name of the Pepper module

      • getVersion

        public String getVersion()
        Returns the version of a Pepper module described by this PepperModuleDesc object.
        Returns:
        version of the Pepper module

      • setVersion

        public void setVersion​(String version)
        Sets the version of a Pepper module described by this PepperModuleDesc object.
        Parameters:
        version - of the Pepper module

      • getModuleType

        public MODULE_TYPE getModuleType()
        Returns the type of this module.
        Returns:
        type of module

      • setModuleType

        public void setModuleType​(MODULE_TYPE moduleType)
        Sets the type of this module.
        Parameters:
        moduleType - type of module

      • getDesc

        public String getDesc()
        Returns a short description of this module. Please support some information, for the user, of what task this module does.
        Returns:
        a short description of the task of this module

      • setDesc

        public void setDesc​(String desc)
        Sets a short description of this module. Please support some information, for the user, of what task this module does.
        Parameters:
        desc - a short description of the task of this module

      • getSupplierContact

        public org.eclipse.emf.common.util.URI getSupplierContact()
        Returns a uri where to find more information about this module and where to find some contact information to contact the supllier.
        Returns:
        contact address like eMail address or homepage address

      • setSupplierContact

        public void setSupplierContact​(org.eclipse.emf.common.util.URI supplierContact)
        Sets a uri where to find more information about this module and where to find some contact information to contact the supllier.
        Parameters:
        uri - contact address like eMail address or homepage address

      • getSupplierHomepage

        public org.eclipse.emf.common.util.URI getSupplierHomepage()
        Sets the URI to the homepage describing the functionality of the module.
        Returns:
        URI to the homepage

      • setSupplierHomepage

        public void setSupplierHomepage​(org.eclipse.emf.common.util.URI hp)
        Returns the URI to the homepage describing the functionality of the module.
        Parameters:
        hp - URI to the homepage

      • getSupportedFormats

        public List<FormatDesc> getSupportedFormats()
        Returns a list of FormatDesc objects describing all formats supported by the Pepper module, this object describes.
        Returns:
        list of format descriptions

      • addSupportedFormat

        public FormatDesc addSupportedFormat​(String formatName,
                                     String formatVersion,
                                     org.eclipse.emf.common.util.URI formatReference)
        Creates a new FormatDesc object containing the passed name, version and reference to the list of of FormatDesc objects describing all formats supported by the Pepper module, this object describes.
        Parameters:
        formatName - name of the supported format
        formatVersion - version of the supported format
        formatReference - a reference for information about the format if exist
        Returns:
        a FormatDesc

      • setProperties

        public void setProperties​(PepperModuleProperties properties)
        Sets thePepperModuleProperties object containing properties to customize the behavior of this PepperModule. Please make sure, that this method is called in constructor of your module. If not, a general PepperModuleProperties object is created by the pepper framework and will be initialized. This means, when calling this method later, all properties for customizing the module will be overridden.
        Parameters:
        properties -

      • toString

        public String toString()
        Returns a String representation of this object. Please note, that this representation cannot be used for serialization/deserialization purposes
        Overrides:
        toString in class Object

      • equals

        public boolean equals​(Object obj)
        This method was overwritten because of a findbugs warning
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        This method was overwritten because of a findbugs warning
        Overrides:
        hashCode in class Object