Package org.corpus_tools.pepper.common

Class CorpusDesc

java.lang.Object

org.corpus_tools.pepper.common.CorpusDesc

public class CorpusDesc
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CorpusDesc.Builder

Field Summary

Fields

Modifier and Type	Field	Description
protected org.eclipse.emf.common.util.URI	corpusPath	location of corpus
protected FormatDesc	formatDesc	format description belonging to this corpus

Constructor Summary

Constructors

Constructor	Description
CorpusDesc()	Initializes a new CorpusDesc object.

Method Summary

Modifier and Type	Method	Description
org.eclipse.emf.common.util.URI	getCorpusPath()	Returns the path of where to store or from where to load this corpus.
FormatDesc	getFormatDesc()	Returns a set format description.
CorpusDesc	setCorpusPath(org.eclipse.emf.common.util.URI corpusPath)	Sets the path of where to store or from where to load this corpus.
CorpusDesc	setFormatDesc(FormatDesc formatDesc)	Sets the format description for this corpus description.
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

formatDesc

protected FormatDesc formatDesc

format description belonging to this corpus

corpusPath

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

location of corpus

Constructor Detail

CorpusDesc

public CorpusDesc()

Initializes a new CorpusDesc object.

Method Detail

getFormatDesc

public FormatDesc getFormatDesc()

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

Returns:

a format description

setFormatDesc

public CorpusDesc setFormatDesc(FormatDesc formatDesc)

Sets the format description for this corpus description.

Parameters:

formatDesc - format description object

Returns:

this

getCorpusPath

public org.eclipse.emf.common.util.URI getCorpusPath()

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

Returns:

location of corpus

setCorpusPath

public CorpusDesc setCorpusPath(org.eclipse.emf.common.util.URI corpusPath)

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

Parameters:

corpusPath - location of corpus

this - object

toString

public String toString()

Returns a string representation of this object. Note: This representation cannot be used for serialization/deserialization purposes.

Overrides:

toString in class Object