org.corpus_tools.pepper.core

Class Step

java.lang.Object

org.corpus_tools.pepper.common.StepDesc

org.corpus_tools.pepper.core.Step

public class Step
extends StepDesc

This class is an extension of the class StepDesc and is for internal use only. This class extends the abstract Step description of StepDesc with the following:

• a unique identifier representing the position of this step in workflow

Author:

Florian Zipser

Constructor Summary

Constructors

Constructor and Description
Step(String id) Initializes this object and sets its internal id, which represents its position in list of steps.
Step(String id, StepDesc stepDesc) Initializes this object and sets its internal id, which represents its position in list of steps.

Method Summary

Modifier and Type	Method and Description
String	getId() Returns the internal id, which represents position of the Step in list of steps.
ModuleControllerImpl	getModuleController() The ModuleControllerImpl object which belongs to this step and acts as a bridge between Pepper and the Pepper module.
MODULE_TYPE	getModuleType() Returns the type of the PepperModule to be used.
String	getName() If a PepperModule is set, overrides the set name with the name of the PepperModule.
Step	setCorpusDesc(CorpusDesc corpusDesc) Sets an object to describe all infos about the corpus to im- or export.
void	setPepperModule(PepperModule pepperModule) Creates a ModuleControllerImpl object as container for the passed PepperModule object.
Step	setProps(Properties props) If setPepperModule(PepperModule) was already called, the passed Properties object is used to create a PepperModuleProperties object, which is set to given PepperModule.

Methods inherited from class org.corpus_tools.pepper.common.StepDesc

getCorpusDesc, getProps, getVersion, setModuleType, setName, setVersion, toString, toXML

Methods inherited from class java.lang.Object

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

Constructor Detail

Step

public Step(String id)

Initializes this object and sets its internal id, which represents its position in list of steps.

Parameters:

id - unique id for a PepperJobImpl

Step

public Step(String id,
            StepDesc stepDesc)

Initializes this object and sets its internal id, which represents its position in list of steps.

Parameters:

id - unique id for a PepperJobImpl

stepDesc - sets the abstract StepDesc object to used here

Method Detail

getName

public String getName()

If a PepperModule is set, overrides the set name with the name of the PepperModule.

Overrides:

getName in class StepDesc

Returns:

name of PepperModule

getId

public String getId()

Returns the internal id, which represents position of the Step in list of steps.

Returns:

setCorpusDesc

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

Further passes the given CorpusDesc to the ModuleControllerImpl, if already set.

Overrides:

setCorpusDesc in class StepDesc

setPepperModule

public void setPepperModule(PepperModule pepperModule)

Creates a ModuleControllerImpl object as container for the passed PepperModule object. The PepperModule object is injected to the ModuleControllerImpl object. If setProps(Properties) was already called, Properties will be passed to PepperModule to create a PepperModuleProperties object.

Parameters:

pepperModule -

getModuleController

public ModuleControllerImpl getModuleController()

The ModuleControllerImpl object which belongs to this step and acts as a bridge between Pepper and the Pepper module.

Returns:

controller object for PepperModule

getModuleType

public MODULE_TYPE getModuleType()

Returns the type of the PepperModule to be used. If no MODULE_TYPE is set, but the ModuleControllerImpl is, the type is estimated.

Overrides:

getModuleType in class StepDesc

Returns:

module type

setProps

public Step setProps(Properties props)

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

Overrides:

setProps in class StepDesc

Parameters:

props - properties to customize processing