Package org.corpus_tools.pepper.common

Class StepDesc

java.lang.Object

org.corpus_tools.pepper.common.StepDesc

Direct Known Subclasses:

Step

public class StepDesc
extends Object

This class represents a description of a single step in Pepper. A step is a conceptual unit, to which exactly one 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 PepperModule to be used to identify PepperModule
• version - the version of the PepperModule to be used to identify the PepperModule
• corpusDesc - an object describing the corpus to be imported or exported (just in case of the PepperModule is a PepperImporter or a 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

Constructor Summary

Constructors

Constructor	Description
StepDesc()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

StepDesc

public StepDesc()

Method Detail

getModuleType

public MODULE_TYPE getModuleType()

Returns the type of the PepperModule to be used.

Returns:

module type

setModuleType

public StepDesc setModuleType(MODULE_TYPE moduleType)

Sets the type of the PepperModule to be used.

Parameters:

moduleType -

getName

public String getName()

Returns the name of the PepperModule to be used for this step.

Returns:

name of PepperModule

setName

public StepDesc setName(String name)

Sets the name of the PepperModule to be used for this step.

Parameters:

name - of PepperModule

getVersion

public String getVersion()

Returns the version of the PepperModule to be used for this step.

Returns:

version of PepperModule

setVersion

public StepDesc setVersion(String version)

Sets the version of the PepperModule to be used for this step.

Parameters:

version - of PepperModule

getCorpusDesc

public CorpusDesc 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:

setCorpusDesc

public 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 -

getProps

public Properties getProps()

Returns the object for temporary storage of customization properties. This object is used to create PepperModuleProperties .

Returns:

setProps

public StepDesc setProps(Properties props)

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

Parameters:

props - properties to customize processing

toXML

public void toXML(XMLStreamWriter writer)

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