Package org.vast.process

Class DataConnection

java.lang.Object

org.vast.process.DataConnection

All Implemented Interfaces:

IDataConnection

Direct Known Subclasses:

DataQueue

public class DataConnection
extends Object
implements IDataConnection

Implementation of data connection for the processing engine.
This class is capable of automatically converting units if source and target are not in the same unit (units have to be physically compatible)
This class is used when running all processes of a processing chain synchronously in a single thread

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	DataConnection.ComponentConverter

Field Summary

Fields

Modifier and Type	Field	Description
protected List<DataConnection.ComponentConverter>	componentConverters
protected boolean	dataAvailable
protected DataChoice	destinationChoice
protected int	destinationChoiceIdx
protected DataComponent	destinationComponent
protected IProcessExec	destinationProcess
protected HashMap<String,Object>	properties
protected DataComponent	sourceComponent
protected IProcessExec	sourceProcess

Constructor Summary

Constructors

Constructor	Description
DataConnection()

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear all remaining data on this connection
DataComponent	getDestinationComponent()
DataComponent	getDestinationPort()
IProcessExec	getDestinationProcess()
Object	getProperty(String propName)
DataComponent	getSourceComponent()
DataComponent	getSourcePort()
IProcessExec	getSourceProcess()
protected UnitConverter	getUnitConverter(DataComponent src, DataComponent dest)
boolean	isDataAvailable()
void	publishData()	Publish data from source component on this connection
void	setDestination(IProcessExec process, DataComponent component)
void	setProperty(String propName, Object propValue)
void	setSource(IProcessExec process, DataComponent component)
protected void	setupUnitConverters()
boolean	transferData(boolean block)	Transfer data to destination component
static String	validate(DataComponent src, DataComponent dest)	Checks that source and destination components can be connected.
protected static void	validateArray(DataArray srcComp, DataArray destComp, StringBuilder msg)
protected static void	validateScalar(DataComponent srcComp, DataComponent destComp, StringBuilder msg)

Methods inherited from class java.lang.Object

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

Field Details

sourceProcess

protected IProcessExec sourceProcess

destinationProcess

protected IProcessExec destinationProcess

sourceComponent

protected DataComponent sourceComponent

destinationComponent

protected DataComponent destinationComponent

destinationChoice

protected DataChoice destinationChoice

destinationChoiceIdx

protected int destinationChoiceIdx

dataAvailable

protected boolean dataAvailable

componentConverters

protected List<DataConnection.ComponentConverter> componentConverters

properties

protected HashMap<String,Object> properties

Constructor Details

DataConnection

public DataConnection()

Method Details

setupUnitConverters

protected void setupUnitConverters()

getUnitConverter

protected UnitConverter getUnitConverter(DataComponent src,
 DataComponent dest)

validate

public static String validate(DataComponent src,
 DataComponent dest)
                       throws ProcessException

Checks that source and destination components can be connected. This validates compatibility of units and structure of aggregates.

Parameters:

src -

dest -

Returns:

Warning message or null if no warning

Throws:

ProcessException

validateArray

protected static void validateArray(DataArray srcComp,
 DataArray destComp,
 StringBuilder msg)
                             throws ProcessException

Throws:

ProcessException

validateScalar

protected static void validateScalar(DataComponent srcComp,
 DataComponent destComp,
 StringBuilder msg)
                              throws ProcessException

Throws:

ProcessException

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

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

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

setSource

public void setSource(IProcessExec process,
 DataComponent component)

Specified by:

setSource in interface IDataConnection

getSourceProcess

public IProcessExec getSourceProcess()

Specified by:

getSourceProcess in interface IDataConnection

getSourcePort

public DataComponent getSourcePort()

Specified by:

getSourcePort in interface IDataConnection

getSourceComponent

public DataComponent getSourceComponent()

Specified by:

getSourceComponent in interface IDataConnection

setDestination

public void setDestination(IProcessExec process,
 DataComponent component)

Specified by:

setDestination in interface IDataConnection

getDestinationProcess

public IProcessExec getDestinationProcess()

Specified by:

getDestinationProcess in interface IDataConnection

getDestinationPort

public DataComponent getDestinationPort()

Specified by:

getDestinationPort in interface IDataConnection

getDestinationComponent

public DataComponent getDestinationComponent()

Specified by:

getDestinationComponent in interface IDataConnection

isDataAvailable

public boolean isDataAvailable()

Specified by:

isDataAvailable in interface IDataConnection

Returns:

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

clear

public void clear()

Description copied from interface: IDataConnection

Clear all remaining data on this connection

Specified by:

clear in interface IDataConnection

getProperty

public Object getProperty(String propName)

setProperty

public void setProperty(String propName,
 Object propValue)