Package etomica.data

Class DataProcessor

java.lang.Object

etomica.data.DataProcessor

All Implemented Interfaces:

DataPipe, IDataSink

Direct Known Subclasses:

BoltzmannProcessor, CastGroupOfTablesToDataTable, CastGroupToDoubleArray, CastToDouble, CastToDoubleArray, CastToGroup, CastToTable, DataGroupFilter, DataLogger, DataProcessorBias, DataProcessorBoltzmannFactor, DataProcessorBounds, DataProcessorCavity, DataProcessorChemicalPotential, DataProcessorCvMD, DataProcessorDyDLnx, DataProcessorErrorBar, DataProcessorForked, DataProcessorFunction, DataProcessorInterfacialTension, DataProcessorInterfacialTensionProfile, DataProcessorMu, DataProcessorReweight, DataProcessorReweightRatio, DataProcessorSum, DataProcessorSurfaceTension, DataProcessorVar, DataProcessorVirialOverlap, DataProcessorXY, DataPump, DropletGraphic.DataProcessorTensorSplitter, FitTanh, FitTanh, GlassGraphic.DataProcessorTensorTrace, InterfacialSWGraphic.DataProcessorTensorSplitter, LjMd3D.DataProcessorCorrection, LjMd3D.DataProcessorReweight, LjmdGraphic.DataProcessorTensorTrace, MolecularWeightAvg, MolecularWeightAvg2, MuGraphic.DataProcessorMu, MuGraphic.DataSinkExcludeOverlap, MultiharmonicGraphicMC.DataProcessAHT, NucleationGraphic.DataSinkExcludeOverlap, ReverseOsmosisGraphic.DataSinkExcludeOverlap, ReverseOsmosisWaterGraphic.DataSinkExcludeOverlap, SamGraphic.DataPipeStressStrain, StatisticsMCGraphic.DataProcessorUndo, SurfaceTensionMapped, SwmdGraphic.DataSinkExcludeOverlap, VirialPolyhedra.DataProcessorR2, VirialPolyhedra2.DataProcessorR2

public abstract class DataProcessor
extends java.lang.Object
implements DataPipe

An object that receives Data, processes it, and pushes the result on to a DataSink.

Field Summary

Fields

Modifier and Type	Field	Description
protected IDataInfo	dataInfo
protected IDataSink	dataSink
protected DataTag	tag

Constructor Summary

Constructors

Constructor	Description
DataProcessor()

Method Summary

Modifier and Type	Method	Description
IDataInfo	getDataInfo()
IDataSink	getDataSink()
DataTag	getTag()
protected abstract IData	processData(IData inputData)	Processes the input Data and returns Data for pushing to the next DataSink.
protected abstract IDataInfo	processDataInfo(IDataInfo inputDataInfo)	Informs this DataProcessor of the DataInfo for the Data it will be processing.
void	putData(IData data)	Processes input Data and pushes it downstream if output Data and DataSink are not null.
void	putDataInfo(IDataInfo inputDataInfo)	Invokes processDataInfo on the given DataInfo, and passes the returned DataInfo to the dataSink (if not null).
void	setDataSink(IDataSink newDataSink)	Sets the sink receiving the data.

Methods inherited from class java.lang.Object

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

Field Detail

tag

protected final DataTag tag

dataSink

protected IDataSink dataSink

dataInfo

protected IDataInfo dataInfo

Constructor Detail

DataProcessor

public DataProcessor()

Method Detail

getTag

public DataTag getTag()

Specified by:

getTag in interface DataPipe

processData

protected abstract IData processData(IData inputData)

Processes the input Data and returns Data for pushing to the next DataSink. Returns null if output Data should not (yet) be pushed downstream.

Parameters:

inputData - the Data for processing

Returns:

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

processDataInfo

protected abstract IDataInfo processDataInfo(IDataInfo inputDataInfo)

Informs this DataProcessor of the DataInfo for the Data it will be processing. Typically the subclass will use this information to make any objects or otherwise prepare for calls to processData.

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

putData

public void putData(IData data)

Processes input Data and pushes it downstream if output Data and DataSink are not null.

Specified by:

putData in interface IDataSink

putDataInfo

public void putDataInfo(IDataInfo inputDataInfo)

Invokes processDataInfo on the given DataInfo, and passes the returned DataInfo to the dataSink (if not null). Will insert a data caster before the DataSink if appropriate.

Specified by:

putDataInfo in interface IDataSink

getDataInfo

public IDataInfo getDataInfo()

getDataSink

public IDataSink getDataSink()

Returns:

Returns the data sink, which may be null.

setDataSink

public void setDataSink(IDataSink newDataSink)

Sets the sink receiving the data. Null value is permitted.

Specified by:

setDataSink in interface DataPipe

Parameters:

newDataSink - The data sink to set.