Package org.openforis.concurrency

Class Job

java.lang.Object

org.openforis.concurrency.Worker

org.openforis.concurrency.Job

public abstract class Job
extends Worker

Synchronously executes a series of Tasks in order.

Author:

M. Togna, S. Ricci

Nested Class Summary

Nested classes/interfaces inherited from class org.openforis.concurrency.Worker

Worker.Status

Constructor Summary

Constructors

Constructor	Description
Job()

Method Summary

Modifier and Type	Method	Description
void	abort()
protected <T extends Worker> T	addTask(Class<T> type)	Creates and adds a task of the specified type.
protected <T extends Worker> void	addTask(T task)	Throws IllegalStateException if invoked after run() is called
protected <C extends Collection<? extends Worker>> void	addTasks(C tasks)
protected abstract void	buildTasks()	Creates and adds tasks to this job.
protected <T extends Worker> T	createTask(Class<T> type)
protected void	execute()	Runs each contained task in order.
Worker	getCurrentTask()
int	getCurrentTaskIndex()
JobManager	getJobManager()
int	getProgressPercent()
List<Worker>	getTasks()
protected boolean	hasTaskToRun()
protected void	initializeInternalVariables()	Builds all the tasks.
protected void	initializeTask(Worker task)	Called before task execution.
protected Worker	nextTask()
protected void	onTaskCompleted(Worker task)	Called when the task ends its execution with the status Worker.Status.COMPLETED
protected void	onTaskEnd(Worker task)	Called when the task ends its execution.
protected void	onTaskFailed(Worker task)
void	release()	Releases the resource used during the execution
protected void	runTask(Worker task)
void	setJobManager(JobManager jobManager)

Methods inherited from class org.openforis.concurrency.Worker

addStatusChangeListener, afterExecute, afterExecuteInternal, beforeExecute, beforeExecuteInternal, changeStatus, createInternalVariables, destroy, getDuration, getEndTime, getErrorMessage, getErrorMessageArgs, getId, getLastException, getName, getStartTime, getStatus, getWeight, initialize, isAborted, isCompleted, isEnded, isFailed, isPending, isRunning, logDebug, logError, logInfo, logWarning, notifyAllStatusChangeListeners, onAborted, onCompleted, onEnd, onFailed, removeStatusChangeListener, run, setErrorMessage, setErrorMessageArgs, setLastException, setWeight, validateInput, waitFor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Job

public Job()

Method Detail

initializeInternalVariables

protected void initializeInternalVariables()
                                    throws Throwable

Builds all the tasks. Each task will be initialized before running it.

Overrides:

initializeInternalVariables in class Worker

Throws:

Throwable

getProgressPercent

public int getProgressPercent()

Specified by:

getProgressPercent in class Worker

abort

public void abort()

Overrides:

abort in class Worker

execute

protected void execute()
                throws Throwable

Runs each contained task in order.

Specified by:

execute in class Worker

Throws:

Exception

Throwable

runTask

protected void runTask(Worker task)
                throws Throwable

Throws:

Throwable

buildTasks

protected abstract void buildTasks()
                            throws Throwable

Creates and adds tasks to this job.

Throws:

Throwable

createTask

protected <T extends Worker> T createTask(Class<T> type)

hasTaskToRun

protected boolean hasTaskToRun()

nextTask

protected Worker nextTask()

addTask

protected <T extends Worker> T addTask(Class<T> type)

Creates and adds a task of the specified type.

Parameters:

type -

Returns:

addTask

protected <T extends Worker> void addTask(T task)

Throws IllegalStateException if invoked after run() is called

Parameters:

task -

addTasks

protected <C extends Collection<? extends Worker>> void addTasks(C tasks)

onTaskEnd

protected void onTaskEnd(Worker task)

Called when the task ends its execution. The status can be Worker.Status.COMPLETED, Worker.Status.FAILED, Worker.Status.ABORTED

Parameters:

task -

onTaskCompleted

protected void onTaskCompleted(Worker task)

Called when the task ends its execution with the status Worker.Status.COMPLETED

Parameters:

task -

onTaskFailed

protected void onTaskFailed(Worker task)
                     throws Throwable

Throws:

Throwable

initializeTask

protected void initializeTask(Worker task)

Called before task execution.

Parameters:

task -

release

public void release()

Description copied from class: Worker

Releases the resource used during the execution

Overrides:

release in class Worker

getTasks

public List<Worker> getTasks()

getCurrentTaskIndex

public int getCurrentTaskIndex()

getCurrentTask

public Worker getCurrentTask()

getJobManager

public JobManager getJobManager()

setJobManager

public void setJobManager(JobManager jobManager)