ch.systemsx.cisd.hdf5

Interface IHDF5BooleanReader

All Known Subinterfaces:

IHDF5BooleanWriter

All Known Implementing Classes:

HDF5BooleanReader, HDF5BooleanWriter

public interface IHDF5BooleanReader

An interface that provides methods for reading boolean and bit field values from HDF5 files.

Obtain an object implementing this interface by calling IHDF5Reader.bool().

Method Summary

Modifier and Type	Method and Description
boolean	getAttr(java.lang.String objectPath, java.lang.String attributeName) Reads a boolean attribute named attributeName from the data set objectPath.
boolean	isBitSet(java.lang.String objectPath, int bitIndex) Returns true if the bitIndex of the bit field dataset objectPath is set, false otherwise.
boolean	read(java.lang.String objectPath) Reads a Boolean value from the data set objectPath.
java.util.BitSet	readBitField(java.lang.String objectPath) Reads a bit field (which can be considered the equivalent to a boolean array of rank 1) from the data set objectPath and returns it as a Java BitSet.
java.util.BitSet[]	readBitFieldArray(java.lang.String objectPath) Reads a bit field array (which can be considered the equivalent to a boolean array of rank 2) from the data set objectPath and returns it as a Java BitSet.
java.util.BitSet[]	readBitFieldArrayBlock(java.lang.String objectPath, int blockSize, long blockNumber) Reads a block of a bit field array (which can be considered the equivalent to a boolean array of rank 2) from the data set objectPath and returns it as a Java BitSet.
java.util.BitSet[]	readBitFieldArrayBlockWithOffset(java.lang.String objectPath, int blockSize, long offset) Reads a block of a bit field array (which can be considered the equivalent to a boolean array of rank 2) from the data set objectPath and returns it as a Java BitSet.
java.util.BitSet	readBitFieldBlock(java.lang.String objectPath, int blockSize, long blockNumber) Reads a block of a bit field (which can be considered the equivalent to a boolean array of rank 1) from the data set objectPath and returns it as a Java BitSet.
java.util.BitSet	readBitFieldBlockWithOffset(java.lang.String objectPath, int blockSize, long offset) Reads a block of a bit field (which can be considered the equivalent to a boolean array of rank 1) from the data set objectPath and returns it as a Java BitSet.

Method Detail

getAttr

boolean getAttr(java.lang.String objectPath,
                java.lang.String attributeName)
         throws HDF5JavaException

Reads a boolean attribute named attributeName from the data set objectPath.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

attributeName - The name of the attribute to read.

Returns:

The attribute value read from the data set.

Throws:

HDF5JavaException - If the attribute is not a boolean type.

read

boolean read(java.lang.String objectPath)
      throws HDF5JavaException

Reads a Boolean value from the data set objectPath.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a boolean type.

readBitField

java.util.BitSet readBitField(java.lang.String objectPath)
                       throws HDF5DatatypeInterfaceException

Reads a bit field (which can be considered the equivalent to a boolean array of rank 1) from the data set objectPath and returns it as a Java BitSet.

Note that the storage form of the bit array is a long[]. However, it is marked in HDF5 to be interpreted bit-wise. Thus a data set written by IHDF5LongWriter.writeArray(String, long[]) cannot be read back by this method but will throw a HDF5DatatypeInterfaceException.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

Returns:

The BitSet read from the data set.

Throws:

HDF5DatatypeInterfaceException - If the objectPath is not of bit field type.

readBitFieldBlock

java.util.BitSet readBitFieldBlock(java.lang.String objectPath,
                                   int blockSize,
                                   long blockNumber)

Reads a block of a bit field (which can be considered the equivalent to a boolean array of rank 1) from the data set objectPath and returns it as a Java BitSet.

Note that the storage form of the bit array is a long[]. However, it is marked in HDF5 to be interpreted bit-wise. Thus a data set written by IHDF5LongWriter.writeArray(String, long[]) cannot be read back by this method but will throw a HDF5DatatypeInterfaceException.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

blockSize - The size of the block (in 64 bit words) to read.

blockNumber - The number of the block to read.

Returns:

The BitSet read from the data set.

Throws:

HDF5DatatypeInterfaceException - If the objectPath is not of bit field type.

readBitFieldBlockWithOffset

java.util.BitSet readBitFieldBlockWithOffset(java.lang.String objectPath,
                                             int blockSize,
                                             long offset)

Reads a block of a bit field (which can be considered the equivalent to a boolean array of rank 1) from the data set objectPath and returns it as a Java BitSet.

Note that the storage form of the bit array is a long[]. However, it is marked in HDF5 to be interpreted bit-wise. Thus a data set written by IHDF5LongWriter.writeArray(String, long[]) cannot be read back by this method but will throw a HDF5DatatypeInterfaceException.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

blockSize - The size of the block (in 64 bit words) to read.

offset - The offset of the block (in 64 bit words) to start reading from.

Returns:

The BitSet read from the data set.

Throws:

HDF5DatatypeInterfaceException - If the objectPath is not of bit field type.

isBitSet

boolean isBitSet(java.lang.String objectPath,
                 int bitIndex)

Returns true if the bitIndex of the bit field dataset objectPath is set, false otherwise.

Will also return false, if bitIndex is outside of the bitfield dataset.

readBitFieldArray

java.util.BitSet[] readBitFieldArray(java.lang.String objectPath)

Reads a bit field array (which can be considered the equivalent to a boolean array of rank 2) from the data set objectPath and returns it as a Java BitSet.

Note that the storage form of the bit array is a long[]. However, it is marked in HDF5 to be interpreted bit-wise. Thus a data set written by IHDF5LongWriter.writeMatrix(String, long[][]) cannot be read back by this method but will throw a HDF5DatatypeInterfaceException.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

Returns:

The BitSet array read from the data set.

Throws:

HDF5DatatypeInterfaceException - If the objectPath is not of bit field type.

readBitFieldArrayBlockWithOffset

java.util.BitSet[] readBitFieldArrayBlockWithOffset(java.lang.String objectPath,
                                                    int blockSize,
                                                    long offset)

Reads a block of a bit field array (which can be considered the equivalent to a boolean array of rank 2) from the data set objectPath and returns it as a Java BitSet.

Note that the storage form of the bit array is a long[]. However, it is marked in HDF5 to be interpreted bit-wise. Thus a data set written by IHDF5LongWriter.writeMatrix(String, long[][]) cannot be read back by this method but will throw a HDF5DatatypeInterfaceException.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

blockSize - The size of the array block.

offset - The offset in the array where to start reading the block.

Returns:

The BitSet array read from the data set.

Throws:

HDF5DatatypeInterfaceException - If the objectPath is not of bit field type.

readBitFieldArrayBlock

java.util.BitSet[] readBitFieldArrayBlock(java.lang.String objectPath,
                                          int blockSize,
                                          long blockNumber)

Reads a block of a bit field array (which can be considered the equivalent to a boolean array of rank 2) from the data set objectPath and returns it as a Java BitSet.

Note that the storage form of the bit array is a long[]. However, it is marked in HDF5 to be interpreted bit-wise. Thus a data set written by IHDF5LongWriter.writeMatrix(String, long[][]) cannot be read back by this method but will throw a HDF5DatatypeInterfaceException.

Parameters:

objectPath - The name (including path information) of the data set object in the file.

blockSize - The size of the array block.

blockNumber - The number of the array block (offset is blockNumber * blockSize.).

Returns:

The BitSet array read from the data set.

Throws:

HDF5DatatypeInterfaceException - If the objectPath is not of bit field type.