ca.eandb.jdcp.job

Class ParallelizableJobRunner.Builder

java.lang.Object

ca.eandb.jdcp.job.ParallelizableJobRunner.Builder

Enclosing class:

ParallelizableJobRunner

public static class ParallelizableJobRunner.Builder
extends Object

A Builder for creating ParallelizableJobRunner instances.

Method Summary

Modifier and Type	Method and Description
ParallelizableJobRunner	build() Creates the configured ParallelizableJobRunner instance.
ParallelizableJobRunner.Builder	setExecutor(Executor executor) Sets the executor to use to run the threads for processing individual tasks.
ParallelizableJobRunner.Builder	setJob(ParallelizableJob job) Sets the job to be executed by the ParallelizableJobRunner.
ParallelizableJobRunner.Builder	setMaxConcurrentWorkers(int maxConcurrentWorkers) Sets the maximum number of concurrent tasks to run.
ParallelizableJobRunner.Builder	setProgressMonitor(ca.eandb.util.progress.ProgressMonitor progressMonitor) Sets the ProgressMonitor to use to report overall progress to.
ParallelizableJobRunner.Builder	setProgressMonitorFactory(ca.eandb.util.progress.ProgressMonitorFactory progressMonitorFactory) Sets the ProgressMonitorFactory to use to create ProgressMonitors for individual tasks.
ParallelizableJobRunner.Builder	setWorkingDirectory(File workingDirectory) Sets the working directory to use for writing results.
ParallelizableJobRunner.Builder	setWorkingDirectory(String workingDirectory) Sets the working directory to use for writing results.

Methods inherited from class java.lang.Object

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

Method Detail

build

public ParallelizableJobRunner build()
                              throws IOException

Creates the configured ParallelizableJobRunner instance.

Returns:

The new ParallelizableJobRunner.

Throws:

IllegalStateException - If the job has not been set.

IOException - If an error occurs setting up the working directory.

See Also:

setJob(ParallelizableJob)

setJob

public ParallelizableJobRunner.Builder setJob(ParallelizableJob job)

Sets the job to be executed by the ParallelizableJobRunner. This property is required in order to build the ParallelizableJobRunner.

Parameters:

job - The ParallelizableJob to run.

Returns:

This Builder.

setWorkingDirectory

public ParallelizableJobRunner.Builder setWorkingDirectory(File workingDirectory)

Sets the working directory to use for writing results. If not specified, a temporary working directory will be used.

Parameters:

workingDirectory - The working directory to write results to.

Returns:

This Builder.

setWorkingDirectory

public ParallelizableJobRunner.Builder setWorkingDirectory(String workingDirectory)

Sets the working directory to use for writing results. If not specified, a temporary working directory will be used.

Parameters:

workingDirectory - The working directory to write results to.

Returns:

This Builder.

setExecutor

public ParallelizableJobRunner.Builder setExecutor(Executor executor)

Sets the executor to use to run the threads for processing individual tasks. If not set, a new fixed thread pool having maxConcurrentWorkers threads will be created.

Parameters:

executor - The Executor to use to run worker threads.

Returns:

This Builder.

setMaxConcurrentWorkers

public ParallelizableJobRunner.Builder setMaxConcurrentWorkers(int maxConcurrentWorkers)

Sets the maximum number of concurrent tasks to run. If not specified, this will be set to Runtime.getRuntime().availableProcessors().

Parameters:

maxConcurrentWorkers - The maximum number of concurrent workers.

Returns:

This Builder.

See Also:

Runtime.availableProcessors()

setProgressMonitorFactory

public ParallelizableJobRunner.Builder setProgressMonitorFactory(ca.eandb.util.progress.ProgressMonitorFactory progressMonitorFactory)

Sets the ProgressMonitorFactory to use to create ProgressMonitors for individual tasks. If not specified, a DummyProgressMonitorFactory will be used.

Parameters:

progressMonitorFactory - The ProgressMonitorFactory to use to create ProgressMonitors for individual tasks.

Returns:

This Builder.

See Also:

DummyProgressMonitorFactory

setProgressMonitor

public ParallelizableJobRunner.Builder setProgressMonitor(ca.eandb.util.progress.ProgressMonitor progressMonitor)

Sets the ProgressMonitor to use to report overall progress to. If not specified, a DummyProgressMonitor will be used.

Parameters:

progressMonitor - The ProgressMonitor to report overall progress to.

Returns:

This Builder.

See Also:

DummyProgressMonitor