Pepper
3.6.0
A highly extensible plattform for conversion and manipulationoflinguisticdata.
|
This class represents a description of a single step in Pepper. More...
Inherited by org.corpus_tools.pepper.core.Step.
Public Member Functions | |
MODULE_TYPE | getModuleType () |
Returns the type of the org.corpus_tools.pepper.modules.PepperModule to be used. More... | |
synchronized StepDesc | setModuleType (MODULE_TYPE moduleType) |
Sets the type of the org.corpus_tools.pepper.modules.PepperModule to be used. More... | |
String | getName () |
Returns the name of the org.corpus_tools.pepper.modules.PepperModule to be used for this step. More... | |
synchronized StepDesc | setName (String name) |
Sets the name of the org.corpus_tools.pepper.modules.PepperModule to be used for this step. More... | |
String | getVersion () |
Returns the version of the org.corpus_tools.pepper.modules.PepperModule to be used for this step. More... | |
synchronized StepDesc | setVersion (String version) |
Sets the version of the org.corpus_tools.pepper.modules.PepperModule to be used for this step. More... | |
CorpusDesc | getCorpusDesc () |
Returns an object to describe all infos about the corpus to im- or export. More... | |
synchronized StepDesc | setCorpusDesc (CorpusDesc corpusDesc) |
Sets an object to describe all infos about the corpus to im- or export. More... | |
Properties | getProps () |
Returns the object for temporary storage of customization properties. More... | |
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 . More... | |
void | toXML (XMLStreamWriter writer) |
String | toString () |
Returns a string representation of this object. More... | |
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:
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:
If no CorpusDesc object is set, one will be created.
MODULE_TYPE org.corpus_tools.pepper.common.StepDesc.getModuleType | ( | ) |
Returns the type of the org.corpus_tools.pepper.modules.PepperModule to be used.
Reimplemented in org.corpus_tools.pepper.core.Step.
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.
Reimplemented in org.corpus_tools.pepper.core.Step.
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 .
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.
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:
corpusDesc |
Reimplemented in org.corpus_tools.pepper.core.Step.
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.
moduleType |
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.
name | of org.corpus_tools.pepper.modules.PepperModule |
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 .
props | properties to customize processing |
Reimplemented in org.corpus_tools.pepper.core.Step.
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.
version | of org.corpus_tools.pepper.modules.PepperModule |
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.