PepperJob (pepper-framework 3.2.2 API)

java.lang.Object
- org.corpus_tools.pepper.common.PepperJob

Direct Known Subclasses:: PepperJobImpl

public abstract class PepperJob
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`id` Identifier of this job.
`protected JOB_STATUS`	`status` status of job
`protected Vector<StepDesc>`	`stepDescs` list of all step descriptions

Constructor Summary

Constructors
Constructor and Description

PepperJob()

Constructors
Constructor and Description
`PepperJob()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addStepDesc(StepDesc stepDesc)` Adds a `StepDesc` object to job.
`abstract void`	`clear()` Removes all `Step`s from all internal lists.
`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.
`StepDesc`	`createStepDesc()` Creates a `StepDesc` object an returns it, without adding the created `StepDesc` object to this `PepperJob` object.
`org.eclipse.emf.common.util.URI`	`getBaseDir()` Returns the base directory for this `ModuleController`.
`String`	`getId()` Returns the unique identifier for this job.
`abstract org.corpus_tools.salt.common.SaltProject`	`getSaltProject()` Returns the `SaltProject` which is converted by this job.
`JOB_STATUS`	`getStatus()` Returns the current status of 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.
`abstract void`	`load(org.eclipse.emf.common.util.URI uri)` Loads a serialization of a `PepperJob` and fills this object with these entries.
`abstract org.eclipse.emf.common.util.URI`	`save(org.eclipse.emf.common.util.URI uri)` Stores this job to the file at passed URI.
`void`	`setBaseDir(org.eclipse.emf.common.util.URI baseDir)` Sets the base directory for this `ModuleController`.
`String`	`toString()` Returns a textual representation of this Pepper job.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - id
```
protected String id
```
    Identifier of this job. Should be unique in Pepper.
  - status
```
protected JOB_STATUS status
```
    status of job
  - stepDescs
```
protected Vector<StepDesc> stepDescs
```
    list of all step descriptions
- Constructor Detail
  - PepperJob
```
public PepperJob()
```
- Method Detail
  - getId
```
public String getId()
```
    Returns the unique identifier for this job.
    
    Returns:
    
    unique identifier.
  - setBaseDir
```
public void setBaseDir(org.eclipse.emf.common.util.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
  - getBaseDir
```
public org.eclipse.emf.common.util.URI 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
  - getStatus
```
public JOB_STATUS getStatus()
```
    Returns the current status of this job.
    
    Returns:
    
    status of this job
  - getSaltProject
```
public abstract org.corpus_tools.salt.common.SaltProject getSaltProject()
```
    Returns the SaltProject which is converted by this job.
    
    Returns:
    
    SaltProject
  - getStatusReport
```
public abstract String getStatusReport()
```
    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
```
public List<StepDesc> 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
  - addStepDesc
```
public void addStepDesc(StepDesc stepDesc)
```
    Adds a StepDesc object to job.
    
    Parameters:
    
    stepDesc - description object of a particular step
  - createStepDesc
```
public StepDesc 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 {@link #createStepDesc(MODULE_TYPE)
    
    Returns:
    
    created StepDesc object
  - convert
```
public abstract void convert()
```
    Starts the conversion of this job.
    - If the single steps of the job has not already been wired, they will be wired.
    - If PepperImporter.importCorpusStructure(org.corpus_tools.salt.common.SCorpusGraph) has not already been called, it will be done.
  - convertFrom
```
public abstract void convertFrom()
```
    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
```
public abstract void convertTo()
```
    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'.
  - load
```
public abstract void load(org.eclipse.emf.common.util.URI uri)
```
    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
```
public abstract org.eclipse.emf.common.util.URI save(org.eclipse.emf.common.util.URI uri)
```
    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()).
  - clear
```
public abstract void clear()
```
    Removes all Steps from all internal lists.
  - toString
```
public String toString()
```
    Returns a textual representation of this Pepper job. Note: This representation could not be used for serialization/deserialization purposes.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    textual representation

Class PepperJob

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

status

stepDescs

Constructor Detail

PepperJob

Method Detail

getId

setBaseDir

getBaseDir

getStatus

getSaltProject

getStatusReport

getStepDescs

addStepDesc

createStepDesc

convert

convertFrom

convertTo

load

save

clear

toString