ch.systemsx.cisd.hdf5

Interface IHDF5EnumReader

All Superinterfaces:

IHDF5EnumTypeRetriever

All Known Subinterfaces:

IHDF5EnumWriter

public interface IHDF5EnumReader
extends IHDF5EnumTypeRetriever

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

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

Method Summary

Modifier and Type	Method and Description
HDF5EnumerationValueArray	getArrayAttr(java.lang.String objectPath, java.lang.String attributeName) Reads an enum array (of rank 1) attribute named attributeName from the data set objectPath.
java.lang.Iterable<HDF5DataBlock<HDF5EnumerationValueArray>>	getArrayBlocks(java.lang.String objectPath) Provides all natural blocks of this one-dimensional data set to iterate over.
java.lang.Iterable<HDF5DataBlock<HDF5EnumerationValueArray>>	getArrayBlocks(java.lang.String objectPath, HDF5EnumerationType enumType) Provides all natural blocks of this one-dimensional data set to iterate over.
HDF5EnumerationValue	getAttr(java.lang.String objectPath, java.lang.String attributeName) Reads an enum attribute named attributeName from the data set objectPath.
<T extends java.lang.Enum<T>> T	getAttr(java.lang.String objectPath, java.lang.String attributeName, java.lang.Class<T> enumClass) Reads an enum attribute named attributeName from the data set objectPath.
java.lang.String	getAttrAsString(java.lang.String objectPath, java.lang.String attributeName) Reads an enum attribute named attributeName from the data set objectPath.
HDF5EnumerationValueMDArray	getMDArrayAttr(java.lang.String objectPath, java.lang.String attributeName) Reads an enum array (of rank 1) attribute named attributeName from the data set objectPath.
java.lang.Iterable<HDF5MDEnumBlock>	getMDArrayBlocks(java.lang.String objectPath) Provides all natural blocks of this multi-dimensional data set to iterate over.
java.lang.Iterable<HDF5MDEnumBlock>	getMDArrayBlocks(java.lang.String objectPath, HDF5EnumerationType type) Provides all natural blocks of this multi-dimensional data set to iterate over.
HDF5EnumerationValue	read(java.lang.String objectPath) Reads an Enum value from the data set objectPath.
<T extends java.lang.Enum<T>> T	read(java.lang.String objectPath, java.lang.Class<T> enumClass) Reads an Enum value from the data set objectPath.
HDF5EnumerationValue	read(java.lang.String objectPath, HDF5EnumerationType enumType) Reads an Enum value from the data set objectPath.
HDF5EnumerationValueArray	readArray(java.lang.String objectPath) Reads an Enum value array from the data set objectPath.
HDF5EnumerationValueArray	readArray(java.lang.String objectPath, HDF5EnumerationType enumType) Reads an Enum value from the data set objectPath.
HDF5EnumerationValueArray	readArrayBlock(java.lang.String objectPath, HDF5EnumerationType enumType, int blockSize, long blockNumber) Reads an Enum value array block from the data set objectPath.
HDF5EnumerationValueArray	readArrayBlock(java.lang.String objectPath, int blockSize, long blockNumber) Reads an Enum value array block from the data set objectPath.
HDF5EnumerationValueArray	readArrayBlockWithOffset(java.lang.String objectPath, HDF5EnumerationType enumType, int blockSize, long offset) Reads an Enum value array block from the data set objectPath.
HDF5EnumerationValueArray	readArrayBlockWithOffset(java.lang.String objectPath, int blockSize, long offset) Reads an Enum value array block from the data set objectPath.
java.lang.String	readAsString(java.lang.String objectPath) Reads an Enum value from the data set objectPath.
HDF5EnumerationValueMDArray	readMDArray(java.lang.String objectPath) Reads an Enum array (of rank N) from the data set objectPath.
HDF5EnumerationValueMDArray	readMDArray(java.lang.String objectPath, HDF5EnumerationType enumType) Reads an Enum array (of rank N) from the data set objectPath.
HDF5EnumerationValueMDArray	readMDArrayBlock(java.lang.String objectPath, HDF5EnumerationType type, int[] blockDimensions, long[] blockNumber) Reads a block from a Enum array block (of rank N) from the data set objectPath.
HDF5EnumerationValueMDArray	readMDArrayBlock(java.lang.String objectPath, int[] blockDimensions, long[] blockNumber) Reads a block from a Enum array block (of rank N) from the data set objectPath.
HDF5EnumerationValueMDArray	readMDArrayBlockWithOffset(java.lang.String objectPath, HDF5EnumerationType type, int[] blockDimensions, long[] offset) Reads a block from a Enum array block (of rank N) from the data set objectPath.
HDF5EnumerationValueMDArray	readMDArrayBlockWithOffset(java.lang.String objectPath, int[] blockDimensions, long[] offset) Reads a block from a Enum array block (of rank N) from the data set objectPath.

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

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

Method Detail

getAttrAsString

java.lang.String getAttrAsString(java.lang.String objectPath,
                                 java.lang.String attributeName)
                          throws HDF5JavaException

Reads an enum attribute named attributeName from the data set objectPath.

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 as a String.

Throws:

HDF5JavaException - If the attribute is not an enum type.

getAttr

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

Reads an enum attribute named attributeName from the data set objectPath.

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

getAttr

<T extends java.lang.Enum<T>> T getAttr(java.lang.String objectPath,
                                        java.lang.String attributeName,
                                        java.lang.Class<T> enumClass)
                                 throws HDF5JavaException

Reads an enum attribute named attributeName from the data set objectPath.

Parameters:

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

attributeName - The name of the attribute to read.

enumClass - the Enum class to represent the values of.

Returns:

The attribute value read from the data set.

Throws:

HDF5JavaException - If the attribute is not an enum type.

getArrayAttr

HDF5EnumerationValueArray getArrayAttr(java.lang.String objectPath,
                                       java.lang.String attributeName)
                                throws HDF5JavaException

Reads an enum array (of rank 1) attribute named attributeName from the data set objectPath.

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 values as read from the data set.

Throws:

HDF5JavaException - If the attribute is not an enum type.

getMDArrayAttr

HDF5EnumerationValueMDArray getMDArrayAttr(java.lang.String objectPath,
                                           java.lang.String attributeName)
                                    throws HDF5JavaException

Reads an enum array (of rank 1) attribute named attributeName from the data set objectPath.

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 values as read from the data set.

Throws:

HDF5JavaException - If the attribute is not an enum type.

readAsString

java.lang.String readAsString(java.lang.String objectPath)
                       throws HDF5JavaException

Reads an Enum value from the data set objectPath.

Parameters:

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

Returns:

The data read from the data set as a String.

Throws:

HDF5JavaException - If the objectPath is not an enum type.

read

HDF5EnumerationValue read(java.lang.String objectPath)
                   throws HDF5JavaException

Reads an Enum value from the data set objectPath.

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 of enumType.

read

<T extends java.lang.Enum<T>> T read(java.lang.String objectPath,
                                     java.lang.Class<T> enumClass)
                              throws HDF5JavaException

Reads an Enum value from the data set objectPath.

Parameters:

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

enumClass - the Enum class to represent the values of.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not of enumType or if enumClass is incompatible with the HDF5 enumeration type of objectPath.

read

HDF5EnumerationValue read(java.lang.String objectPath,
                          HDF5EnumerationType enumType)
                   throws HDF5JavaException

Reads an Enum value from the data set objectPath.

This method is faster than read(String) if the HDF5EnumerationType is already available.

Parameters:

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

enumType - The enum type in the HDF5 file.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not of enumType.

readArray

HDF5EnumerationValueArray readArray(java.lang.String objectPath,
                                    HDF5EnumerationType enumType)
                             throws HDF5JavaException

Reads an Enum value from the data set objectPath.

Parameters:

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

enumType - The enumeration type of this array.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not of enumType.

readArray

HDF5EnumerationValueArray readArray(java.lang.String objectPath)
                             throws HDF5JavaException

Reads an Enum value array from the data set objectPath.

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 of enumType.

readArrayBlock

HDF5EnumerationValueArray readArrayBlock(java.lang.String objectPath,
                                         int blockSize,
                                         long blockNumber)

Reads an Enum value array block from the data set objectPath.

Parameters:

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

blockSize - The block size (this will be the return value of the HDF5EnumerationValueArray.getLength() returned if the data set is long enough).

blockNumber - The number of the block to read (starting with 0, offset: multiply with blockSize).

Returns:

The data read from the data set. The length will be min(size - blockSize*blockNumber, blockSize).

readArrayBlock

HDF5EnumerationValueArray readArrayBlock(java.lang.String objectPath,
                                         HDF5EnumerationType enumType,
                                         int blockSize,
                                         long blockNumber)

Reads an Enum value array block from the data set objectPath.

Parameters:

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

enumType - The enumeration type of this array.

blockSize - The block size (this will be the return value of the HDF5EnumerationValueArray.getLength() returned if the data set is long enough).

blockNumber - The number of the block to read (starting with 0, offset: multiply with blockSize).

Returns:

The data read from the data set. The length will be min(size - blockSize*blockNumber, blockSize).

readArrayBlockWithOffset

HDF5EnumerationValueArray readArrayBlockWithOffset(java.lang.String objectPath,
                                                   int blockSize,
                                                   long offset)

Reads an Enum value array block from the data set objectPath.

Parameters:

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

blockSize - The block size (this will be the return value of the HDF5EnumerationValueArray.getLength() returned if the data set is long enough).

offset - The offset of the block in the data set to start reading from (starting with 0).

Returns:

The data read from the data set. The length will be min(size - blockSize*blockNumber, blockSize).

readArrayBlockWithOffset

HDF5EnumerationValueArray readArrayBlockWithOffset(java.lang.String objectPath,
                                                   HDF5EnumerationType enumType,
                                                   int blockSize,
                                                   long offset)

Reads an Enum value array block from the data set objectPath.

Parameters:

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

enumType - The enumeration type of this array.

blockSize - The block size (this will be the return value of the HDF5EnumerationValueArray.getLength() returned if the data set is long enough).

offset - The offset of the block in the data set to start reading from (starting with 0).

Returns:

The data read from the data set. The length will be min(size - blockSize*blockNumber, blockSize).

readMDArray

HDF5EnumerationValueMDArray readMDArray(java.lang.String objectPath)
                                 throws HDF5JavaException

Reads an Enum array (of rank N) from the data set objectPath.

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 of enumType.

readMDArray

HDF5EnumerationValueMDArray readMDArray(java.lang.String objectPath,
                                        HDF5EnumerationType enumType)
                                 throws HDF5JavaException

Reads an Enum array (of rank N) from the data set objectPath.

This method is faster than read(String) if the HDF5EnumerationType is already available.

Parameters:

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

enumType - The enum type in the HDF5 file.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not of enumType.

readMDArrayBlock

HDF5EnumerationValueMDArray readMDArrayBlock(java.lang.String objectPath,
                                             HDF5EnumerationType type,
                                             int[] blockDimensions,
                                             long[] blockNumber)
                                      throws HDF5JavaException

Reads a block from a Enum array block (of rank N) from the data set objectPath.

Parameters:

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

type - The type definition of this enumeration type.

blockDimensions - The extent of the block to write along each axis.

blockNumber - The number of the block to write along each axis.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not an enum data set.

readMDArrayBlock

HDF5EnumerationValueMDArray readMDArrayBlock(java.lang.String objectPath,
                                             int[] blockDimensions,
                                             long[] blockNumber)
                                      throws HDF5JavaException

Reads a block from a Enum array block (of rank N) from the data set objectPath.

Parameters:

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

blockDimensions - The extent of the block to write along each axis.

blockNumber - The number of the block to write along each axis.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not an enum data set.

readMDArrayBlockWithOffset

HDF5EnumerationValueMDArray readMDArrayBlockWithOffset(java.lang.String objectPath,
                                                       HDF5EnumerationType type,
                                                       int[] blockDimensions,
                                                       long[] offset)
                                                throws HDF5JavaException

Reads a block from a Enum array block (of rank N) from the data set objectPath.

Parameters:

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

type - The type definition of this Enum type.

blockDimensions - The extent of the block to write along each axis.

offset - The offset of the block to write in the data set along each axis.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not an enum data set.

readMDArrayBlockWithOffset

HDF5EnumerationValueMDArray readMDArrayBlockWithOffset(java.lang.String objectPath,
                                                       int[] blockDimensions,
                                                       long[] offset)
                                                throws HDF5JavaException

Reads a block from a Enum array block (of rank N) from the data set objectPath.

Parameters:

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

blockDimensions - The extent of the block to write along each axis.

offset - The offset of the block to write in the data set along each axis.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not an enum data set.

getArrayBlocks

java.lang.Iterable<HDF5DataBlock<HDF5EnumerationValueArray>> getArrayBlocks(java.lang.String objectPath)
                                                                     throws HDF5JavaException

Provides all natural blocks of this one-dimensional data set to iterate over.

Parameters:

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

Throws:

HDF5JavaException - If the data set is not of rank 1.

See Also:

HDF5DataBlock

getArrayBlocks

java.lang.Iterable<HDF5DataBlock<HDF5EnumerationValueArray>> getArrayBlocks(java.lang.String objectPath,
                                                                            HDF5EnumerationType enumType)
                                                                     throws HDF5JavaException

Provides all natural blocks of this one-dimensional data set to iterate over.

Parameters:

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

enumType - The enumeration type of this array.

Throws:

HDF5JavaException - If the data set is not of rank 1.

See Also:

HDF5DataBlock

getMDArrayBlocks

java.lang.Iterable<HDF5MDEnumBlock> getMDArrayBlocks(java.lang.String objectPath,
                                                     HDF5EnumerationType type)
                                              throws HDF5JavaException

Provides all natural blocks of this multi-dimensional data set to iterate over.

Parameters:

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

type - The type definition of this enum type.

Throws:

HDF5JavaException - If the data set is not an enum data set.

See Also:

HDF5MDDataBlock

getMDArrayBlocks

java.lang.Iterable<HDF5MDEnumBlock> getMDArrayBlocks(java.lang.String objectPath)
                                              throws HDF5JavaException

Provides all natural blocks of this multi-dimensional data set to iterate over.

Parameters:

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

Throws:

HDF5JavaException - If the data set is not an enum data set.

See Also:

HDF5MDDataBlock