Job (Data Pipeline JavaDoc)

java.lang.Object
- com.northconcepts.datapipeline.job.Job

All Implemented Interfaces:

IJob, Runnable
```
public class Job
extends Object
implements IJob
```
Used to run, manage, and track pipelines.

Constructor Summary

Constructors
Constructor and Description

Job(DataReader reader, DataWriter writer)

Constructors
Constructor and Description
`Job(DataReader reader, DataWriter writer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addJobLifecycleListener(JobLifecycleListener listener)`
`Job`	`cancel()`
`protected Object`	`clone()`
`static List<Job>`	`getAll()` Returns all the live jobs in the JVM/classloader.
`JobCallback<DataReader,DataWriter>`	`getCallback()`
`Date`	`getCancelledOn()` Returns the time this job instance was cancelled.
`Job`	`getChild()` Returns the thread-local child job of this one while this job is running.
`Date`	`getCreatedOn()` Returns the time this job instance was created.
`static Job`	`getCurrent()` Returns the job currently running in this thread.
`DataException`	`getException()` Returns the last exception thrown while running.
`Date`	`getFinishedOn()` Returns the time this job finished running.
`long`	`getId()` Returns the unique (sequential) ID of this job (within this JVM/classloader).
`static int`	`getJobCount()` Returns the current number of live jobs in the JVM/classloader.
`Record`	`getLastRecord()` Returns the most recent record seen by this job while it is running or `null`.
`DataWriter`	`getLogWriter()`
`String`	`getName()` Returns the name assigned to this job or its default name if one was not assigned.
`Job`	`getParent()` Returns the thread-local job that ran this one while this job is running.
`Date`	`getPausedOn()` Returns the time this job was paused or `null` if this job is not currently paused.
`DataReader`	`getReader()` Returns the reader supplied to this job.
`<T extends DataReader> T`	`getReader(Class<T> type)` Returns the first reader of the supplied type from the read pipeline.
`List<DataReader>`	`getReaders()` Returns the read pipeline — the chain of readers records pass through, starting with the root instance and ending with the reader passed to this job (and returned by `getReader()`).
`long`	`getRecordsTransferred()` Returns the number of records sent from the supplied reader to the supplied writer.
`long`	`getRunningTime()` Returns the number of milliseconds this job was (or has been) running for or zero (0) if it hasn't yet started running.
`String`	`getRunningTimeAsString()` Returns the time this job was (or has been) running in long form as a human readable string (2 Years, 1 Second, 12 Millisecond) or `null` if it hasn't yet started running.
`String`	`getRunningTimeAsString(boolean shortForm)` Returns the time this job was (or has been) running as a human readable string in long form (2 Years, 1 Second, 12 Millisecond) or short form (2y 1s 12ms) or `null` if it hasn't yet started running.
`Thread`	`getRunThread()` Returns the thread currently executing this job or `null` if the job is not running.
`Date`	`getStartedOn()` Returns the time this job instance started running.
`UUID`	`getUuid()` Returns the universally unique identifier (UUID) for this job.
`DataWriter`	`getWriter()` Returns the writer supplied to this job.
`<T extends DataWriter> T`	`getWriter(Class<T> type)` Returns the first writer of the supplied type from the write pipeline.
`List<DataWriter>`	`getWriters()` Returns the write pipeline — the chain of writers records pass through, starting with the writer passed to this job and returned by `getWriter()` and ending with the root instance.
`boolean`	`hasCallback()`
`boolean`	`isAutoCloseLogWriter()`
`boolean`	`isCancelled()` Returns `true` if this job was cancelled.
`boolean`	`isFailed()` Returns `true` if this job has completed unsuccessfully.
`boolean`	`isFinished()` Returns `true` if this job has finished running.
`boolean`	`isPaused()` Returns `true` if this job is currently paused.
`boolean`	`isRunning()` Returns `true` if this job is currently running.
`Job`	`log()`
`protected void`	`onFinish()` Called when this job finishes.
`protected void`	`onPause()` Called when this job is paused.
`protected void`	`onStart()` Called when this job starts.
`Job`	`pause()`
`static void`	`removeJobLifecycleListener(JobLifecycleListener listener)`
`Job`	`resume()`
`void`	`run()` Executes this job in the current thread.
`static Job`	`run(DataReader reader, DataWriter writer)`
`static Job`	`run(DataReader reader, DataWriter writer, JobCallback<DataReader,DataWriter> callback)`
`Job`	`runAsync()` Executes this job in a new thread.
`static Job`	`runAsync(DataReader reader, DataWriter writer)`
`static Job`	`runAsync(DataReader reader, DataWriter writer, JobCallback<DataReader,DataWriter> callback)`
`Job`	`setAutoCloseLogWriter(boolean autoCloseLogWriter)`
`Job`	`setCallback(JobCallback<DataReader,DataWriter> callback)`
`Job`	`setLogWriter(DataWriter logWriter)`
`Job`	`setName(String name)` Assigns a new name to this job.
`String`	`toDebugString()`
`String`	`toString()`
`Job`	`waitUntilFinished()` Waits for this job to complete.
`Job`	`waitUntilFinished(long timeout)` Waits up to `timeout` milliseconds for this job to complete or throws `InterruptedException`.
`Job`	`waitUntilStarted()` Waits for this job to start.
`Job`	`waitUntilStarted(long timeout)` Waits up to `timeout` milliseconds for this job to start or throws `InterruptedException`.

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

- Constructor Detail
  - Job
```
public Job(DataReader reader,
           DataWriter writer)
```
- Method Detail
  - addJobLifecycleListener
```
public static void addJobLifecycleListener(JobLifecycleListener listener)
```
  - removeJobLifecycleListener
```
public static void removeJobLifecycleListener(JobLifecycleListener listener)
```
  - run
```
public static Job run(DataReader reader,
                      DataWriter writer)
```
  - run
```
public static Job run(DataReader reader,
                      DataWriter writer,
                      JobCallback<DataReader,DataWriter> callback)
```
  - runAsync
```
public static Job runAsync(DataReader reader,
                           DataWriter writer)
```
  - runAsync
```
public static Job runAsync(DataReader reader,
                           DataWriter writer,
                           JobCallback<DataReader,DataWriter> callback)
```
  - getCurrent
```
public static Job getCurrent()
```
    Returns the job currently running in this thread.
  - getAll
```
public static List<Job> getAll()
```
    Returns all the live jobs in the JVM/classloader.
  - getJobCount
```
public static int getJobCount()
```
    Returns the current number of live jobs in the JVM/classloader.
  - getParent
```
public Job getParent()
```
    Returns the thread-local job that ran this one while this job is running.
    
    Specified by:
    
    getParent in interface IJob
  - getChild
```
public Job getChild()
```
    Returns the thread-local child job of this one while this job is running.
    
    Specified by:
    
    getChild in interface IJob
  - getId
```
public long getId()
```
    Returns the unique (sequential) ID of this job (within this JVM/classloader).
  - getUuid
```
public UUID getUuid()
```
    Returns the universally unique identifier (UUID) for this job.
    
    Specified by:
    
    getUuid in interface IJob
  - getName
```
public String getName()
```
    Returns the name assigned to this job or its default name if one was not assigned.
    
    Specified by:
    
    getName in interface IJob
  - setName
```
public Job setName(String name)
```
    Assigns a new name to this job.
    
    Specified by:
    
    setName in interface IJob
  - getReader
```
public DataReader getReader()
```
    Returns the reader supplied to this job.
  - getReader
```
public <T extends DataReader> T getReader(Class<T> type)
```
    Returns the first reader of the supplied type from the read pipeline.
  - getWriter
```
public DataWriter getWriter()
```
    Returns the writer supplied to this job.
  - getWriter
```
public <T extends DataWriter> T getWriter(Class<T> type)
```
    Returns the first writer of the supplied type from the write pipeline.
  - getReaders
```
public List<DataReader> getReaders()
```
    Returns the read pipeline — the chain of readers records pass through, starting with the root instance and ending with the reader passed to this job (and returned by getReader()).
  - getWriters
```
public List<DataWriter> getWriters()
```
    Returns the write pipeline — the chain of writers records pass through, starting with the writer passed to this job and returned by getWriter() and ending with the root instance.
  - getCreatedOn
```
public Date getCreatedOn()
```
    Returns the time this job instance was created.
    
    Specified by:
    
    getCreatedOn in interface IJob
  - getStartedOn
```
public Date getStartedOn()
```
    Returns the time this job instance started running.
    
    Specified by:
    
    getStartedOn in interface IJob
  - getCancelledOn
```
public Date getCancelledOn()
```
    Returns the time this job instance was cancelled.
    
    Specified by:
    
    getCancelledOn in interface IJob
  - isCancelled
```
public boolean isCancelled()
```
    Returns true if this job was cancelled.
    
    Specified by:
    
    isCancelled in interface IJob
  - getPausedOn
```
public Date getPausedOn()
```
    Returns the time this job was paused or null if this job is not currently paused.
    
    Specified by:
    
    getPausedOn in interface IJob
  - isPaused
```
public boolean isPaused()
```
    Returns true if this job is currently paused.
    
    Specified by:
    
    isPaused in interface IJob
  - getFinishedOn
```
public Date getFinishedOn()
```
    Returns the time this job finished running.
    
    Specified by:
    
    getFinishedOn in interface IJob
  - isFinished
```
public boolean isFinished()
```
    Returns true if this job has finished running.
    
    Specified by:
    
    isFinished in interface IJob
  - getException
```
public DataException getException()
```
    Returns the last exception thrown while running.
    
    Specified by:
    
    getException in interface IJob
  - isFailed
```
public boolean isFailed()
```
    Returns true if this job has completed unsuccessfully.
    
    Specified by:
    
    isFailed in interface IJob
  - getRunThread
```
public Thread getRunThread()
```
    Returns the thread currently executing this job or null if the job is not running.
    
    Specified by:
    
    getRunThread in interface IJob
  - isRunning
```
public boolean isRunning()
```
    Returns true if this job is currently running.
    
    Specified by:
    
    isRunning in interface IJob
  - getRunningTime
```
public long getRunningTime()
```
    Returns the number of milliseconds this job was (or has been) running for or zero (0) if it hasn't yet started running.
    
    Specified by:
    
    getRunningTime in interface IJob
  - getRunningTimeAsString
```
public String getRunningTimeAsString()
```
    Returns the time this job was (or has been) running in long form as a human readable string (2 Years, 1 Second, 12 Millisecond) or null if it hasn't yet started running.
    
    Specified by:
    
    getRunningTimeAsString in interface IJob
  - getRunningTimeAsString
```
public String getRunningTimeAsString(boolean shortForm)
```
    Returns the time this job was (or has been) running as a human readable string in long form (2 Years, 1 Second, 12 Millisecond) or short form (2y 1s 12ms) or null if it hasn't yet started running.
    
    Specified by:
    
    getRunningTimeAsString in interface IJob
  - getRecordsTransferred
```
public long getRecordsTransferred()
```
    Returns the number of records sent from the supplied reader to the supplied writer.
  - getLastRecord
```
public Record getLastRecord()
```
    Returns the most recent record seen by this job while it is running or null.
  - getCallback
```
public JobCallback<DataReader,DataWriter> getCallback()
```
  - hasCallback
```
public boolean hasCallback()
```
  - setCallback
```
public Job setCallback(JobCallback<DataReader,DataWriter> callback)
```
  - pause
```
public Job pause()
```
    Specified by:
    
    pause in interface IJob
  - resume
```
public Job resume()
```
    Specified by:
    
    resume in interface IJob
  - cancel
```
public Job cancel()
```
    Specified by:
    
    cancel in interface IJob
  - onStart
```
protected void onStart()
```
    Called when this job starts.
  - onFinish
```
protected void onFinish()
```
    Called when this job finishes.
  - onPause
```
protected void onPause()
```
    Called when this job is paused.
  - setLogWriter
```
public Job setLogWriter(DataWriter logWriter)
```
  - getLogWriter
```
public DataWriter getLogWriter()
```
  - isAutoCloseLogWriter
```
public boolean isAutoCloseLogWriter()
```
  - setAutoCloseLogWriter
```
public Job setAutoCloseLogWriter(boolean autoCloseLogWriter)
```
  - log
```
public Job log()
```
  - run
```
public void run()
```
    Executes this job in the current thread. This method blocks until the transfer either completes successfully or fails for any reason.
    
    Specified by:
    
    run in interface IJob
    
    Specified by:
    
    run in interface Runnable
  - runAsync
```
public Job runAsync()
```
    Executes this job in a new thread. This method does not block.
    
    Specified by:
    
    runAsync in interface IJob
  - waitUntilStarted
```
public Job waitUntilStarted()
                     throws InterruptedException
```
    Waits for this job to start.
    
    Specified by:
    
    waitUntilStarted in interface IJob
    
    Returns:
    
    Throws:
    
    InterruptedException
  - waitUntilStarted
```
public Job waitUntilStarted(long timeout)
                     throws InterruptedException
```
    Waits up to timeout milliseconds for this job to start or throws InterruptedException.
    
    Specified by:
    
    waitUntilStarted in interface IJob
    
    Returns:
    
    Throws:
    
    InterruptedException
  - waitUntilFinished
```
public Job waitUntilFinished()
                      throws InterruptedException
```
    Waits for this job to complete.
    
    Specified by:
    
    waitUntilFinished in interface IJob
    
    Returns:
    
    Throws:
    
    InterruptedException
  - waitUntilFinished
```
public Job waitUntilFinished(long timeout)
                      throws InterruptedException
```
    Waits up to timeout milliseconds for this job to complete or throws InterruptedException.
    
    Specified by:
    
    waitUntilFinished in interface IJob
    
    Returns:
    
    Throws:
    
    InterruptedException
  - clone
```
protected Object clone()
                throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - toDebugString
```
public String toDebugString()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Job

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Job

Method Detail

addJobLifecycleListener

removeJobLifecycleListener

run

run

runAsync

runAsync

getCurrent

getAll

getJobCount

getParent

getChild

getId

getUuid

getName

setName

getReader

getReader

getWriter

getWriter

getReaders

getWriters

getCreatedOn

getStartedOn

getCancelledOn

isCancelled

getPausedOn

isPaused

getFinishedOn

isFinished

getException

isFailed

getRunThread

isRunning

getRunningTime

getRunningTimeAsString

getRunningTimeAsString

getRecordsTransferred

getLastRecord

getCallback

hasCallback

setCallback

pause

resume

cancel

onStart

onFinish

onPause

setLogWriter

getLogWriter

isAutoCloseLogWriter

setAutoCloseLogWriter

log

run

runAsync

waitUntilStarted

waitUntilStarted

waitUntilFinished

waitUntilFinished

clone

toDebugString

toString