ca.eandb.jdcp.job

Interface ParallelizableJob

All Superinterfaces:

Serializable

All Known Implementing Classes:

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

public interface ParallelizableJob
extends Serializable

Represents a job that can be split into smaller chunks.

Author:

Brad Kimmel

Method Summary

Modifier and Type	Method and Description
void	finish() Performs any final actions required for this ParallelizableJob.
Object	getNextTask() Gets the next task to be performed.
void	initialize() Sets up this ParallelizableJob on the machine hosting the job (not necessarily the same machine as the one processing the tasks for this job).
boolean	isComplete() Gets a value that indicates if this job is complete (i.e., if results for all tasks have been submitted).
void	restoreState(ObjectInput input) Notifies the job that it is about to be resumed after having been suspended.
void	saveState(ObjectOutput output) Notifies the job that it is about to be suspended (for example, if the server application is about to be shut down).
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.

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.

initialize

void initialize()
         throws Exception

Sets up this ParallelizableJob on the machine hosting the job (not necessarily the same machine as the one processing the tasks for this job).

Throws:

Exception - If an error occurs performing the operation.

finish

void finish()
     throws Exception

Performs any final actions required for this ParallelizableJob.

Throws:

Exception - If an error occurs performing the operation.

saveState

void saveState(ObjectOutput output)
        throws Exception

Notifies the job that it is about to be suspended (for example, if the server application is about to be shut down).

Parameters:

output - The ObjectOutput to save state to.

Throws:

Exception - If an error occurs performing the operation.

restoreState

void restoreState(ObjectInput input)
           throws Exception

Notifies the job that it is about to be resumed after having been suspended. The job should reinstate any transient data (e.g., open files).

Parameters:

input - The ObjectInput to restore state from.

Throws:

Exception - If an error occurs performing the operation.

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.