ca.eandb.jdcp.job

Class CompositeParallelizableJob

java.lang.Object

ca.eandb.jdcp.job.CompositeParallelizableJob

All Implemented Interfaces:

ParallelizableJob, Serializable

public final class CompositeParallelizableJob
extends Object
implements ParallelizableJob

A ParallelizableJob that combines multiple jobs into one.

Author:

Brad Kimmel

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CompositeParallelizableJob()
CompositeParallelizableJob(Collection<ParallelizableJob> jobs)

Method Summary

Modifier and Type	Method and Description
CompositeParallelizableJob	addJob(ParallelizableJob job)
CompositeParallelizableJob	addJobs(Collection<ParallelizableJob> jobs)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeParallelizableJob

public CompositeParallelizableJob()

CompositeParallelizableJob

public CompositeParallelizableJob(Collection<ParallelizableJob> jobs)

Method Detail

addJob

public CompositeParallelizableJob addJob(ParallelizableJob job)

addJobs

public CompositeParallelizableJob addJobs(Collection<ParallelizableJob> jobs)

setHostService

public void setHostService(HostService host)

Description copied from interface: ParallelizableJob

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

Specified by:

setHostService in interface ParallelizableJob

Parameters:

host - The HostService to use.

initialize

public void initialize()
                throws Exception

Description copied from interface: ParallelizableJob

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

Specified by:

initialize in interface ParallelizableJob

Throws:

Exception - If an error occurs performing the operation.

finish

public void finish()
            throws Exception

Description copied from interface: ParallelizableJob

Performs any final actions required for this ParallelizableJob.

Specified by:

finish in interface ParallelizableJob

Throws:

Exception - If an error occurs performing the operation.

saveState

public void saveState(ObjectOutput output)
               throws Exception

Description copied from interface: ParallelizableJob

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

Specified by:

saveState in interface ParallelizableJob

Parameters:

output - The ObjectOutput to save state to.

Throws:

Exception - If an error occurs performing the operation.

restoreState

public void restoreState(ObjectInput input)
                  throws Exception

Description copied from interface: ParallelizableJob

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).

Specified by:

restoreState in interface ParallelizableJob

Parameters:

input - The ObjectInput to restore state from.

Throws:

Exception - If an error occurs performing the operation.

getNextTask

public Object getNextTask()
                   throws Exception

Description copied from interface: ParallelizableJob

Gets the next task to be performed.

Specified by:

getNextTask in interface ParallelizableJob

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

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

Description copied from interface: ParallelizableJob

Submits the results of a task.

Specified by:

submitTaskResults in interface ParallelizableJob

Parameters:

task_ - The Object describing the task for which results are being submitted (must have been obtained from a previous call to ParallelizableJob.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:

ParallelizableJob.getNextTask()

isComplete

public boolean isComplete()
                   throws Exception

Description copied from interface: ParallelizableJob

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

Specified by:

isComplete in interface ParallelizableJob

Returns:

A value indicating if this job is complete.

Throws:

Exception - If an error occurs performing the operation.

worker

public TaskWorker worker()
                  throws Exception

Description copied from interface: ParallelizableJob

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

Specified by:

worker in interface ParallelizableJob

Returns:

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

Throws:

Exception - If an error occurs performing the operation.