Package etomica.data

Class DataPump

java.lang.Object

etomica.data.DataProcessor

etomica.data.DataPump

All Implemented Interfaces:

IAction, DataPipe, IDataSink

Direct Known Subclasses:

DataPumpListener, DataPumpListenerPow, DataPumpListenerPowStrict

public class DataPump
extends DataProcessor
implements IAction

A DataProcessor whose action is to actively take Data from a DataSource and send it to DataSinks.

Field Summary

Fields

Modifier and Type	Field	Description
protected IDataSource	dataSource
protected IDataInfo	dataSourceInfo

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag

Constructor Summary

Constructors

Constructor	Description
DataPump(IDataSource dataSource, IDataSink dataSink)	Constructs DataPump with the given DataSource and DataSink.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed()	Transmits the data from the source to the sink.
IDataSource	getDataSource()
IData	processData(IData inputData)	Returns the given Data.
IDataInfo	processDataInfo(IDataInfo inputDataInfo)	Returns the given DataInfo.

Methods inherited from class etomica.data.DataProcessor

getDataInfo, getDataSink, getTag, putData, putDataInfo, setDataSink

Methods inherited from class java.lang.Object

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

Field Detail

dataSourceInfo

protected IDataInfo dataSourceInfo

dataSource

protected final IDataSource dataSource

Constructor Detail

DataPump

public DataPump(IDataSource dataSource,
                IDataSink dataSink)

Constructs DataPump with the given DataSource and DataSink. Data source cannot be null. Data sink can be null and must be identified via setDataSink if DataPump is to have any effect.

Method Detail

actionPerformed

public void actionPerformed()

Transmits the data from the source to the sink. Before transmitting the Data, this method will first check that the DataInfo from the source is the same as it was last time this method was invoked. If it has changed, a call to putDataInfo in the sink will be invoked before passing along the Data.

Specified by:

actionPerformed in interface IAction

processData

public IData processData(IData inputData)

Returns the given Data.

Specified by:

processData in class DataProcessor

Parameters:

inputData - the Data for processing

Returns:

the processed Data, for sending downstream (if not null)

processDataInfo

public IDataInfo processDataInfo(IDataInfo inputDataInfo)

Returns the given DataInfo.

Specified by:

processDataInfo in class DataProcessor

Parameters:

inputDataInfo - the DataInfo of the Data that will be input to this DataProcessor

Returns:

the DataInfo of the Data that will be output by this DataProcessor

getDataSource

public IDataSource getDataSource()

Returns:

Returns the dataSource.