ch.systemsx.cisd.hdf5

Interface IHDF5OpaqueWriter

All Superinterfaces:

IHDF5OpaqueReader

All Known Implementing Classes:

HDF5OpaqueWriter

public interface IHDF5OpaqueWriter
extends IHDF5OpaqueReader

An interface that provides methods for writing opaque values to HDF5 files. Opaque values are represented as byte arrays, however, contrary to the methods in IHDF5ByteWriter there is no notion on the interpretation of these values. The methods in this writer can be used to store data sets which are a "black box". Note that there are no dedicated methods for reading opaque types. Use the methods in IHDF5OpaqueReader instead which allow you to read any data set as a byte array.

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

Method Summary

Modifier and Type	Method and Description
HDF5OpaqueType	createArray(java.lang.String objectPath, java.lang.String tag, int size) Creates an opaque data set that will be represented as a byte array (of rank 1).
HDF5OpaqueType	createArray(java.lang.String objectPath, java.lang.String tag, int size, HDF5GenericStorageFeatures features) Creates an opaque data set that will be represented as a byte array (of rank 1).
HDF5OpaqueType	createArray(java.lang.String objectPath, java.lang.String tag, long size, int blockSize) Creates an opaque data set that will be represented as a byte array (of rank 1).
HDF5OpaqueType	createArray(java.lang.String objectPath, java.lang.String tag, long size, int blockSize, HDF5GenericStorageFeatures features) Creates an opaque data set that will be represented as a byte array (of rank 1).
void	writeArray(java.lang.String objectPath, java.lang.String tag, byte[] data) Writes out an opaque data type described by tag and defined by a byte array (of rank 1).
void	writeArray(java.lang.String objectPath, java.lang.String tag, byte[] data, HDF5GenericStorageFeatures features) Writes out an opaque data type described by tag and defined by a byte array (of rank 1).
void	writeArrayBlock(java.lang.String objectPath, HDF5OpaqueType dataType, byte[] data, long blockNumber) Writes out a block of an opaque data type represented by a byte array (of rank 1).
void	writeArrayBlockWithOffset(java.lang.String objectPath, HDF5OpaqueType dataType, byte[] data, int dataSize, long offset) Writes out a block of an opaque data type represented by a byte array (of rank 1).

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

getArrayAttr, getArrayNaturalBlocks, readArray, readArrayBlock, readArrayBlockWithOffset, readArrayToBlockWithOffset, tryGetOpaqueTag, tryGetOpaqueType

Method Detail

writeArray

void writeArray(java.lang.String objectPath,
                java.lang.String tag,
                byte[] data)

Writes out an opaque data type described by tag and defined by a byte array (of rank 1).

Note that there is no dedicated method for reading opaque types. Use the method IHDF5OpaqueReader.readArray(String) instead.

Parameters:

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

tag - The tag of the data set.

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

writeArray

void writeArray(java.lang.String objectPath,
                java.lang.String tag,
                byte[] data,
                HDF5GenericStorageFeatures features)

Writes out an opaque data type described by tag and defined by a byte array (of rank 1).

Note that there is no dedicated method for reading opaque types. Use the method IHDF5OpaqueReader.readArray(String) instead.

Parameters:

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

tag - The tag of the data set.

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

features - The storage features of the data set.

createArray

HDF5OpaqueType createArray(java.lang.String objectPath,
                           java.lang.String tag,
                           long size,
                           int blockSize)

Creates an opaque data set that will be represented as a byte array (of rank 1).

Parameters:

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

size - The size of the byte array to create.

blockSize - The size of on block (for block-wise IO)

Returns:

The HDF5OpaqueType that can be used in methods writeArrayBlock(String, HDF5OpaqueType, byte[], long) and writeArrayBlockWithOffset(String, HDF5OpaqueType, byte[], int, long) to represent this opaque type.

createArray

HDF5OpaqueType createArray(java.lang.String objectPath,
                           java.lang.String tag,
                           int size)

Creates an opaque data set that will be represented as a byte array (of rank 1).

Parameters:

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

size - The size of the byte array 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().

Returns:

The HDF5OpaqueType that can be used in methods writeArrayBlock(String, HDF5OpaqueType, byte[], long) and writeArrayBlockWithOffset(String, HDF5OpaqueType, byte[], int, long) to represent this opaque type.

createArray

HDF5OpaqueType createArray(java.lang.String objectPath,
                           java.lang.String tag,
                           long size,
                           int blockSize,
                           HDF5GenericStorageFeatures features)

Creates an opaque data set that will be represented as a byte array (of rank 1).

Parameters:

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

size - The size of the byte array to create.

blockSize - The size of on block (for block-wise IO)

features - The storage features of the data set.

Returns:

The HDF5OpaqueType that can be used in methods writeArrayBlock(String, HDF5OpaqueType, byte[], long) and writeArrayBlockWithOffset(String, HDF5OpaqueType, byte[], int, long) to represent this opaque type.

createArray

HDF5OpaqueType createArray(java.lang.String objectPath,
                           java.lang.String tag,
                           int size,
                           HDF5GenericStorageFeatures features)

Creates an opaque data set that will be represented as a byte array (of rank 1).

Parameters:

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

size - The size of the byte array 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 HDF5GenericStorageFeatures.

features - The storage features of the data set.

Returns:

The HDF5OpaqueType that can be used in methods writeArrayBlock(String, HDF5OpaqueType, byte[], long) and writeArrayBlockWithOffset(String, HDF5OpaqueType, byte[], int, long) to represent this opaque type.

writeArrayBlock

void writeArrayBlock(java.lang.String objectPath,
                     HDF5OpaqueType dataType,
                     byte[] data,
                     long blockNumber)

Writes out a block of an opaque data type represented by a byte array (of rank 1). The data set needs to have been created by createArray(String, 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 createArray(String, String, long, int, HDF5GenericStorageFeatures) call that was used to created the data set.

Note that there is no dedicated method for reading opaque types. Use the method IHDF5OpaqueReader.readArrayBlock(String, int, long) instead.

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.

blockNumber - The number of the block to write.

writeArrayBlockWithOffset

void writeArrayBlockWithOffset(java.lang.String objectPath,
                               HDF5OpaqueType dataType,
                               byte[] data,
                               int dataSize,
                               long offset)

Writes out a block of an opaque data type represented by a byte array (of rank 1). The data set needs to have been created by createArray(String, String, long, int, HDF5GenericStorageFeatures) beforehand.

Use this method instead of writeArrayBlock(String, HDF5OpaqueType, byte[], long) if the total size of the data set is not a multiple of the block size.

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

Note that there is no dedicated method for reading opaque types. Use the method IHDF5OpaqueReader.readArrayBlockWithOffset(String, int, long) instead.

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 (needs to be <= data.length )

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