ch.systemsx.cisd.hdf5

Class HDF5DataSet

java.lang.Object

ch.systemsx.cisd.hdf5.HDF5DataSet

All Implemented Interfaces:

java.lang.AutoCloseable

public class HDF5DataSet
extends java.lang.Object
implements java.lang.AutoCloseable

An object to represent an HDF5 data set.

Close it after usage is finished as otherwise you will leak resources from the HDF5 library.

Open the object using the method IHDF5ObjectReadOnlyInfoProviderHandler.openDataSet(String) and use it in readers and writers instead of the data set path. As it caches HDF5 objects, it will speed up the access for repeated access to the same data set.

A typical pattern for using this class is:

    try (final HDF5DataSet ds = reader.object().openDataSet("/path/to/dataset"))
    {
        for (long bx = 0; bx < 8; ++bx)
        {
            final float[] dataRead =
                    reader.float32().readArrayBlock(ds, length, bx);
            ... work with dataRead ...
        }
    }
 

Assigning the HDF5DataSet object in a try() block is a recommened practice to ensure that the underlying HDF5 object is properly closed at the end.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	equals(java.lang.Object obj)
java.lang.String	getDataSetPath() Returns the path of this data set.
int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

getDataSetPath

public java.lang.String getDataSetPath()

Returns the path of this data set.

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object