Pepper
3.6.0
A highly extensible plattform for conversion and manipulationoflinguisticdata.
|
Inherited by org.corpus_tools.pepper.core.PepperJobImpl.
Public Member Functions | |
String | getId () |
Returns the unique identifier for this job. More... | |
void | setBaseDir (URI baseDir) |
Sets the base directory for this ModuleController. More... | |
URI | getBaseDir () |
Returns the base directory for this ModuleController. More... | |
JOB_STATUS | getStatus () |
Returns the current status of this job. More... | |
abstract SaltProject | getSaltProject () |
Returns the SaltProject which is converted by this job. More... | |
abstract String | getStatusReport () |
Returns a formated string as a kind of a document centric progress status. More... | |
List< StepDesc > | getStepDescs () |
Returns a list of all step descriptions. More... | |
void | addStepDesc (StepDesc stepDesc) |
Adds a StepDesc object to job. More... | |
StepDesc | createStepDesc () |
Creates a StepDesc object an returns it, without adding the created StepDesc object to this PepperJob object. More... | |
abstract void | convert () |
Starts the conversion of this job. More... | |
abstract void | convertFrom () |
Imports a SaltProject from any format. More... | |
abstract void | convertTo () |
Exports the SaltProject into any format. More... | |
abstract void | cancelConversion () |
Cancels the current conversion. More... | |
abstract void | load (URI uri) |
Loads a serialization of a PepperJob and fills this object with these entries. More... | |
abstract URI | save (URI uri) |
Stores this job to the file at passed URI. More... | |
abstract void | clear () |
Removes all Steps from all internal lists. | |
String | toString () |
Returns a textual representation of this Pepper job. More... | |
Protected Attributes | |
String | id = null |
Identifier of this job. More... | |
JOB_STATUS | status = JOB_STATUS.NOT_STARTED |
status of job | |
Vector< StepDesc > | stepDescs = null |
list of all step descriptions | |
void org.corpus_tools.pepper.common.PepperJob.addStepDesc | ( | StepDesc | stepDesc | ) |
Adds a StepDesc object to job.
stepDesc | description object of a particular step |
Reimplemented in org.corpus_tools.pepper.core.PepperJobImpl.
|
abstract |
Cancels the current conversion.
This might not stop immediately, but might finish the running document controller jobs first.
Reimplemented in org.corpus_tools.pepper.core.PepperJobImpl.
|
abstract |
Starts the conversion of this job.
Reimplemented in org.corpus_tools.pepper.core.PepperJobImpl.
|
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().
Reimplemented in org.corpus_tools.pepper.core.PepperJobImpl.
|
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'.
Reimplemented in org.corpus_tools.pepper.core.PepperJobImpl.
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
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.
String org.corpus_tools.pepper.common.PepperJob.getId | ( | ) |
Returns the unique identifier for this job.
|
abstract |
Returns the SaltProject which is converted by this job.
Reimplemented in org.corpus_tools.pepper.core.PepperJobImpl.
JOB_STATUS org.corpus_tools.pepper.common.PepperJob.getStatus | ( | ) |
Returns the current status of this job.
|
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.
Reimplemented in org.corpus_tools.pepper.core.PepperJobImpl.
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).
|
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.
uri | path of file to load. |
Reimplemented in org.corpus_tools.pepper.core.PepperJobImpl.
|
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.
uri | The location where to store this job. |
Reimplemented in org.corpus_tools.pepper.core.PepperJobImpl.
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.
baseDir | base directory |
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.
Reimplemented in org.corpus_tools.pepper.core.PepperJobImpl.
|
protected |
Identifier of this job.
Should be unique in Pepper.