Package org.vast.process

Class DataQueue

java.lang.Object

org.vast.process.DataConnection

org.vast.process.DataQueue

All Implemented Interfaces:

IDataConnection

public class DataQueue
extends DataConnection

A data queue is used to send data between processes. It is synchronized to support processes in different threads, even on different computers (grid computing). Each element in the queue is called a data block. The queue can also send status values and events.

Nested Class Summary

Nested classes/interfaces inherited from class org.vast.process.DataConnection

DataConnection.ComponentConverter

Field Summary

Fields

Modifier and Type	Field	Description
protected BlockingQueue<DataBlock>	queue

Fields inherited from class org.vast.process.DataConnection

componentConverters, dataAvailable, destinationChoice, destinationChoiceIdx, destinationComponent, destinationProcess, properties, sourceComponent, sourceProcess

Constructor Summary

Constructors

Constructor	Description
DataQueue()

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear all remaining data on this connection
int	getQueueSize()
boolean	isDataAvailable()
void	publishData()	Publish data from source component on this connection
boolean	transferData(boolean block)	Transfer data to destination component

Methods inherited from class org.vast.process.DataConnection

getDestinationComponent, getDestinationPort, getDestinationProcess, getProperty, getSourceComponent, getSourcePort, getSourceProcess, getUnitConverter, setDestination, setProperty, setSource, setupUnitConverters, validate, validateArray, validateScalar

Methods inherited from class java.lang.Object

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

Field Details

queue

protected BlockingQueue<DataBlock> queue

Constructor Details

DataQueue

public DataQueue()

Method Details

publishData

public void publishData()
                 throws InterruptedException

Description copied from interface: IDataConnection

Publish data from source component on this connection

Specified by:

publishData in interface IDataConnection

Overrides:

publishData in class DataConnection

Throws:

InterruptedException - if interrupted while waiting

transferData

public boolean transferData(boolean block)
                     throws InterruptedException

Description copied from interface: IDataConnection

Transfer data to destination component

Specified by:

transferData in interface IDataConnection

Overrides:

transferData in class DataConnection

Parameters:

block - Set to true if processing should wait until data is available on this connection, false if processing should continue without it

Returns:

True if data was actually transferred, false otherwise

Throws:

InterruptedException - if interrupted while waiting

clear

public void clear()

Description copied from interface: IDataConnection

Clear all remaining data on this connection

Specified by:

clear in interface IDataConnection

Overrides:

clear in class DataConnection

isDataAvailable

public boolean isDataAvailable()

Specified by:

isDataAvailable in interface IDataConnection

Overrides:

isDataAvailable in class DataConnection

Returns:

true if data is available (i.e. ready to be transfered) on this connection

getQueueSize

public int getQueueSize()