org.corpus_tools.pepper.common.PepperModuleDesc Class Reference

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

Detailed Description

This class is a kind of a fingerprint of a Pepper module and provides some information about a module.

Author

Florian Zipser

Member Function Documentation

addSupportedFormat()

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.

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

compareTo()

int org.corpus_tools.pepper.common.PepperModuleDesc.compareTo

(

PepperModuleDesc

o

)

Compares the passed PepperModuleDesc object with this.

The sorting order follows the rules:

1. MODULE_TYPE#IMPORTER
2. MODULE_TYPE#MANIPULATOR
3. MODULE_TYPE#EXPORTER

and ascending name inside the three types.

getDesc()

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.

Returns

a short description of the task of this module

getModuleType()

MODULE_TYPE org.corpus_tools.pepper.common.PepperModuleDesc.getModuleType

(

)

Returns the type of this module.

Returns

type of module

getName()

String org.corpus_tools.pepper.common.PepperModuleDesc.getName

(

)

Returns the name of a Pepper module described by this PepperModuleDesc object.

Returns

name of the Pepper module

getProperties()

PepperModuleProperties org.corpus_tools.pepper.common.PepperModuleDesc.getProperties

(

)

Returns a PepperModuleProperties object containing properties to customize the behavior of this PepperModule.

Returns

getSupplierContact()

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.

Returns

contact address like eMail address or homepage address

getSupplierHomepage()

URI org.corpus_tools.pepper.common.PepperModuleDesc.getSupplierHomepage

(

)

Sets the URI to the homepage describing the functionality of the module.

Returns

URI to the homepage

getSupportedFormats()

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.

Returns

list of format descriptions

getVersion()

String org.corpus_tools.pepper.common.PepperModuleDesc.getVersion

(

)

Returns the version of a Pepper module described by this PepperModuleDesc object.

Returns

version of the Pepper module

setDesc()

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.

Parameters

desc	a short description of the task of this module

setModuleType()

void org.corpus_tools.pepper.common.PepperModuleDesc.setModuleType

(

MODULE_TYPE

moduleType

)

Sets the type of this module.

Parameters

moduleType

type of module

setName()

void org.corpus_tools.pepper.common.PepperModuleDesc.setName

(

String

moduleName

)

Sets the name of a Pepper module described by this PepperModuleDesc object.

Parameters

moduleName

name of the Pepper module

setProperties()

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.

Parameters

properties

setSupplierContact()

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.

Parameters

uri	contact address like eMail address or homepage address

setSupplierHomepage()

void org.corpus_tools.pepper.common.PepperModuleDesc.setSupplierHomepage

(

URI

hp

)

Returns the URI to the homepage describing the functionality of the module.

Parameters

hp	URI to the homepage

setVersion()

void org.corpus_tools.pepper.common.PepperModuleDesc.setVersion

(

String

version

)

Sets the version of a Pepper module described by this PepperModuleDesc object.

Parameters

version

of the Pepper module

toString()

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