org.semanticweb.elk.util.concurrent.computation

Class ConcurrentComputationWithInputs<I,F extends InputProcessorFactory<I,?>>

java.lang.Object

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

org.semanticweb.elk.util.concurrent.computation.ConcurrentComputationWithInputs<I,F>

Type Parameters:

I - the type of the input to be processed.

F - the type of the factory for the input processors

All Implemented Interfaces:

InterruptMonitor

public class ConcurrentComputationWithInputs<I,F extends InputProcessorFactory<I,?>>
extends ConcurrentComputation<F>

An class for concurrent processing of a number of tasks. The input for the tasks are submitted, buffered, and processed by concurrent workers using the the InputProcessor objects created by the supplied InputProcessorFactory. The implementation is loosely based on a producer-consumer framework with one producer and many consumers. The processing of the input should start by calling the ConcurrentComputation.start() method, following by submit(Object) method for submitting input to be processed. The workers will always wait for new input, unless interrupted or ConcurrentComputation.finish() method is called. If ConcurrentComputation.finish() is called then no further input can be submitted and the workers will terminate when all input has been processed or they are interrupted earlier, whichever is earlier.

Author:

"Yevgeny Kazakov"

Field Summary

Fields inherited from class org.semanticweb.elk.util.concurrent.computation.ConcurrentComputation

executor, jobMonitor, maxWorkers, processorFactory, termination, worker

Constructor Summary

Constructors

Constructor and Description
ConcurrentComputationWithInputs(F inputProcessorFactory, ConcurrentExecutor executor, int maxWorkers) Creating a ConcurrentComputationWithInputs instance.
ConcurrentComputationWithInputs(F inputProcessorFactory, ConcurrentExecutor executor, int maxWorkers, int bufferCapacity) Creating a ConcurrentComputationWithInputs instance.

Method Summary

Modifier and Type	Method and Description
boolean	submit(I input) Submitting a new input for processing.
protected void	waitWorkers()

Methods inherited from class org.semanticweb.elk.util.concurrent.computation.ConcurrentComputation

finish, isInterrupted, start

Methods inherited from class java.lang.Object

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

Constructor Detail

ConcurrentComputationWithInputs

public ConcurrentComputationWithInputs(F inputProcessorFactory,
                                       ConcurrentExecutor executor,
                                       int maxWorkers,
                                       int bufferCapacity)

Creating a ConcurrentComputationWithInputs instance.

Parameters:

inputProcessorFactory - the factory for input processors

executor - the executor used internally to run the jobs

maxWorkers - the maximal number of concurrent workers processing the jobs

bufferCapacity - the size of the buffer for scheduled jobs; if the buffer is full, submitting new jobs will block until new space is available

ConcurrentComputationWithInputs

public ConcurrentComputationWithInputs(F inputProcessorFactory,
                                       ConcurrentExecutor executor,
                                       int maxWorkers)

Creating a ConcurrentComputationWithInputs instance.

Parameters:

inputProcessorFactory - 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

submit

public boolean submit(I input)
               throws InterruptedException

Submitting a new input for processing. Submitted input jobs are first buffered, and then concurrently processed by workers. If the buffer is full, the method blocks until new space is available.

Parameters:

input - the input to be processed

Returns:

true if the input has been successfully submitted for computation; the input cannot be submitted, e.g., if ConcurrentComputation.finish() has been called

Throws:

InterruptedException - thrown if interrupted during waiting for space to be available

waitWorkers

protected void waitWorkers()
                    throws InterruptedException

Overrides:

waitWorkers in class ConcurrentComputation<F extends InputProcessorFactory<I,?>>

Throws:

InterruptedException