org.corpus_tools.pepper.common.FormatDesc Class Reference

This class is used by Pepper to describe a linguistic data format. More...

Classes
class	FormatDescBuilder

Public Member Functions
	FormatDesc ()
	Initilizes an object.
FormatDesc	setFormatName (String formatName)
	Sets the name of the linguistic format. More...
String	getFormatName ()
	Returns the name of the linguistic format. More...
String	getFormatVersion ()
	Returns the version of the linguistic format. More...
FormatDesc	setFormatVersion (String formatVersion)
	Sets the version of the linguistic format. More...
URI	getFormatReference ()
	Returns the documentation reference for the linguistic format. More...
FormatDesc	setFormatReference (URI formatReference)
	Sets the documentation reference for the linguistic format. More...
boolean	equals (Object obj)
	Compares a CorpusDesc object with this object. More...
int	hashCode ()
	This method is overwritten because of findbugs.
String	toString ()
	Returns a String representation of this object. More...

Protected Attributes
String	formatName = null
	Name of the linguistic format.
String	formatVersion = null
	The version of the format.
URI	formatReference = null
	Documentation reference for the linguistic format.

Detailed Description

This class is used by Pepper to describe a linguistic data format.

Such an object is used for instance to describe the set of formats which can be handled by a org.corpus_tools.pepper.modules.PepperImporter or a org.corpus_tools.pepper.modules.PepperExporter . Or it can be used to determine the format of a corpus resource as given in CorpusDesc.
Main fields are:

• formatName - to determine the name of the format
• formatVersion - to determine the version of the format
• formatReference - to set a link to a more detailed description, in most cases this is optional

Author

Florian Zipser

Member Function Documentation

equals()

boolean org.corpus_tools.pepper.common.FormatDesc.equals

(

Object

obj

)

Compares a CorpusDesc object with this object.

Both objects are equal, if and only if the have the same format name and format version. The comparison is case insensitive.

getFormatName()

String org.corpus_tools.pepper.common.FormatDesc.getFormatName

(

)

Returns the name of the linguistic format.

Returns

name of the format.

getFormatReference()

URI org.corpus_tools.pepper.common.FormatDesc.getFormatReference

(

)

Returns the documentation reference for the linguistic format.

Parameters

link	to a documentation

getFormatVersion()

String org.corpus_tools.pepper.common.FormatDesc.getFormatVersion

(

)

Returns the version of the linguistic format.

Returns

version of the format

setFormatName()

FormatDesc org.corpus_tools.pepper.common.FormatDesc.setFormatName

(

String

formatName

)

Sets the name of the linguistic format.

Parameters

formatName

name of the format to be used

Returns

this

setFormatReference()

FormatDesc org.corpus_tools.pepper.common.FormatDesc.setFormatReference

(

URI

formatReference

)

Sets the documentation reference for the linguistic format.

Parameters

formatReference

link to documentation

Returns

this

setFormatVersion()

FormatDesc org.corpus_tools.pepper.common.FormatDesc.setFormatVersion

(

String

formatVersion

)

Sets the version of the linguistic format.

Parameters

formatVersion

version of the format

Returns

this

toString()

String org.corpus_tools.pepper.common.FormatDesc.toString

(

)

Returns a String representation of this object.

Note: This String cannot be used for serialization/ deserialization.</string>

Returns

a String representation of this object.