ch.systemsx.cisd.hdf5

Class HDF5BooleanReader

java.lang.Object

ch.systemsx.cisd.hdf5.HDF5BooleanReader

All Implemented Interfaces:

IHDF5BooleanReader

Direct Known Subclasses:

HDF5BooleanWriter

public class HDF5BooleanReader
extends java.lang.Object
implements IHDF5BooleanReader

Implementation of IHDF5BooleanReader.

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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAttr

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

Description copied from interface: IHDF5BooleanReader

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

Specified by:

getAttr in interface IHDF5BooleanReader

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

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

Description copied from interface: IHDF5BooleanReader

Reads a Boolean value from the data set objectPath.

Specified by:

read in interface IHDF5BooleanReader

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

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

Description copied from interface: IHDF5BooleanReader

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.

Specified by:

readBitField in interface IHDF5BooleanReader

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

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

Description copied from interface: IHDF5BooleanReader

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.

Specified by:

readBitFieldBlock in interface IHDF5BooleanReader

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.

readBitFieldBlockWithOffset

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

Description copied from interface: IHDF5BooleanReader

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.

Specified by:

readBitFieldBlockWithOffset in interface IHDF5BooleanReader

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.

isBitSet

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

Description copied from interface: IHDF5BooleanReader

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.

Specified by:

isBitSet in interface IHDF5BooleanReader

readBitFieldArray

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

Description copied from interface: IHDF5BooleanReader

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.

Specified by:

readBitFieldArray in interface IHDF5BooleanReader

Parameters:

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

Returns:

The BitSet array read from the data set.

readBitFieldArrayBlockWithOffset

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

Description copied from interface: IHDF5BooleanReader

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.

Specified by:

readBitFieldArrayBlockWithOffset in interface IHDF5BooleanReader

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.

readBitFieldArrayBlock

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

Description copied from interface: IHDF5BooleanReader

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.

Specified by:

readBitFieldArrayBlock in interface IHDF5BooleanReader

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.