ch.systemsx.cisd.hdf5

Class HDF5OpaqueWriter

java.lang.Object

ch.systemsx.cisd.hdf5.HDF5OpaqueReader

ch.systemsx.cisd.hdf5.HDF5OpaqueWriter

All Implemented Interfaces:

IHDF5OpaqueReader, IHDF5OpaqueWriter

public class HDF5OpaqueWriter
extends HDF5OpaqueReader
implements IHDF5OpaqueWriter

Implementation of IHDF5OpaqueWriter.

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 class ch.systemsx.cisd.hdf5.HDF5OpaqueReader

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

Methods inherited from class java.lang.Object

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

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

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

Method Detail

writeArray

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

Description copied from interface: IHDF5OpaqueWriter

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.

Specified by:

writeArray in interface IHDF5OpaqueWriter

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

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

Description copied from interface: IHDF5OpaqueWriter

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.

Specified by:

writeArray in interface IHDF5OpaqueWriter

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

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

Description copied from interface: IHDF5OpaqueWriter

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

Specified by:

createArray in interface IHDF5OpaqueWriter

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 IHDF5OpaqueWriter.writeArrayBlock(String, HDF5OpaqueType, byte[], long) and IHDF5OpaqueWriter.writeArrayBlockWithOffset(String, HDF5OpaqueType, byte[], int, long) to represent this opaque type.

createArray

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

Description copied from interface: IHDF5OpaqueWriter

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

Specified by:

createArray in interface IHDF5OpaqueWriter

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 IHDF5OpaqueWriter.writeArrayBlock(String, HDF5OpaqueType, byte[], long) and IHDF5OpaqueWriter.writeArrayBlockWithOffset(String, HDF5OpaqueType, byte[], int, long) to represent this opaque type.

createArray

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

Description copied from interface: IHDF5OpaqueWriter

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

Specified by:

createArray in interface IHDF5OpaqueWriter

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 IHDF5OpaqueWriter.writeArrayBlock(String, HDF5OpaqueType, byte[], long) and IHDF5OpaqueWriter.writeArrayBlockWithOffset(String, HDF5OpaqueType, byte[], int, long) to represent this opaque type.

createArray

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

Description copied from interface: IHDF5OpaqueWriter

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

Specified by:

createArray in interface IHDF5OpaqueWriter

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 IHDF5OpaqueWriter.writeArrayBlock(String, HDF5OpaqueType, byte[], long) and IHDF5OpaqueWriter.writeArrayBlockWithOffset(String, HDF5OpaqueType, byte[], int, long) to represent this opaque type.

writeArrayBlock

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

Description copied from interface: IHDF5OpaqueWriter

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 IHDF5OpaqueWriter.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 IHDF5OpaqueWriter.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.

Specified by:

writeArrayBlock in interface IHDF5OpaqueWriter

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

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

Description copied from interface: IHDF5OpaqueWriter

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 IHDF5OpaqueWriter.createArray(String, String, long, int, HDF5GenericStorageFeatures) beforehand.

Use this method instead of IHDF5OpaqueWriter.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 IHDF5OpaqueWriter.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.

Specified by:

writeArrayBlockWithOffset in interface IHDF5OpaqueWriter

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.