Package etomica.data

Class DataInfo

java.lang.Object

etomica.data.DataInfo

All Implemented Interfaces:

IDataInfo, java.io.Serializable

Direct Known Subclasses:

DataDouble.DataInfoDouble, DataDoubleArray.DataInfoDoubleArray, DataDoubleBDArray.DataInfoDoubleBDArray, DataGroup.DataInfoGroup, DataTensor.DataInfoTensor, DataVector.DataInfoVector

public abstract class DataInfo
extends java.lang.Object
implements java.io.Serializable, IDataInfo

Object associated with a Data instance and which provides descriptive information about the data encapsulated in it. Information is typically used when displaying or writing the data to file, or making new Data instances that can work with the one holding this DataInfo.

A DataInfo instance is completely immutable.

See Also:

IData, Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataInfo(java.lang.String label, Dimension dimension)	Constructs new instance with descriptive label and dimension.

Method Summary

Modifier and Type	Method	Description
void	addTag(DataTag newTag)	Adds the tag
void	addTags(DataTag[] newTags)	Convenience method to add all of the given tags.
void	clearTags()	Removes all tags.
Dimension	getDimension()
java.lang.String	getLabel()
DataTag[]	getTags()	Returns the array of tags held by this DataInfo instance.
java.lang.String	toString()	Returns "label (dimension)", where label and dimension are the values held by this instance.

Methods inherited from interface etomica.data.IDataInfo

getFactory, getLength, makeData

Methods inherited from class java.lang.Object

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

Constructor Detail

DataInfo

protected DataInfo(java.lang.String label,
                   Dimension dimension)

Constructs new instance with descriptive label and dimension.

Parameters:

label - descriptive label for the data

dimension - physical dimensions (e.g., length, force) of the data

Method Detail

getDimension

public Dimension getDimension()

Specified by:

getDimension in interface IDataInfo

Returns:

Returns the dimension given at construction.

getLabel

public java.lang.String getLabel()

Specified by:

getLabel in interface IDataInfo

Returns:

Returns the descriptive label of the data, as given in constructor or at last call to setLabel.

toString

public java.lang.String toString()

Returns "label (dimension)", where label and dimension are the values held by this instance.

Specified by:

toString in interface IDataInfo

Overrides:

toString in class java.lang.Object

addTag

public void addTag(DataTag newTag)

Adds the tag

Specified by:

addTag in interface IDataInfo

addTags

public void addTags(DataTag[] newTags)

Convenience method to add all of the given tags.

Specified by:

addTags in interface IDataInfo

clearTags

public void clearTags()

Removes all tags.

Specified by:

clearTags in interface IDataInfo

getTags

public DataTag[] getTags()

Returns the array of tags held by this DataInfo instance. The same instance of the array can be returned each time the method is called, so the array elements should not be modified.

Specified by:

getTags in interface IDataInfo