ch.systemsx.cisd.hdf5

Class HDF5DataSetInformation

java.lang.Object

ch.systemsx.cisd.hdf5.HDF5DataSetInformation

public final class HDF5DataSetInformation
extends java.lang.Object

A class that holds relevant information about a data set.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
long[]	getDimensions() Returns the array dimensions of the data set.
long[]	getMaxDimensions() Returns the largest possible array dimensions of the data set.
long	getNumberOfElements() Returns the total number of elements of this data set.
int	getRank() Returns the rank (number of axis) of this data set.
long	getSize() Returns the total size (in bytes) of this data set.
HDF5StorageLayout	getStorageLayout() Returns the storage layout of the data set in the HDF5 file.
HDF5DataTypeInformation	getTypeInformation() Returns the data type information for the data set.
int	hashCode()
boolean	isScalar() Returns true, if the rank of this data set is 0.
boolean	isSigned() Returns true, if this data set type has a sign anf false otherwise.
boolean	isTimeDuration() Returns true, if the data set is a time duration, or false otherwise.
boolean	isTimeStamp() Returns true, if the data set is a time stamp, or false otherwise.
java.lang.String	toString()
int[]	tryGetChunkSizes() Returns the chunk size in each array dimension of the data set, or null, if the data set is not of HDF5StorageLayout.CHUNKED.
HDF5TimeUnit	tryGetTimeUnit() Returns the time unit of the data set, if the data set is a time duration, or null otherwise.
HDF5DataTypeVariant	tryGetTypeVariant() Returns the data type variant of this data set, or null, if this data set is not tagged with a type variant.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getTypeInformation

public HDF5DataTypeInformation getTypeInformation()

Returns the data type information for the data set.

tryGetTypeVariant

public HDF5DataTypeVariant tryGetTypeVariant()

Returns the data type variant of this data set, or null, if this data set is not tagged with a type variant.

isTimeStamp

public boolean isTimeStamp()

Returns true, if the data set is a time stamp, or false otherwise.

isTimeDuration

public boolean isTimeDuration()

Returns true, if the data set is a time duration, or false otherwise.

tryGetTimeUnit

public HDF5TimeUnit tryGetTimeUnit()

Returns the time unit of the data set, if the data set is a time duration, or null otherwise.

getDimensions

public long[] getDimensions()

Returns the array dimensions of the data set.

getMaxDimensions

public long[] getMaxDimensions()

Returns the largest possible array dimensions of the data set.

getStorageLayout

public HDF5StorageLayout getStorageLayout()

Returns the storage layout of the data set in the HDF5 file.

tryGetChunkSizes

public int[] tryGetChunkSizes()

Returns the chunk size in each array dimension of the data set, or null, if the data set is not of HDF5StorageLayout.CHUNKED.

getRank

public int getRank()

Returns the rank (number of axis) of this data set.

isScalar

public boolean isScalar()

Returns true, if the rank of this data set is 0.

isSigned

public boolean isSigned()

Returns true, if this data set type has a sign anf false otherwise.

getNumberOfElements

public long getNumberOfElements()

Returns the total number of elements of this data set.

getSize

public long getSize()

Returns the total size (in bytes) of this data set.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object