ch.systemsx.cisd.hdf5

Interface IHDF5BooleanWriter

All Superinterfaces:

IHDF5BooleanReader

All Known Implementing Classes:

HDF5BooleanWriter

public interface IHDF5BooleanWriter
extends IHDF5BooleanReader

An interface that provides methods for writing boolean values to HDF5 files.

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

Method Summary

Modifier and Type	Method and Description
void	createBitField(java.lang.String objectPath, int size) Creates a bit field (of rank 1).
void	createBitField(java.lang.String objectPath, int size, HDF5GenericStorageFeatures features) Creates a bit field array (of rank 1).
void	createBitField(java.lang.String objectPath, long size, int blockSize) Creates a bit field (of rank 1).
void	createBitField(java.lang.String objectPath, long size, int blockSize, HDF5GenericStorageFeatures features) Creates a bit field (of rank 1).
void	createBitFieldArray(java.lang.String objectPath, int bitFieldSize, long arraySize) Creates an empty array of bit fields (of rank 1) (which can be considered the equivalent to a boolean array of rank 2).
void	createBitFieldArray(java.lang.String objectPath, int bitFieldSize, long arraySize, HDF5IntStorageFeatures features) Creates an empty array of bit fields (of rank 1) (which can be considered the equivalent to a boolean array of rank 2).
void	createBitFieldArray(java.lang.String objectPath, int bitFieldSize, long arraySize, long arrayBlockSize) Creates an array of bit fields (of rank 1) (which can be considered the equivalent to a boolean array of rank 2).
void	createBitFieldArray(java.lang.String objectPath, int bitFieldSize, long arraySize, long arrayBlockSize, HDF5IntStorageFeatures features) Creates an array of bit fields (of rank 1) (which can be considered the equivalent to a boolean array of rank 2).
void	setAttr(java.lang.String objectPath, java.lang.String name, boolean value) Sets a boolean attribute to the referenced object.
void	write(java.lang.String objectPath, boolean value) Writes out a boolean value.
void	writeBitField(java.lang.String objectPath, java.util.BitSet data) Writes out a bit field ((which can be considered the equivalent to a boolean array of rank 1), provided as a Java BitSet.
void	writeBitField(java.lang.String objectPath, java.util.BitSet data, HDF5GenericStorageFeatures features) Writes out a bit field ((which can be considered the equivalent to a boolean array of rank 1), provided as a Java BitSet.
void	writeBitFieldArray(java.lang.String objectPath, java.util.BitSet[] data) Writes out an array of bit fields (which can be considered the equivalent to a boolean array of rank 2), provided as a Java array of BitSets.
void	writeBitFieldArray(java.lang.String objectPath, java.util.BitSet[] data, HDF5IntStorageFeatures features) Writes out an array of bit fields (which can be considered the equivalent to a boolean array of rank 2), provided as a Java array of BitSets.
void	writeBitFieldArrayBlock(java.lang.String objectPath, java.util.BitSet[] data, int dataSize, long blockNumber) Writes out an array of bit fields (which can be considered the equivalent to a boolean array of rank 2), provided as a Java array of BitSets.
void	writeBitFieldArrayBlock(java.lang.String objectPath, java.util.BitSet[] data, long blockNumber) Writes out an array of bit fields (which can be considered the equivalent to a boolean array of rank 2), provided as a Java array of BitSets.
void	writeBitFieldArrayBlockWithOffset(java.lang.String objectPath, java.util.BitSet[] data, int dataSize, long offset) Writes out an array of bit fields (which can be considered the equivalent to a boolean array of rank 2), provided as a Java array of BitSets.
void	writeBitFieldArrayBlockWithOffset(java.lang.String objectPath, java.util.BitSet[] data, long offset) Writes out an array of bit fields (which can be considered the equivalent to a boolean array of rank 2), provided as a Java array of BitSets.
void	writeBitFieldBlock(java.lang.String objectPath, java.util.BitSet data, int dataSize, long blockNumber) Writes out a block of a bit field (of rank 1).
void	writeBitFieldBlockWithOffset(java.lang.String objectPath, java.util.BitSet data, int dataSize, long offset) Writes out a block of a long array (of rank 1).

Methods inherited from interface ch.systemsx.cisd.hdf5.IHDF5BooleanReader

getAttr, isBitSet, read, readBitField, readBitFieldArray, readBitFieldArrayBlock, readBitFieldArrayBlockWithOffset, readBitFieldBlock, readBitFieldBlockWithOffset

Method Detail

setAttr

void setAttr(java.lang.String objectPath,
             java.lang.String name,
             boolean value)

Sets a boolean attribute to the referenced object.

The referenced object must exist, that is it need to have been written before by one of the write() methods.

Parameters:

objectPath - The name of the object to add the attribute to.

name - The name of the attribute.

value - The value of the attribute.

write

void write(java.lang.String objectPath,
           boolean value)

Writes out a boolean value.

Parameters:

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

value - The value of the data set.

writeBitField

void writeBitField(java.lang.String objectPath,
                   java.util.BitSet data)

Writes out a bit field ((which can be considered the equivalent to a boolean array of rank 1), provided 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 this method cannot be read back by IHDF5LongReader.readArray(String) but will throw a HDF5DatatypeInterfaceException.

Parameters:

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

data - The data to write. Must not be null.

writeBitField

void writeBitField(java.lang.String objectPath,
                   java.util.BitSet data,
                   HDF5GenericStorageFeatures features)

Writes out a bit field ((which can be considered the equivalent to a boolean array of rank 1), provided 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 this method cannot be read back by IHDF5LongReader.readArray(String) but will throw a HDF5DatatypeInterfaceException.

Parameters:

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

data - The data to write. Must not be null.

features - The storage features of the data set.

createBitField

void createBitField(java.lang.String objectPath,
                    int size)

Creates a bit field (of rank 1).

Parameters:

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

size - The size (in 64 bit words) of the bit field to create. This will be the total size for non-extendable data sets and the size of one chunk for extendable (chunked) data sets. For extendable data sets the initial size of the array will be 0, see IHDF5WriterConfigurator.dontUseExtendableDataTypes().

createBitField

void createBitField(java.lang.String objectPath,
                    long size,
                    int blockSize)

Creates a bit field (of rank 1).

Parameters:

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

size - The size (in 64 bit words) of the bit field to create. When using extendable data sets ((see IHDF5WriterConfigurator.dontUseExtendableDataTypes())), then no data set smaller than this size can be created, however data sets may be larger.

blockSize - The size of one block (for block-wise IO). Ignored if no extendable data sets are used (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()).

createBitField

void createBitField(java.lang.String objectPath,
                    int size,
                    HDF5GenericStorageFeatures features)

Creates a bit field array (of rank 1).

Parameters:

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

size - The size (in 64 bit words) of the bit field to create. This will be the total size for non-extendable data sets and the size of one chunk for extendable (chunked) data sets. For extendable data sets the initial size of the array will be 0, see HDF5IntStorageFeatures.

features - The storage features of the data set.

createBitField

void createBitField(java.lang.String objectPath,
                    long size,
                    int blockSize,
                    HDF5GenericStorageFeatures features)

Creates a bit field (of rank 1).

Parameters:

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

size - The size (in 64 bit words) of the bit field to create. When using extendable data sets ((see IHDF5WriterConfigurator.dontUseExtendableDataTypes())), then no data set smaller than this size can be created, however data sets may be larger.

blockSize - The size of one block (for block-wise IO). Ignored if no extendable data sets are used (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()) and features is HDF5IntStorageFeature.INT_NO_COMPRESSION .

features - The storage features of the data set.

writeBitFieldBlock

void writeBitFieldBlock(java.lang.String objectPath,
                        java.util.BitSet data,
                        int dataSize,
                        long blockNumber)

Writes out a block of a bit field (of rank 1). The data set needs to have been created by createBitField(String, long, int, HDF5GenericStorageFeatures) beforehand.

Note: For best performance, the block size in this method should be chosen to be equal to the blockSize argument of the createBitField(String, long, int, HDF5GenericStorageFeatures) call that was used to create the data set.

Parameters:

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

data - The data to write. The length defines the block size. Must not be null or of length 0.

dataSize - The (real) size of data

blockNumber - The number of the block to write.

writeBitFieldBlockWithOffset

void writeBitFieldBlockWithOffset(java.lang.String objectPath,
                                  java.util.BitSet data,
                                  int dataSize,
                                  long offset)

Writes out a block of a long array (of rank 1). The data set needs to have been created by createBitFieldArray(String, int, long, long, HDF5IntStorageFeatures) beforehand.

Use this method instead of writeBitFieldBlock(String, BitSet, int, long) if the total size of the data set is not a multiple of the block size.

Note: For best performance, the typical dataSize in this method should be chosen to be equal to the blockSize argument of the createBitField(String, long, int, HDF5GenericStorageFeatures) call that was used to create the data set.

Parameters:

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

data - The data to write. The length defines the block size. Must not be null or of length 0.

dataSize - The (real) size of data

offset - The offset in the data set to start writing to.

writeBitFieldArray

void writeBitFieldArray(java.lang.String objectPath,
                        java.util.BitSet[] data,
                        HDF5IntStorageFeatures features)

Writes out an array of bit fields (which can be considered the equivalent to a boolean array of rank 2), provided as a Java array of BitSets.

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 this method cannot be read back by IHDF5LongReader.readArray(String) but will throw a HDF5DatatypeInterfaceException.

Parameters:

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

data - The data to write. Must not be null.

features - The storage features of the data set.

writeBitFieldArray

void writeBitFieldArray(java.lang.String objectPath,
                        java.util.BitSet[] data)

Writes out an array of bit fields (which can be considered the equivalent to a boolean array of rank 2), provided as a Java array of BitSets.

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 this method cannot be read back by IHDF5LongReader.readArray(String) but will throw a HDF5DatatypeInterfaceException.

Parameters:

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

data - The data to write. Must not be null.

createBitFieldArray

void createBitFieldArray(java.lang.String objectPath,
                         int bitFieldSize,
                         long arraySize,
                         long arrayBlockSize,
                         HDF5IntStorageFeatures features)

Creates an array of bit fields (of rank 1) (which can be considered the equivalent to a boolean array of rank 2).

Parameters:

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

bitFieldSize - The size of the bit fields in the array (in 64 bit words).

arraySize - The size of the array of bit fields to create. When using extendable data sets ((see IHDF5WriterConfigurator.dontUseExtendableDataTypes())), then no data set smaller than this size can be created, however data sets may be larger.

arrayBlockSize - The size of one block (for block-wise IO). Ignored if no extendable data sets are used (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()) and features is HDF5IntStorageFeature.INT_NO_COMPRESSION.

features - The storage features of the data set.

createBitFieldArray

void createBitFieldArray(java.lang.String objectPath,
                         int bitFieldSize,
                         long arraySize,
                         long arrayBlockSize)

Creates an array of bit fields (of rank 1) (which can be considered the equivalent to a boolean array of rank 2).

Parameters:

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

bitFieldSize - The size of the bit fields in the array (in 64 bit words).

arraySize - The size of the array of bit fields to create. When using extendable data sets ((see IHDF5WriterConfigurator.dontUseExtendableDataTypes())), then no data set smaller than this size can be created, however data sets may be larger.

arrayBlockSize - The size of one block (for block-wise IO). Ignored if no extendable data sets are used (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()) and features is HDF5IntStorageFeature.INT_NO_COMPRESSION.

createBitFieldArray

void createBitFieldArray(java.lang.String objectPath,
                         int bitFieldSize,
                         long arraySize,
                         HDF5IntStorageFeatures features)

Creates an empty array of bit fields (of rank 1) (which can be considered the equivalent to a boolean array of rank 2).

Parameters:

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

bitFieldSize - The size of the bit fields in the array (in 64 bit words).

arraySize - The size of the long array to create. When requesting a chunked data set (e.g. HDF5IntStorageFeatures.INT_CHUNKED), the initial size of the array will be 0 and the chunk size will be arraySize. When allowing a chunked data set (e.g. HDF5IntStorageFeatures.INT_NO_COMPRESSION when the writer is not configured to avoid extendable data types, see IHDF5WriterConfigurator.dontUseExtendableDataTypes()), the initial size and the chunk size of the array will be arraySize. When enforcing a on-extendable data set (e.g. HDF5IntStorageFeatures.INT_CONTIGUOUS), the initial size equals the total size and will be arraySize.

features - The storage features of the data set.

createBitFieldArray

void createBitFieldArray(java.lang.String objectPath,
                         int bitFieldSize,
                         long arraySize)

Creates an empty array of bit fields (of rank 1) (which can be considered the equivalent to a boolean array of rank 2). This method always creates an extendable data sets.

Parameters:

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

bitFieldSize - The size of the bit fields in the array (in 64 bit words).

arraySize - When the writer is configured to use extendable data types (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()), the initial size and the chunk size of the array will be arraySize. When the writer is configured to enforce a on-extendable data set, the initial size equals the total size and will be arraySize.

writeBitFieldArrayBlock

void writeBitFieldArrayBlock(java.lang.String objectPath,
                             java.util.BitSet[] data,
                             int dataSize,
                             long blockNumber)

Writes out an array of bit fields (which can be considered the equivalent to a boolean array of rank 2), provided as a Java array of BitSets.

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 this method cannot be read back by IHDF5LongReader.readArray(String) but will throw a HDF5DatatypeInterfaceException.

Parameters:

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

data - The data to write. Must not be null.

dataSize - The number of entries from data to write to the bitfield array (must be smaller or equals to data.length.

blockNumber - The block number in the array (offset: multiply with dataSize>).

writeBitFieldArrayBlock

void writeBitFieldArrayBlock(java.lang.String objectPath,
                             java.util.BitSet[] data,
                             long blockNumber)

Writes out an array of bit fields (which can be considered the equivalent to a boolean array of rank 2), provided as a Java array of BitSets.

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 this method cannot be read back by IHDF5LongReader.readArray(String) but will throw a HDF5DatatypeInterfaceException.

Parameters:

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

data - The data to write. Must not be null.

blockNumber - The block number in the array (offset: multiply with data.length).

writeBitFieldArrayBlockWithOffset

void writeBitFieldArrayBlockWithOffset(java.lang.String objectPath,
                                       java.util.BitSet[] data,
                                       int dataSize,
                                       long offset)

Writes out an array of bit fields (which can be considered the equivalent to a boolean array of rank 2), provided as a Java array of BitSets.

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 this method cannot be read back by IHDF5LongReader.readArray(String) but will throw a HDF5DatatypeInterfaceException.

Parameters:

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

data - The data to write. Must not be null.

dataSize - The number of entries from data to write to the bitfield array (must be smaller or equals to data.length.

offset - The offset in the bitfield array where to start writing the data.

writeBitFieldArrayBlockWithOffset

void writeBitFieldArrayBlockWithOffset(java.lang.String objectPath,
                                       java.util.BitSet[] data,
                                       long offset)

Writes out an array of bit fields (which can be considered the equivalent to a boolean array of rank 2), provided as a Java array of BitSets.

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 this method cannot be read back by IHDF5LongReader.readArray(String) but will throw a HDF5DatatypeInterfaceException.

Parameters:

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

data - The data to write. Must not be null.

offset - The offset in the bitfield array where to start writing the data.