org.corpus_tools.pepper.common.CorpusDesc Class Reference

This class realizes a description of a corpus to be imported or exported. More...

Classes
class	Builder

Public Member Functions
	CorpusDesc ()
	Initializes a new CorpusDesc object.
FormatDesc	getFormatDesc ()
	Returns a set format description. More...
CorpusDesc	setFormatDesc (FormatDesc formatDesc)
	Sets the format description for this corpus description. More...
URI	getCorpusPath ()
	Returns the path of where to store or from where to load this corpus. More...
CorpusDesc	setCorpusPath (URI corpusPath)
	Sets the path of where to store or from where to load this corpus. More...
String	toString ()
	Returns a string representation of this object. More...

Protected Attributes
FormatDesc	formatDesc = null
	format description belonging to this corpus
URI	corpusPath = null
	location of corpus

Detailed Description

This class realizes a description of a corpus to be imported or exported.

The description consists of a path addressing the location of the corpus and a format description, in which the corpus currently is or is supposed to be persist in.

Author

Florian Zipser

Member Function Documentation

getCorpusPath()

URI org.corpus_tools.pepper.common.CorpusDesc.getCorpusPath

(

)

Returns the path of where to store or from where to load this corpus.

Returns

location of corpus

getFormatDesc()

FormatDesc org.corpus_tools.pepper.common.CorpusDesc.getFormatDesc

(

)

Returns a set format description.

If no FormatDesc object was set, a new one is created.

Returns

a format description

setCorpusPath()

CorpusDesc org.corpus_tools.pepper.common.CorpusDesc.setCorpusPath

(

URI

corpusPath

)

Sets the path of where to store or from where to load this corpus.

Parameters

corpusPath	location of corpus
this	object

setFormatDesc()

CorpusDesc org.corpus_tools.pepper.common.CorpusDesc.setFormatDesc

(

FormatDesc

formatDesc

)

Sets the format description for this corpus description.

Parameters

formatDesc

format description object

Returns

this

toString()

String org.corpus_tools.pepper.common.CorpusDesc.toString

(

)

Returns a string representation of this object.

Note: This representation cannot be used for serialization/deserialization purposes.