Package etomica.data.types

Class CastToTable

java.lang.Object

etomica.data.DataProcessor

etomica.data.types.CastToTable

All Implemented Interfaces:

DataPipe, IDataSink, java.io.Serializable

public class CastToTable
extends DataProcessor
implements java.io.Serializable

A DataProcessor that converts a Data instance into a DataTable. Casting for various types of Data is performed as follows:

• DataDoubleArray. A one-dimensional array will be put into a single column, and a two-dimensional array will be arranged into a corresponding set of multiple columns; attempts to cast higher-dimensional arrays will results in an IllegalArgumentException.
• DataDouble. Casts to a 1-column, 1-row table.
• DataInteger. Casts to a 1-column, 1-row table.
• DataVector. Places vector values in a single column.
• DataTensor. Arranges elements into multiple columns, like a matrix.
• DataFunction. Handles only a 1-dimensional DataFunction. Casts to a table of two columns, containing the independent and dependent data, respectively.

Attempts to process a different type will result in an IllegalArgumentException when encountered in the processDataInfo method.

See Also:

Serialized Form

Field Summary

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag

Constructor Summary

Constructors

Constructor	Description
CastToTable()	Sole constructor.

Method Summary

Modifier and Type	Method	Description
protected IData	processData(IData data)	Copies input Data to a DataTable and returns it (the DataTable).
IDataInfo	processDataInfo(IDataInfo inputDataInfo)	Prepares processor to perform cast.

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

Constructor Detail

CastToTable

public CastToTable()

Sole constructor.

Method Detail

processDataInfo

public IDataInfo processDataInfo(IDataInfo inputDataInfo)

Prepares processor to perform cast. Given DataInfo is examined to see what data type will be given to processor.

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

Throws:

java.lang.IllegalArgumentException - if DataInfo is not one of the acceptable types, as described in general comments for this class

processData

protected IData processData(IData data)

Copies input Data to a DataTable and returns it (the DataTable).

Specified by:

processData in class DataProcessor

Parameters:

data - the Data for processing

Returns:

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

Throws:

java.lang.ClassCastException - if input Data is not of the type indicated by the most recent call to processDataInfo