Public Member Functions
String	getId ()
	Returns the unique identifier for this job.

void	setBaseDir (URI baseDir)
	Sets the base directory for this `ModuleController`.

URI	getBaseDir ()
	Returns the base directory for this `ModuleController`.

JOB_STATUS	getStatus ()
	Returns the current status of this job.

abstract SaltProject	getSaltProject ()
	Returns the `SaltProject` which is converted by this job.

abstract String	getStatusReport ()
	Returns a formated string as a kind of a document centric progress status.

List< StepDesc >	getStepDescs ()
	Returns a list of all step descriptions.

void	addStepDesc (StepDesc stepDesc)
	Adds a `StepDesc` object to job.

StepDesc	createStepDesc ()
	Creates a `StepDesc` object an returns it, without adding the created `StepDesc` object to this `PepperJob` object.

abstract void	convert ()
	Starts the conversion of this job.

abstract void	convertFrom ()
	Imports a `SaltProject` from any format.

abstract void	convertTo ()
	Exports the `SaltProject` into any format.

abstract void	cancelConversion ()
	Cancels the current conversion.

abstract void	load (URI uri)
	Loads a serialization of a `PepperJob` and fills this object with these entries.

abstract URI	save (URI uri)
	Stores this job to the file at passed URI.

abstract void	clear ()
	Removes all `Step`s from all internal lists.

String	toString ()
	Returns a textual representation of this Pepper job.

Protected Attributes
String	id = null
	Identifier of this job.

JOB_STATUS	status = JOB_STATUS.NOT_STARTED
	status of job

Vector< StepDesc >	stepDescs = null
	list of all step descriptions

Member Function Documentation

◆ addStepDesc()

void org.corpus_tools.pepper.common.PepperJob.addStepDesc ( StepDesc stepDesc )

Adds a StepDesc object to job.

Parameters

stepDesc description object of a particular step

◆ cancelConversion()

abstract void org.corpus_tools.pepper.common.PepperJob.cancelConversion ( )

abstract

Cancels the current conversion.

This might not stop immediately, but might finish the running document controller jobs first.

◆ convert()

abstract void org.corpus_tools.pepper.common.PepperJob.convert ( )

abstract

Starts the conversion of this job.

If the single steps of the job has not already been wired, they will be wired.
If org.corpus_tools.pepper.modules.PepperImporter#importCorpusStructure(org.corpus_tools.salt.common.SCorpusGraph) has not already been called, it will be done.

◆ convertFrom()

abstract void org.corpus_tools.pepper.common.PepperJob.convertFrom ( )

abstract

Imports a SaltProject from any format.

For conversion a process can be modeled, similar to convert() with the difference, that no PepperExporter could be defined. The imported Salt model can be accessed via getSaltProject().

◆ convertTo()

abstract void org.corpus_tools.pepper.common.PepperJob.convertTo ( )

abstract

Exports the SaltProject into any format.

For conversion, a normal process could be created, except the use of an importer. Here the do-nothing importer is used, and it is expected, that the getSaltProject() is already 'filled'.

◆ createStepDesc()

StepDesc org.corpus_tools.pepper.common.PepperJob.createStepDesc ( )

Creates a StepDesc object an returns it, without adding the created StepDesc object to this PepperJob object.

For adding that object, call addStepDesc(StepDesc). Or if you want to do that at once call created StepDesc object

◆ getBaseDir()

URI org.corpus_tools.pepper.common.PepperJob.getBaseDir ( )

Returns the base directory for this ModuleController.

The base directory is either the directory from which the Pepper workflow description was loaded or the directory from which Pepper was started.

Returns: base directory

◆ getId()

String org.corpus_tools.pepper.common.PepperJob.getId ( )

Returns the unique identifier for this job.

Returns: unique identifier.

◆ getSaltProject()

abstract SaltProject org.corpus_tools.pepper.common.PepperJob.getSaltProject ( )

abstract

Returns the SaltProject which is converted by this job.

Returns: SaltProject

◆ getStatus()

JOB_STATUS org.corpus_tools.pepper.common.PepperJob.getStatus ( )

Returns the current status of this job.

Returns: status of this job

◆ getStatusReport()

abstract String org.corpus_tools.pepper.common.PepperJob.getStatusReport ( )

abstract

Returns a formated string as a kind of a document centric progress status.

For each document its overall status and specific statuses in single modules are included.

Returns: a report of the progress status

◆ getStepDescs()

List< StepDesc > org.corpus_tools.pepper.common.PepperJob.getStepDescs ( )

Returns a list of all step descriptions.

In order of how the StepDesc objects have been added via method addStep(StepDesc).

Returns: list of StepDesc objects

◆ load()

abstract void org.corpus_tools.pepper.common.PepperJob.load ( URI uri )

abstract

Loads a serialization of a PepperJob and fills this object with these entries.

The current implementation allows xml files following the workflow description scheme version 1.0 and xmi files following the (old) PepperParams schema. Only local files are supported.

Parameters

uri	path of file to load.

◆ save()

abstract URI org.corpus_tools.pepper.common.PepperJob.save ( URI uri )

abstract

Stores this job to the file at passed URI.

If the URI points to a directory, a file having the name getId().pepper is created in the passed directory.

Parameters

uri	The location where to store this job.

Returns: Returns the URI where the Pepper job was stored, normally this is the passed uri, but if the passed uri is a folder, than a file having the job-if (getId()).

◆ setBaseDir()

void org.corpus_tools.pepper.common.PepperJob.setBaseDir ( URI baseDir )

Sets the base directory for this ModuleController.

The base directory is either the directory from which the Pepper workflow description was loaded or the directory from which Pepper was started.

Parameters

baseDir base directory

◆ toString()

String org.corpus_tools.pepper.common.PepperJob.toString ( )

Returns a textual representation of this Pepper job.

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

Returns: textual representation

Member Data Documentation

◆ id

String org.corpus_tools.pepper.common.PepperJob.id = null

protected

Identifier of this job.

Should be unique in Pepper.

Public Member Functions

Protected Attributes

Member Function Documentation

◆ addStepDesc()

◆ cancelConversion()

◆ convert()

◆ convertFrom()

◆ convertTo()

◆ createStepDesc()

◆ getBaseDir()

◆ getId()

◆ getSaltProject()

◆ getStatus()

◆ getStatusReport()

◆ getStepDescs()

◆ load()

◆ save()

◆ setBaseDir()

◆ toString()

Member Data Documentation

◆ id