Job (DAISY Pipeline 2 :: Java Client Library 5.0.1 API)

java.lang.Object
- org.daisy.pipeline.client.models.Job

All Implemented Interfaces:

Comparable<Job>
```
public class Job
extends Object
implements Comparable<Job>
```
A representation of a Pipeline 2 job. This represents a job both before (job request) and after (job response) it is submitted to the engine.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Job.Priority

static class Job.Status

Nested Classes
Modifier and Type	Class and Description
`static class`	`Job.Priority`
`static class`	`Job.Status`

Constructor Summary

Constructors
Constructor and Description
`Job()` Create an empty representation of a job.
`Job(Job oldJob, JobStorage newStorage)` Creates a new job based on an old job.
`Job(Node jobXml)` Parse the job described by the provided XML document/node.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Job o)`
`Argument`	`getArgument(String name)`
`List<Argument>`	`getArguments()` Get all arguments, both inputs and outputs.
`String`	`getBatchId()`
`List<Callback>`	`getCallback()`
`String`	`getDescription()`
`String`	`getHref()`
`String`	`getId()`
`List<Argument>`	`getInputs()`
`JobStorage`	`getJobStorage()`
`String`	`getLogHref()`
`List<Message>`	`getMessages()` Get a list of all messages for the job.
`List<Message>`	`getMessages(int maxDepth)` Get a list of all messages for the job.
`String`	`getNicename()`
`List<Argument>`	`getOutputs()`
`Job.Priority`	`getPriority()`
`BigDecimal`	`getProgress()`
`double`	`getProgressEstimate()` Get the estimated job progress in between server updates as a percentage.
`double`	`getProgressEstimate(Integer timeUntilUpdateRequest)`
`double`	`getProgressFrom()` Get the job progress as a percentage.
`Long`	`getProgressFromTime()` Get the time when the most up to date progress information from the server was received.
`double`	`getProgressTo()` Get the end of the current progress interval as a percentage.
`double`	`getProgressTo(Integer timeUntilUpdateRequest)`
`Integer`	`getQueuePosition()`
`Result`	`getResult()` Get the main Result object.
`Result`	`getResult(String argumentName)` Get the Result representing the argument with the given name.
`Result`	`getResult(String argumentName, String href)` Get the Result representing the file with the given name from the argument with the given name.
`static Result`	`getResultFromHref(Node resultsXml, String href)` Given the absolute href for the result, get the result without parsing the entire jobXml.
`Result`	`getResultFromHref(String href)` Get a result object for the result with the given absolute or relative href.
`SortedMap<Result,List<Result>>`	`getResults()` Get a map of all the Result objects.
`List<Result>`	`getResults(String argumentName)` Get the list of Results for the argument with the given name.
`Script`	`getScript()`
`String`	`getScriptHref()`
`Job.Status`	`getStatus()`
`void`	`joinMessages(Job jobUpdate)` Update this job's messages with a list of new messages from a job update.
`static List<Job>`	`parseJobsXml(Node jobsXml)` Parse the list of jobs described by the provided XML document/node.
`void`	`setBatchId(String batchId)`
`void`	`setCallback(List<Callback> callback)`
`void`	`setDescription(String description)`
`void`	`setHref(String href)`
`void`	`setId(String id)`
`void`	`setInputs(List<Argument> argumentInputs)`
`void`	`setJobStorage(JobStorage storage)`
`void`	`setJobXml(Node jobXml)` Set job XML and re-enable lazy loading for the new XML.
`void`	`setLogHref(String logHref)`
`void`	`setNicename(String nicename)`
`void`	`setOutputs(List<Argument> argumentOutputs)`
`void`	`setPriority(Job.Priority priority)`
`void`	`setProgress(BigDecimal progress)`
`void`	`setQueuePosition(Integer queuePosition)`
`void`	`setResults(Result result, SortedMap<Result,List<Result>> results)`
`void`	`setScript(Script script)`
`void`	`setScriptHref(String scriptHref)`
`void`	`setStatus(Job.Status status)`
`Document`	`toJobRequestXml(boolean absoluteUris)` Create jobRequest XML.
`String`	`toString()`
`Document`	`toXml()`
`String`	`validate()` Check that all the inputs and options is filled out properly.
`String`	`validate(String name)` Check that the argument with then provided name is filled out properly.

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

- Constructor Detail
  - Job
```
public Job()
```
    Create an empty representation of a job.
  - Job
```
public Job(Node jobXml)
    throws Pipeline2Exception
```
    Parse the job described by the provided XML document/node. Example: http://daisy-pipeline.googlecode.com/hg/webservice/samples/xml-formats/job.xml
    
    Parameters:
    
    jobXml - The XML
    
    Throws:
    
    Pipeline2Exception - thrown when an error occurs
  - Job
```
public Job(Job oldJob,
           JobStorage newStorage)
    throws Pipeline2Exception
```
    Creates a new job based on an old job. This effectively creates a new job in the same state as the old job was before being submitted to the engine. The status, messages, results, log, batchId, callback and progress will be reset. A new job storage can be provided, in which case all the files from the job storage in the old job will be copied over to the job storage in the new job. If the new job storage is the same object as the one used by the old job, points to the same path as the old job storage, or if the new job storage is null, then the old job storage will be reused.
    
    Parameters:
    
    oldJob - The old job where arguments will be copied from
    
    newStorage - The new job storage where files will be stored
    
    Throws:
    
    Pipeline2Exception
- Method Detail
  - getResultFromHref
```
public static Result getResultFromHref(Node resultsXml,
                                       String href)
```
    Given the absolute href for the result, get the result without parsing the entire jobXml.
    
    Parameters:
    
    resultsXml - The XML
    
    href - The href
    
    Returns:
    
    The Result
  - getMessages
```
public List<Message> getMessages()
```
    Get a list of all messages for the job.
    
    Returns:
    
    The list of messages
  - getMessages
```
public List<Message> getMessages(int maxDepth)
```
    Get a list of all messages for the job.
    
    Parameters:
    
    maxDepth - Don't return messages deeper than this level
    
    Returns:
    
    The list of messages
  - getResult
```
public Result getResult()
```
    Get the main Result object.
    
    Returns:
    
    The returned Result represents "all results".
  - getResult
```
public Result getResult(String argumentName)
```
    Get the Result representing the argument with the given name.
    
    Parameters:
    
    argumentName - The name of the argument
    
    Returns:
    
    The result
  - getResult
```
public Result getResult(String argumentName,
                        String href)
```
    Get the Result representing the file with the given name from the argument with the given name.
    
    Parameters:
    
    argumentName - The name of the argument
    
    href - filename with path relative to the argument.
    
    Returns:
    
    The result
  - getResults
```
public List<Result> getResults(String argumentName)
```
    Get the list of Results for the argument with the given name.
    
    Parameters:
    
    argumentName - The name of the argument
    
    Returns:
    
    The list of results
  - getResults
```
public SortedMap<Result,List<Result>> getResults()
```
    Get a map of all the Result objects. The keys are the result objects for each named output. Each key is associated with a list of Result objects, each representing a file in the named output.
    
    Returns:
    
    The returned map contains all named outputs and associated files.
  - parseJobsXml
```
public static List<Job> parseJobsXml(Node jobsXml)
                              throws Pipeline2Exception
```
    Parse the list of jobs described by the provided XML document/node. Example: http://daisy-pipeline.googlecode.com/hg/webservice/samples/xml-formats/jobs.xml
    
    Parameters:
    
    jobsXml - The XML
    
    Returns:
    
    The list of jobs
    
    Throws:
    
    Pipeline2Exception - thrown when an error occurs
  - validate
```
public String validate()
```
    Check that all the inputs and options is filled out properly. The script associated with this job must be defined.
    
    Returns:
    
    a message describing the first error, or null if there is no error
  - validate
```
public String validate(String name)
```
    Check that the argument with then provided name is filled out properly. The script associated with this job must be defined.
    
    Parameters:
    
    name - The name of the parameter to validate
    
    Returns:
    
    a message describing the error, or null if there is no error
  - getId
```
public String getId()
```
  - getHref
```
public String getHref()
```
  - getStatus
```
public Job.Status getStatus()
```
  - getPriority
```
public Job.Priority getPriority()
```
  - getQueuePosition
```
public Integer getQueuePosition()
```
  - getNicename
```
public String getNicename()
```
  - getDescription
```
public String getDescription()
```
  - getBatchId
```
public String getBatchId()
```
  - getScript
```
public Script getScript()
```
  - getScriptHref
```
public String getScriptHref()
```
  - getCallback
```
public List<Callback> getCallback()
```
  - getProgress
```
public BigDecimal getProgress()
```
  - getLogHref
```
public String getLogHref()
```
  - getJobStorage
```
public JobStorage getJobStorage()
```
  - setId
```
public void setId(String id)
```
  - setHref
```
public void setHref(String href)
```
  - setStatus
```
public void setStatus(Job.Status status)
```
  - setPriority
```
public void setPriority(Job.Priority priority)
```
  - setQueuePosition
```
public void setQueuePosition(Integer queuePosition)
```
  - setNicename
```
public void setNicename(String nicename)
```
  - setDescription
```
public void setDescription(String description)
```
  - setBatchId
```
public void setBatchId(String batchId)
```
  - setScript
```
public void setScript(Script script)
```
  - setScriptHref
```
public void setScriptHref(String scriptHref)
```
  - setCallback
```
public void setCallback(List<Callback> callback)
```
  - setProgress
```
public void setProgress(BigDecimal progress)
```
  - setLogHref
```
public void setLogHref(String logHref)
```
  - setJobStorage
```
public void setJobStorage(JobStorage storage)
```
  - joinMessages
```
public void joinMessages(Job jobUpdate)
```
    Update this job's messages with a list of new messages from a job update.
  - setResults
```
public void setResults(Result result,
                       SortedMap<Result,List<Result>> results)
```
  - setJobXml
```
public void setJobXml(Node jobXml)
```
    Set job XML and re-enable lazy loading for the new XML.
    
    Parameters:
    
    jobXml - The XML
  - getInputs
```
public List<Argument> getInputs()
```
  - getOutputs
```
public List<Argument> getOutputs()
```
  - setInputs
```
public void setInputs(List<Argument> argumentInputs)
```
  - setOutputs
```
public void setOutputs(List<Argument> argumentOutputs)
```
  - getArgument
```
public Argument getArgument(String name)
```
  - compareTo
```
public int compareTo(Job o)
```
    Specified by:
    
    compareTo in interface Comparable<Job>
  - getResultFromHref
```
public Result getResultFromHref(String href)
```
    Get a result object for the result with the given absolute or relative href.
    
    Parameters:
    
    href - if relative, must be relative to the top-level `…/results/` URL segment.
    
    Returns:
    
    The result
  - toXml
```
public Document toXml()
```
  - toJobRequestXml
```
public Document toJobRequestXml(boolean absoluteUris)
```
    Create jobRequest XML. If absoluteUris is true, file hrefs will be absolute file:/ URLs.
    
    Parameters:
    
    absoluteUris - base directory for files
    
    Returns:
    
    jobRequest XML document
  - getArguments
```
public List<Argument> getArguments()
```
    Get all arguments, both inputs and outputs. See also getInputs and getOutputs.
    
    Returns:
    
    a list of all arguments.
  - getProgressFrom
```
public double getProgressFrom()
```
    Get the job progress as a percentage. This represents the most up to date progress information from the server.
  - getProgressFromTime
```
public Long getProgressFromTime()
```
    Get the time when the most up to date progress information from the server was received.
    
    Returns:
    
    the time as UNIX time.
  - getProgressTo
```
public double getProgressTo()
```
    Get the end of the current progress interval as a percentage.
    
    Returns:
    
    the end of the current progress interval.
  - getProgressTo
```
public double getProgressTo(Integer timeUntilUpdateRequest)
```
    Parameters:
    
    timeUntilUpdateRequest - The time until the next update request is expected, in nanoseconds.
  - getProgressEstimate
```
public double getProgressEstimate()
```
    Get the estimated job progress in between server updates as a percentage. This value is always greater than or equal to the result of calling getProgressFrom() which represents the most up to date progress information from the server. The estimate is an interpolation based on the current progress interval and the job duration. The "current progress interval" is an interval that starts with the most recent progress value received from the server and in which no updates from the server are expected. It is chosen in such a way that the end is not expected to be reached before the next update request to the server. Note that an update request does not necessarily result in an actual progress update. (Details about how the interval is determined are omitted here.) The estimate is calculated according to this formula: P(t) = P_{N+1} - P_{N} e^{-\frac{t-t_{N}}{T})} where: - `P` is the progress estimate - `t` is the current time, in seconds - `t_{0}` is the time when the job started (i.e. the first progress message arrived) - `t_{N}` is the time when information about the current progress interval arrived, in seconds - `P_{N+1}` is the progress at the end of the current progress interval - `P_{N}` is the progress at the beginning of the current progress interval - `T` is the time constant which determines how slowly the estimated progress approaches P_{N+1}. 20 is chosen as the initial value so that after 60 seconds the progress will be 95 % through the current progress interval. When `P_{N} > 0` and `t_{N} - t_{0} > 0` then T is dynamically calculated so that it adapts to the speed of the conversion. T is set using this formula: T = \frac{-t_{N} (\frac{P_{N+1}}{P_{N}} - 1)}{\ln 0.05}
    
    Returns:
    
    the estimated progress as a percentage.
  - getProgressEstimate
```
public double getProgressEstimate(Integer timeUntilUpdateRequest)
```
    Parameters:
    
    timeUntilUpdateRequest - The time until the next update request is expected, in nanoseconds.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Job

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Job

Job

Job

Method Detail

getResultFromHref

getMessages

getMessages

getResult

getResult

getResult

getResults

getResults

parseJobsXml

validate

validate

getId

getHref

getStatus

getPriority

getQueuePosition

getNicename

getDescription

getBatchId

getScript

getScriptHref

getCallback

getProgress

getLogHref

getJobStorage

setId

setHref

setStatus

setPriority

setQueuePosition

setNicename

setDescription

setBatchId

setScript

setScriptHref

setCallback

setProgress

setLogHref

setJobStorage

joinMessages

setResults

setJobXml

getInputs

getOutputs

setInputs

setOutputs

getArgument

compareTo

getResultFromHref

toXml

toJobRequestXml

getArguments

getProgressFrom

getProgressFromTime

getProgressTo

getProgressTo

getProgressEstimate

getProgressEstimate

toString