ca.eandb.jdcp.job

Interface ParallelizableJob

All Superinterfaces:

LifeCycleManageable, Serializable

All Known Implementing Classes:

AbstractParallelizableJob, CompositeParallelizableJob, DiagnosticJob, DummyParallelizableJob, ExceptionTestJob, JobExecutionWrapper, TaskRandomizedJob, TaskReversedJob

public interface ParallelizableJob
extends LifeCycleManageable, Serializable

Represents a job that can be split into smaller chunks.

Author:

Brad Kimmel

Method Summary

Modifier and Type	Method and Description
Object	getNextTask() Gets the next task to be performed.
boolean	isComplete() Gets a value that indicates if this job is complete (i.e., if results for all tasks have been submitted).
void	setHostService(HostService host) Sets the HostService object that provides secure access to the file system on the machine hosting this ParallelizableJob.
void	submitTaskResults(Object task, Object results, ca.eandb.util.progress.ProgressMonitor monitor) Submits the results of a task.
TaskWorker	worker() Gets the task worker to use to process the tasks of this job.

Methods inherited from interface ca.eandb.jdcp.job.LifeCycleManageable

finish, initialize, restoreState, saveState

Method Detail

setHostService

void setHostService(HostService host)

Sets the HostService object that provides secure access to the file system on the machine hosting this ParallelizableJob.

Parameters:

host - The HostService to use.

getNextTask

Object getNextTask()
            throws Exception

Gets the next task to be performed.

Returns:

The Object describing the next task to be performed, or null if there are no remaining tasks.

Throws:

Exception - If an error occurs performing the operation.

submitTaskResults

void submitTaskResults(Object task,
                       Object results,
                       ca.eandb.util.progress.ProgressMonitor monitor)
                throws Exception

Submits the results of a task.

Parameters:

task - The Object describing the task for which results are being submitted (must have been obtained from a previous call to getNextTask().

results - The Object containing the results of a task.

monitor - The ProgressMonitor to update with the progress of this Job.

Throws:

Exception - If an error occurs performing the operation.

See Also:

getNextTask()

isComplete

boolean isComplete()
            throws Exception

Gets a value that indicates if this job is complete (i.e., if results for all tasks have been submitted).

Returns:

A value indicating if this job is complete.

Throws:

Exception - If an error occurs performing the operation.

worker

TaskWorker worker()
           throws Exception

Gets the task worker to use to process the tasks of this job.

Returns:

The task worker to use to process the tasks of this job.

Throws:

Exception - If an error occurs performing the operation.