org.corpus_tools.pepper.common.StepDesc Class Reference

This class represents a description of a single step in Pepper. More...

Public Member Functions
MODULE_TYPE	getModuleType ()
	Returns the type of the org.corpus_tools.pepper.modules.PepperModule to be used.
synchronized StepDesc	setModuleType (MODULE_TYPE moduleType)
	Sets the type of the org.corpus_tools.pepper.modules.PepperModule to be used.
String	getName ()
	Returns the name of the org.corpus_tools.pepper.modules.PepperModule to be used for this step.
synchronized StepDesc	setName (String name)
	Sets the name of the org.corpus_tools.pepper.modules.PepperModule to be used for this step.
String	getVersion ()
	Returns the version of the org.corpus_tools.pepper.modules.PepperModule to be used for this step.
synchronized StepDesc	setVersion (String version)
	Sets the version of the org.corpus_tools.pepper.modules.PepperModule to be used for this step.
CorpusDesc	getCorpusDesc ()
	Returns an object to describe all infos about the corpus to im- or export.
synchronized StepDesc	setCorpusDesc (CorpusDesc corpusDesc)
	Sets an object to describe all infos about the corpus to im- or export.
Properties	getProps ()
	Returns the object for temporary storage of customization properties.
synchronized StepDesc	setProps (Properties props)
	If setPepperModule(org.corpus_tools.pepper.modules.PepperModule) was already called, the passed Properties object is used to create a org.corpus_tools.pepper.modules.PepperModuleProperties object, which is set to given org.corpus_tools.pepper.modules.PepperModule .
void	toXML (XMLStreamWriter writer)
String	toString ()
	Returns a string representation of this object.

Detailed Description

This class represents a description of a single step in Pepper.

A step is a conceptual unit, to which exactly one org.corpus_tools.pepper.modules.PepperModule instance belongs to. Such a step can belong to either the import phase, the manipulation phase or the export phase.
This class is used as a communication bridge between the Pepper framework and the outside. When using Pepper as a library or a service, one can create StepDesc object which an abstract description of which module is to use (by setting the name of module and its version) and in case of the module is an importer or an exporter, the description of the path, where the corpus is located.
The main fields of this class are:

• name - the name of the org.corpus_tools.pepper.modules.PepperModule to be used to identify org.corpus_tools.pepper.modules.PepperModule
• version - the version of the org.corpus_tools.pepper.modules.PepperModule to be used to identify the org.corpus_tools.pepper.modules.PepperModule
• corpusDesc - an object describing the corpus to be imported or exported (just in case of the org.corpus_tools.pepper.modules.PepperModule is a org.corpus_tools.pepper.modules.PepperImporter or a org.corpus_tools.pepper.modules.PepperExporter ). This object contains a description of the format (name and version) and a path, where to find the corpus.
• props - a general property object (see: Properties) to customize the mapping process

Author

Florian Zipser

Member Function Documentation

getCorpusDesc()

CorpusDesc org.corpus_tools.pepper.common.StepDesc.getCorpusDesc

(

)

Returns an object to describe all infos about the corpus to im- or export.

This includes the following:

• location of the corpus
• name of the format, the corpus is in or has to be exported in
• version of the format, the corpus is in or has to be exported in

If no CorpusDesc object is set, one will be created.

Returns

getModuleType()

MODULE_TYPE org.corpus_tools.pepper.common.StepDesc.getModuleType

(

)

Returns the type of the org.corpus_tools.pepper.modules.PepperModule to be used.

Returns

module type

getName()

String org.corpus_tools.pepper.common.StepDesc.getName

(

)

Returns the name of the org.corpus_tools.pepper.modules.PepperModule to be used for this step.

Returns

name of org.corpus_tools.pepper.modules.PepperModule

getProps()

Properties org.corpus_tools.pepper.common.StepDesc.getProps

(

)

Returns the object for temporary storage of customization properties.

This object is used to create org.corpus_tools.pepper.modules.PepperModuleProperties .

Returns

getVersion()

String org.corpus_tools.pepper.common.StepDesc.getVersion

(

)

Returns the version of the org.corpus_tools.pepper.modules.PepperModule to be used for this step.

Returns

version of org.corpus_tools.pepper.modules.PepperModule

setCorpusDesc()

synchronized StepDesc org.corpus_tools.pepper.common.StepDesc.setCorpusDesc

(

CorpusDesc

corpusDesc

)

Sets an object to describe all infos about the corpus to im- or export.

This includes the following:

• location of the corpus
• name of the format, the corpus is in or has to be exported in
• version of the format, the corpus is in or has to be exported in

Parameters

corpusDesc

setModuleType()

synchronized StepDesc org.corpus_tools.pepper.common.StepDesc.setModuleType

(

MODULE_TYPE

moduleType

)

Sets the type of the org.corpus_tools.pepper.modules.PepperModule to be used.

Parameters

moduleType

setName()

synchronized StepDesc org.corpus_tools.pepper.common.StepDesc.setName

(

String

name

)

Sets the name of the org.corpus_tools.pepper.modules.PepperModule to be used for this step.

Parameters

name	of org.corpus_tools.pepper.modules.PepperModule

setProps()

synchronized StepDesc org.corpus_tools.pepper.common.StepDesc.setProps

(

Properties

props

)

If setPepperModule(org.corpus_tools.pepper.modules.PepperModule) was already called, the passed Properties object is used to create a org.corpus_tools.pepper.modules.PepperModuleProperties object, which is set to given org.corpus_tools.pepper.modules.PepperModule .

Parameters

props

properties to customize processing

setVersion()

synchronized StepDesc org.corpus_tools.pepper.common.StepDesc.setVersion

(

String

version

)

Sets the version of the org.corpus_tools.pepper.modules.PepperModule to be used for this step.

Parameters

version

of org.corpus_tools.pepper.modules.PepperModule

toString()

String org.corpus_tools.pepper.common.StepDesc.toString

(

)

Returns a string representation of this object.

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