org.corpus_tools.pepper.core.Step Class Reference

This class is an extension of the class StepDesc and is for internal use only. More...

Inherits org.corpus_tools.pepper.common.StepDesc.

Public Member Functions
	Step (String id)
	Initializes this object and sets its internal id, which represents its position in list of steps. More...
	Step (String id, StepDesc stepDesc)
	Initializes this object and sets its internal id, which represents its position in list of steps. More...
String	getName ()
	If a PepperModule is set, overrides the set name with the name of the PepperModule.
String	getId ()
	Returns the internal id, which represents position of the Step in list of steps. More...
synchronized Step	setCorpusDesc (CorpusDesc corpusDesc)
	{@inheritDoc StepDesc::setCorpusDesc(CorpusDesc)} Further passes the given CorpusDesc to the ModuleControllerImpl, if already set.
synchronized void	setPepperModule (PepperModule pepperModule)
	Creates a ModuleControllerImpl object as container for the passed PepperModule object. More...
ModuleControllerImpl	getModuleController ()
	The ModuleControllerImpl object which belongs to this step and acts as a bridge between Pepper and the Pepper module. More...
MODULE_TYPE	getModuleType ()
	Returns the type of the PepperModule to be used. More...
synchronized 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. More...
Public Member Functions inherited from org.corpus_tools.pepper.common.StepDesc
synchronized StepDesc	setModuleType (MODULE_TYPE moduleType)
	Sets the type of the org.corpus_tools.pepper.modules.PepperModule to be used. 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...
Properties	getProps ()
	Returns the object for temporary storage of customization properties. More...
void	toXML (XMLStreamWriter writer)
String	toString ()
	Returns a string representation of this object. More...

Detailed Description

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 & Destructor Documentation

Step() [1/2]

org.corpus_tools.pepper.core.Step.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() [2/2]

org.corpus_tools.pepper.core.Step.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

Member Function Documentation

getId()

String org.corpus_tools.pepper.core.Step.getId

(

)

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

Returns

getModuleController()

ModuleControllerImpl org.corpus_tools.pepper.core.Step.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()

MODULE_TYPE org.corpus_tools.pepper.core.Step.getModuleType

(

)

Returns the type of the PepperModule to be used.

If no MODULE_TYPE is set, but the ModuleControllerImpl is, the type is estimated.

Returns

module type

Reimplemented from org.corpus_tools.pepper.common.StepDesc.

setPepperModule()

synchronized void org.corpus_tools.pepper.core.Step.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

setProps()

synchronized Step org.corpus_tools.pepper.core.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.

Parameters

props

properties to customize processing

Reimplemented from org.corpus_tools.pepper.common.StepDesc.