org.freehep.record.loop

Class ConcurrentRecordLoop

java.lang.Object

org.freehep.record.loop.DefaultRecordLoop

org.freehep.record.loop.ConcurrentRecordLoop

All Implemented Interfaces:

RecordLoop

public class ConcurrentRecordLoop
extends DefaultRecordLoop

Implementation of RecordLoop capable of processing records in multiple threads. If this loop is constructed with isInteractive flag set to true, all LoopEvents (but not RecordEvents) will be dispatched in the AWT event processing thread, and the looping code (including fetching records from the record source) will be run by loopExecutor. If the number of record processing threads is higher than zero, a thread pool with the specified maximum number of threads will be used to supply RecordEvents to listeners while executing GO and GO_N commands.

Version:

$Id$

Author:

onoprien

Nested Class Summary

Nested classes/interfaces inherited from interface org.freehep.record.loop.RecordLoop

RecordLoop.Command, RecordLoop.Event, RecordLoop.State

Constructor Summary

Constructors

Constructor and Description
ConcurrentRecordLoop(boolean isInteractive, int nThreads) Constructs ConcurrentRecordLoop with default looping code executor and thread factory.
ConcurrentRecordLoop(boolean isInteractive, int nThreads, Executor loopExecutor, ThreadFactory threadFactory) Constructs ConcurrentRecordLoop.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	doNotCount(Object record) If the specified record is being currently supplied to listeners, tells this loop not to count it towards the number of records that will be reported by getTotalCountableSupplied().
void	setNumberOfThreads(int nThreads) Sets the number of worker threads used by this record loop.

Methods inherited from class org.freehep.record.loop.DefaultRecordLoop

addLoopListener, addRecordListener, dispose, execute, getConsumed, getCountableConsumed, getLastRecord, getLoopListeners, getProgress, getRecordListeners, getRecordSource, getState, getSupplied, getTotalConsumed, getTotalCountableConsumed, getTotalSupplied, isEnabled, isInterruptRequested, removeLoopListener, removeRecordListener, setConfiguration, setProgressByRecords, setProgressByTime, setRecordSource, setStopOnEOF, setStopOnRewind

Methods inherited from class java.lang.Object

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

Constructor Detail

ConcurrentRecordLoop

public ConcurrentRecordLoop(boolean isInteractive,
                    int nThreads,
                    Executor loopExecutor,
                    ThreadFactory threadFactory)

Constructs ConcurrentRecordLoop.

Parameters:

isInteractive - Interactivity flag - typically set to true in GUI-driven applications.

nThreads - Number of worker threads for record processing.

loopExecutor - Executor for running looping code in GUI-driven applications. Not used unless the interactivity flag is set to true.

threadFactory - Factory for creating worker threads that will be running RecordListener code.

ConcurrentRecordLoop

public ConcurrentRecordLoop(boolean isInteractive,
                    int nThreads)

Constructs ConcurrentRecordLoop with default looping code executor and thread factory.

Method Detail

setNumberOfThreads

public void setNumberOfThreads(int nThreads)

Sets the number of worker threads used by this record loop.

Throws:

IllegalStateException - if this loop is in LOOPING state.

doNotCount

public boolean doNotCount(Object record)

Description copied from class: DefaultRecordLoop

If the specified record is being currently supplied to listeners, tells this loop not to count it towards the number of records that will be reported by getTotalCountableSupplied().

Specified by:

doNotCount in interface RecordLoop

Overrides:

doNotCount in class DefaultRecordLoop

Returns:

true if was marked for exclusion from counting as a result of this call.