Pepper
3.6.0
A highly extensible plattform for conversion and manipulationoflinguisticdata.
|
This class is a kind of a fingerprint of a Pepper module and provides some information about a module. More...
Inherits Comparable< PepperModuleDesc >.
Public Member Functions | |
String | getName () |
Returns the name of a Pepper module described by this PepperModuleDesc object. More... | |
void | setName (String moduleName) |
Sets the name of a Pepper module described by this PepperModuleDesc object. More... | |
String | getVersion () |
Returns the version of a Pepper module described by this PepperModuleDesc object. More... | |
void | setVersion (String version) |
Sets the version of a Pepper module described by this PepperModuleDesc object. More... | |
MODULE_TYPE | getModuleType () |
Returns the type of this module. More... | |
void | setModuleType (MODULE_TYPE moduleType) |
Sets the type of this module. More... | |
String | getDesc () |
Returns a short description of this module. More... | |
void | setDesc (String desc) |
Sets a short description of this module. More... | |
URI | getSupplierContact () |
Returns a uri where to find more information about this module and where to find some contact information to contact the supllier. More... | |
void | setSupplierContact (URI supplierContact) |
Sets a uri where to find more information about this module and where to find some contact information to contact the supllier. More... | |
URI | getSupplierHomepage () |
Sets the URI to the homepage describing the functionality of the module. More... | |
void | setSupplierHomepage (URI hp) |
Returns the URI to the homepage describing the functionality of the module. More... | |
List< FormatDesc > | getSupportedFormats () |
Returns a list of FormatDesc objects describing all formats supported by the Pepper module, this object describes. More... | |
FormatDesc | addSupportedFormat (String formatName, String formatVersion, 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. More... | |
PepperModuleProperties | getProperties () |
Returns a PepperModuleProperties object containing properties to customize the behavior of this PepperModule. More... | |
void | setProperties (PepperModuleProperties properties) |
Sets thePepperModuleProperties object containing properties to customize the behavior of this PepperModule. More... | |
String | toString () |
Returns a String representation of this object. More... | |
int | compareTo (PepperModuleDesc o) |
Compares the passed PepperModuleDesc object with this. More... | |
boolean | equals (Object obj) |
This method was overwritten because of a findbugs warning. | |
int | hashCode () |
This method was overwritten because of a findbugs warning. | |
Protected Attributes | |
URI | supplierContact = null |
URI | hp = null |
This class is a kind of a fingerprint of a Pepper module and provides some information about a module.
FormatDesc org.corpus_tools.pepper.common.PepperModuleDesc.addSupportedFormat | ( | String | formatName, |
String | formatVersion, | ||
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.
formatName | name of the supported format |
formatVersion | version of the supported format |
formatReference | a reference for information about the format if exist |
int org.corpus_tools.pepper.common.PepperModuleDesc.compareTo | ( | PepperModuleDesc | o | ) |
Compares the passed PepperModuleDesc object with this.
The sorting order follows the rules:
and ascending name inside the three types.
String org.corpus_tools.pepper.common.PepperModuleDesc.getDesc | ( | ) |
Returns a short description of this module.
Please support some information, for the user, of what task this module does.
MODULE_TYPE org.corpus_tools.pepper.common.PepperModuleDesc.getModuleType | ( | ) |
Returns the type of this module.
String org.corpus_tools.pepper.common.PepperModuleDesc.getName | ( | ) |
Returns the name of a Pepper module described by this PepperModuleDesc object.
PepperModuleProperties org.corpus_tools.pepper.common.PepperModuleDesc.getProperties | ( | ) |
Returns a PepperModuleProperties object containing properties to customize the behavior of this PepperModule.
URI org.corpus_tools.pepper.common.PepperModuleDesc.getSupplierContact | ( | ) |
Returns a uri where to find more information about this module and where to find some contact information to contact the supllier.
URI org.corpus_tools.pepper.common.PepperModuleDesc.getSupplierHomepage | ( | ) |
List<FormatDesc> org.corpus_tools.pepper.common.PepperModuleDesc.getSupportedFormats | ( | ) |
Returns a list of FormatDesc objects describing all formats supported by the Pepper module, this object describes.
String org.corpus_tools.pepper.common.PepperModuleDesc.getVersion | ( | ) |
Returns the version of a Pepper module described by this PepperModuleDesc object.
void org.corpus_tools.pepper.common.PepperModuleDesc.setDesc | ( | String | desc | ) |
Sets a short description of this module.
Please support some information, for the user, of what task this module does.
desc | a short description of the task of this module |
void org.corpus_tools.pepper.common.PepperModuleDesc.setModuleType | ( | MODULE_TYPE | moduleType | ) |
Sets the type of this module.
moduleType | type of module |
void org.corpus_tools.pepper.common.PepperModuleDesc.setName | ( | String | moduleName | ) |
Sets the name of a Pepper module described by this PepperModuleDesc object.
moduleName | name of the Pepper module |
void org.corpus_tools.pepper.common.PepperModuleDesc.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.
properties |
void org.corpus_tools.pepper.common.PepperModuleDesc.setSupplierContact | ( | URI | supplierContact | ) |
Sets a uri where to find more information about this module and where to find some contact information to contact the supllier.
uri | contact address like eMail address or homepage address |
void org.corpus_tools.pepper.common.PepperModuleDesc.setSupplierHomepage | ( | URI | hp | ) |
void org.corpus_tools.pepper.common.PepperModuleDesc.setVersion | ( | String | version | ) |
Sets the version of a Pepper module described by this PepperModuleDesc object.
version | of the Pepper module |
String org.corpus_tools.pepper.common.PepperModuleDesc.toString | ( | ) |
Returns a String representation of this object.
Please note, that this representation cannot be used for serialization/deserialization purposes