ch.systemsx.cisd.hdf5

Interface IHDF5EnumWriter

All Superinterfaces:

IHDF5EnumReader, IHDF5EnumTypeRetriever, IHDF5EnumValueCreator

public interface IHDF5EnumWriter
extends IHDF5EnumReader, IHDF5EnumValueCreator

An interface that provides methods for writing enumeration values from HDF5 files.

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

Method Summary

Modifier and Type	Method and Description
HDF5EnumerationType	createArray(java.lang.String objectPath, HDF5EnumerationType enumType, int size) Creates am enum array (of rank 1).
HDF5EnumerationType	createArray(java.lang.String objectPath, HDF5EnumerationType enumType, long size, HDF5IntStorageFeatures features) Creates am enum array (of rank 1).
HDF5EnumerationType	createArray(java.lang.String objectPath, HDF5EnumerationType enumType, long size, int blockSize) Creates am enum array (of rank 1).
HDF5EnumerationType	createArray(java.lang.String objectPath, HDF5EnumerationType enumType, long size, int blockSize, HDF5IntStorageFeatures features) Creates am enum array (of rank 1).
HDF5EnumerationType	createMDArray(java.lang.String objectPath, HDF5EnumerationType type, int[] dimensions) Creates an array (of rank N) of Enum values.
HDF5EnumerationType	createMDArray(java.lang.String objectPath, HDF5EnumerationType type, int[] dimensions, HDF5IntStorageFeatures features) Creates an array (of rank N) of Enum values.
HDF5EnumerationType	createMDArray(java.lang.String objectPath, HDF5EnumerationType type, long[] dimensions, int[] blockDimensions) Creates an array (of rank N) of Enum values.
HDF5EnumerationType	createMDArray(java.lang.String objectPath, HDF5EnumerationType type, long[] dimensions, int[] blockDimensions, HDF5IntStorageFeatures features) Creates an array (of rank N) of Enum values.
HDF5EnumerationType	getAnonType(java.lang.Class<? extends java.lang.Enum<?>> enumClass) Returns an anonymous enumeration type for this HDF5 file.
HDF5EnumerationType	getAnonType(EnumerationType enumType) Returns an anonymous enumeration type for this HDF5 file.
HDF5EnumerationType	getAnonType(java.lang.String[] options) Returns an anonymous enumeration type for this HDF5 file.
void	setArrayAttr(java.lang.String objectPath, java.lang.String name, HDF5EnumerationValueArray value) Sets an enum array attribute (of rank 1) to the referenced object.
void	setAttr(java.lang.String objectPath, java.lang.String name, java.lang.Enum<?> value) Sets an enum attribute to the referenced object.
void	setAttr(java.lang.String objectPath, java.lang.String name, HDF5EnumerationValue value) Sets an enum attribute to the referenced object.
void	setMDArrayAttr(java.lang.String objectPath, java.lang.String name, HDF5EnumerationValueMDArray value) Sets an enum array (of rank N) attribute to the referenced object.
void	write(java.lang.String objectPath, java.lang.Enum<?> value) Writes out an enum value.
void	write(java.lang.String objectPath, HDF5EnumerationValue value) Writes out an enum value.
void	writeArray(java.lang.String objectPath, HDF5EnumerationValueArray data) Writes out an array of enum values.
void	writeArray(java.lang.String objectPath, HDF5EnumerationValueArray data, HDF5IntStorageFeatures features) Writes out an array of enum values.
void	writeArrayBlock(java.lang.String objectPath, HDF5EnumerationValueArray data, long blockNumber) Writes out a block of an enum array (of rank 1).
void	writeArrayBlockWithOffset(java.lang.String objectPath, HDF5EnumerationValueArray data, int dataSize, long offset) Writes out a block of an enum array (of rank 1).
void	writeMDArray(java.lang.String objectPath, HDF5EnumerationValueMDArray data) Writes out an array (of rank N) of Enum values.
void	writeMDArray(java.lang.String objectPath, HDF5EnumerationValueMDArray data, HDF5IntStorageFeatures features) Writes out an array (of rank N) of Enum values.
void	writeMDArrayBlock(java.lang.String objectPath, HDF5EnumerationValueMDArray data, long[] blockNumber) Writes out a block of an array (of rank N) of Enum values give a given offset.
void	writeMDArrayBlockWithOffset(java.lang.String objectPath, HDF5EnumerationValueMDArray data, long[] offset) Writes out a block of an array (of rank N) of Enum values give a given offset.

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

getArrayAttr, getArrayBlocks, getArrayBlocks, getAttr, getAttr, getAttrAsString, getMDArrayAttr, getMDArrayBlocks, getMDArrayBlocks, read, read, read, readArray, readArray, readArrayBlock, readArrayBlock, readArrayBlockWithOffset, readArrayBlockWithOffset, readAsString, readMDArray, readMDArray, readMDArrayBlock, readMDArrayBlock, readMDArrayBlockWithOffset, readMDArrayBlockWithOffset

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

getAttributeType, getDataSetType, getType, getType, getType, getType, getType, getType, getType, getType, getType

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

newAnonArray, newAnonArray, newAnonArray, newAnonArray, newAnonArray, newAnonMDArray, newAnonMDArray, newAnonMDArray, newAnonMDArray, newAnonMDArray, newAnonVal, newAnonVal, newAnonVal, newAnonVal, newAnonVal, newArray, newArray, newArray, newArray, newArray, newArray, newMDArray, newMDArray, newMDArray, newMDArray, newMDArray, newMDArray, newVal, newVal, newVal, newVal, newVal, newVal

Method Detail

getAnonType

HDF5EnumerationType getAnonType(java.lang.String[] options)
                         throws HDF5JavaException

Returns an anonymous enumeration type for this HDF5 file.

Parameters:

options - The values of the enumeration type.

Throws:

HDF5JavaException - If the data type exists and is not compatible with the values provided.

getAnonType

HDF5EnumerationType getAnonType(java.lang.Class<? extends java.lang.Enum<?>> enumClass)
                         throws HDF5JavaException

Returns an anonymous enumeration type for this HDF5 file.

Parameters:

enumClass - The enumeration class to get the values from.

Throws:

HDF5JavaException - If the data type exists and is not compatible with the enumClass provided.

getAnonType

HDF5EnumerationType getAnonType(EnumerationType enumType)

Returns an anonymous enumeration type for this HDF5 file.

Parameters:

enumType - The (file-independent) enumeration type to get the values from.

setAttr

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

Sets an enum 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.

setAttr

void setAttr(java.lang.String objectPath,
             java.lang.String name,
             java.lang.Enum<?> value)
      throws HDF5JavaException

Sets an enum 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.

Throws:

HDF5JavaException - If the enum type of value is not a type of this file.

setArrayAttr

void setArrayAttr(java.lang.String objectPath,
                  java.lang.String name,
                  HDF5EnumerationValueArray value)

Sets an enum array attribute (of rank 1) 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.

setMDArrayAttr

void setMDArrayAttr(java.lang.String objectPath,
                    java.lang.String name,
                    HDF5EnumerationValueMDArray value)

Sets an enum array (of rank N) 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,
           HDF5EnumerationValue value)
    throws HDF5JavaException

Writes out an enum value.

Parameters:

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

value - The value of the data set.

Throws:

HDF5JavaException - If the enum type of value is not a type of this file.

write

void write(java.lang.String objectPath,
           java.lang.Enum<?> value)
    throws HDF5JavaException

Writes out an enum value.

Parameters:

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

value - The value of the data set.

Throws:

HDF5JavaException - If the enum type of value is not a type of this file.

writeArray

void writeArray(java.lang.String objectPath,
                HDF5EnumerationValueArray data)
         throws HDF5JavaException

Writes out an array of enum values.

Parameters:

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

data - The data to write.

Throws:

HDF5JavaException - If the enum type of value is not a type of this file.

writeArray

void writeArray(java.lang.String objectPath,
                HDF5EnumerationValueArray data,
                HDF5IntStorageFeatures features)
         throws HDF5JavaException

Writes out an array of enum values.

Parameters:

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

data - The data to write.

features - The storage features of the data set. Note that for scaling compression the compression factor is ignored. Instead, the scaling factor is computed from the number of entries in the enumeration.

Throws:

HDF5JavaException - If the enum type of value is not a type of this file.

createArray

HDF5EnumerationType createArray(java.lang.String objectPath,
                                HDF5EnumerationType enumType,
                                int size)

Creates am enum array (of rank 1).

Parameters:

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

enumType - The enumeration type of this array.

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:

enumType

createArray

HDF5EnumerationType createArray(java.lang.String objectPath,
                                HDF5EnumerationType enumType,
                                long size,
                                int blockSize)

Creates am enum array (of rank 1). The initial size of the array is 0.

Parameters:

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

enumType - The enumeration type of this array.

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

Returns:

enumType

createArray

HDF5EnumerationType createArray(java.lang.String objectPath,
                                HDF5EnumerationType enumType,
                                long size,
                                HDF5IntStorageFeatures features)

Creates am enum array (of rank 1). The initial size of the array is 0.

Parameters:

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

enumType - The enumeration type of this array.

size - The size of the enum 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 HDF5IntStorageFeatures.

features - The storage features of the data set.

Returns:

enumType

createArray

HDF5EnumerationType createArray(java.lang.String objectPath,
                                HDF5EnumerationType enumType,
                                long size,
                                int blockSize,
                                HDF5IntStorageFeatures features)

Creates am enum array (of rank 1). The initial size of the array is 0.

Parameters:

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

enumType - The enumeration type of this array.

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

features - The storage features of the data set.

Returns:

enumType

writeArrayBlock

void writeArrayBlock(java.lang.String objectPath,
                     HDF5EnumerationValueArray data,
                     long blockNumber)

Writes out a block of an enum array (of rank 1). The data set needs to have been created by createArray(String, HDF5EnumerationType, long, int, HDF5IntStorageFeatures) beforehand. Obviously the HDF5EnumerationType of the create call and this call needs to match.

Note: For best performance, the block size in this method should be chosen to be equal to the blockSize argument of the createArray(String, HDF5EnumerationType, long, int, HDF5IntStorageFeatures) 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 value of HDF5EnumerationValueArray.getLength() 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,
                               HDF5EnumerationValueArray data,
                               int dataSize,
                               long offset)

Writes out a block of an enum array (of rank 1). The data set needs to have been created by createArray(String, HDF5EnumerationType, long, int, HDF5IntStorageFeatures) beforehand. Obviously the HDF5EnumerationType of the create call and this call needs to match.

Note: For best performance, the block size in this method should be chosen to be equal to the blockSize argument of the createArray(String, HDF5EnumerationType, long, int, HDF5IntStorageFeatures) 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 value of HDF5EnumerationValueArray.getLength() defines the block size. Must not be null or of length 0.

dataSize - The (real) size of data (needs to be <= data.getLength() )

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

writeMDArray

void writeMDArray(java.lang.String objectPath,
                  HDF5EnumerationValueMDArray data,
                  HDF5IntStorageFeatures features)

Writes out an array (of rank N) of Enum values.

Parameters:

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

data - The data to write.

features - The storage features of the data set.

writeMDArray

void writeMDArray(java.lang.String objectPath,
                  HDF5EnumerationValueMDArray data)

Writes out an array (of rank N) of Enum values.

Parameters:

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

data - The data to write.

createMDArray

HDF5EnumerationType createMDArray(java.lang.String objectPath,
                                  HDF5EnumerationType type,
                                  int[] dimensions)

Creates an array (of rank N) of Enum values.

Parameters:

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

type - The type definition of this Enum type.

dimensions - The dimensions of the byte array to create. This will be the total dimensions for non-extendable data sets and the dimensions of one chunk (along each axis) for extendable (chunked) data sets. For extendable data sets the initial size of the array (along each axis) will be 0, see IHDF5WriterConfigurator.dontUseExtendableDataTypes().

Returns:

enumType

createMDArray

HDF5EnumerationType createMDArray(java.lang.String objectPath,
                                  HDF5EnumerationType type,
                                  long[] dimensions,
                                  int[] blockDimensions)

Creates an array (of rank N) of Enum values.

Parameters:

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

type - The type definition of this Enum type.

dimensions - The extent of the Enum array along each of the axis.

blockDimensions - The extent of one block along each of the axis. (for block-wise IO). Ignored if no extendable data sets are used (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()) and deflate == false.

Returns:

enumType

createMDArray

HDF5EnumerationType createMDArray(java.lang.String objectPath,
                                  HDF5EnumerationType type,
                                  long[] dimensions,
                                  int[] blockDimensions,
                                  HDF5IntStorageFeatures features)

Creates an array (of rank N) of Enum values.

Parameters:

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

type - The type definition of this Enum type.

dimensions - The extent of the Enum array along each of the axis.

blockDimensions - The extent of one block along each of the axis. (for block-wise IO). Ignored if no extendable data sets are used (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()) and deflate == false.

features - The storage features of the data set.

Returns:

enumType

createMDArray

HDF5EnumerationType createMDArray(java.lang.String objectPath,
                                  HDF5EnumerationType type,
                                  int[] dimensions,
                                  HDF5IntStorageFeatures features)

Creates an array (of rank N) of Enum values.

Parameters:

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

type - The type definition of this Enum type.

dimensions - The dimensions of the byte array to create. This will be the total dimensions for non-extendable data sets and the dimensions of one chunk (along each axis) for extendable (chunked) data sets. For extendable data sets the initial size of the array (along each axis) will be 0, see HDF5GenericStorageFeatures.

features - The storage features of the data set.

Returns:

enumType

writeMDArrayBlock

void writeMDArrayBlock(java.lang.String objectPath,
                       HDF5EnumerationValueMDArray data,
                       long[] blockNumber)

Writes out a block of an array (of rank N) of Enum values give a given offset.

Parameters:

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

data - The data to write.

blockNumber - The block number in each dimension (offset: multiply with the extend in the according dimension).

writeMDArrayBlockWithOffset

void writeMDArrayBlockWithOffset(java.lang.String objectPath,
                                 HDF5EnumerationValueMDArray data,
                                 long[] offset)

Writes out a block of an array (of rank N) of Enum values give a given offset.

Parameters:

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

data - The data to write.

offset - The offset of the block in the data set to start writing to in each dimension.