org.semanticweb.elk.util.concurrent.computation

Class ConcurrentComputation<F extends ProcessorFactory<?>>

java.lang.Object

org.semanticweb.elk.util.concurrent.computation.ConcurrentComputation<F>

Type Parameters:

F - the type of the factory for the input processors

All Implemented Interfaces:

InterruptMonitor

Direct Known Subclasses:

ConcurrentComputationWithInputs

public class ConcurrentComputation<F extends ProcessorFactory<?>>
extends Object
implements InterruptMonitor

A class for concurrent processing using the supplied ProcessorFactory . Processing is performed concurrently by several workers, each using a Processor created by the ProcessorFactory. Processing starts by calling start(), which creates a specified number of working threads and starts concurrent processing. All workers can be interrupted by interrupting the InterruptMonitor passed to this computation and the ProcessorFactory. When finish() is called, the current thread blocks until everything is processed by the workers or all workers have been interrupted.

Author:

"Yevgeny Kazakov", Peter Skocovsky

Field Summary

Fields

Modifier and Type	Field and Description
protected ConcurrentExecutor	executor the executor used internally to run the jobs
protected JobMonitor	jobMonitor the object to monitor progress of the job
protected int	maxWorkers maximum number of concurrent workers
protected F	processorFactory the factory for the input processor engines
protected boolean	termination true the workers should stop either as soon as possible (if the computation has been terminated) or after finish() is called
protected Runnable	worker the worker instance used to process the jobs

Constructor Summary

Constructors

Constructor and Description
ConcurrentComputation(F processorFactory, ConcurrentExecutor executor, int maxWorkers) Creating a ConcurrentComputation instance.

Method Summary

Modifier and Type	Method and Description
void	finish() Requests all workers to terminate when processing is finished.
boolean	isInterrupted()
boolean	start() Starts the workers to process the input.
protected void	waitWorkers()

Methods inherited from class java.lang.Object

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

Field Detail

processorFactory

protected final F extends ProcessorFactory<?> processorFactory

the factory for the input processor engines

maxWorkers

protected final int maxWorkers

maximum number of concurrent workers

executor

protected final ConcurrentExecutor executor

the executor used internally to run the jobs

termination

protected volatile boolean termination

true the workers should stop either as soon as possible (if the computation has been terminated) or after finish() is called

worker

protected final Runnable worker

the worker instance used to process the jobs

jobMonitor

protected JobMonitor jobMonitor

the object to monitor progress of the job

Constructor Detail

ConcurrentComputation

public ConcurrentComputation(F processorFactory,
                             ConcurrentExecutor executor,
                             int maxWorkers)

Creating a ConcurrentComputation instance.

Parameters:

processorFactory - the factory for input processors

executor - the executor used internally to run the jobs

maxWorkers - the maximal number of concurrent workers processing the jobs

Method Detail

start

public boolean start()

Starts the workers to process the input.

Returns:

true if the operation was successful

waitWorkers

protected void waitWorkers()
                    throws InterruptedException

Throws:

InterruptedException

finish

public void finish()
            throws InterruptedException

Requests all workers to terminate when processing is finished. The method blocks until all workers have been stopped. If interrupted while blocked, this method can be called again in order to complete the termination request.

Throws:

InterruptedException - if interrupted during waiting for finish request

isInterrupted

public boolean isInterrupted()

Specified by:

isInterrupted in interface InterruptMonitor

Returns:

true after this monitor was notified about interruption, false if it was not.