ch.systemsx.cisd.hdf5

Interface IHDF5EnumBasicReader

All Known Subinterfaces:

IHDF5LegacyReader, IHDF5Reader, IHDF5Writer

Deprecated.

@Deprecated
public interface IHDF5EnumBasicReader

An interface with legacy methods for reading enumeration values from HDF5 files. Do not use in any new code as it will be removed in a future version of JHDF5.

Method Summary

Methods

Modifier and Type	Method and Description
HDF5EnumerationType	getDataSetEnumType(java.lang.String dataSetPath) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
HDF5EnumerationValueArray	getEnumArrayAttribute(java.lang.String objectPath, java.lang.String attributeName) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
java.lang.String[]	getEnumArrayAttributeAsString(java.lang.String objectPath, java.lang.String attributeName) Deprecated. Use getEnumArrayAttribute(String, String) instead and call HDF5EnumerationValueArray.toStringArray().
java.lang.Iterable<HDF5DataBlock<HDF5EnumerationValueArray>>	getEnumArrayNaturalBlocks(java.lang.String objectPath) Deprecated. Use the corresponding method in IHDF5LegacyReader.enums() instead.
java.lang.Iterable<HDF5DataBlock<HDF5EnumerationValueArray>>	getEnumArrayNaturalBlocks(java.lang.String objectPath, HDF5EnumerationType enumType) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
HDF5EnumerationValue	getEnumAttribute(java.lang.String objectPath, java.lang.String attributeName) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
<T extends java.lang.Enum<T>> T	getEnumAttribute(java.lang.String objectPath, java.lang.String attributeName, java.lang.Class<T> enumClass) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
java.lang.String	getEnumAttributeAsString(java.lang.String objectPath, java.lang.String attributeName) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
HDF5EnumerationType	getEnumType(java.lang.String dataTypeName) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
HDF5EnumerationType	getEnumType(java.lang.String dataTypeName, java.lang.String[] values) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
HDF5EnumerationType	getEnumType(java.lang.String dataTypeName, java.lang.String[] values, boolean check) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
HDF5EnumerationType	getEnumTypeForObject(java.lang.String dataSetPath) Deprecated. Use getDataSetEnumType(String) instead.
HDF5EnumerationValue	readEnum(java.lang.String objectPath) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
<T extends java.lang.Enum<T>> T	readEnum(java.lang.String objectPath, java.lang.Class<T> enumClass) Deprecated. Reads an Enum value from the data set objectPath.
HDF5EnumerationValue	readEnum(java.lang.String objectPath, HDF5EnumerationType enumType) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
HDF5EnumerationValueArray	readEnumArray(java.lang.String objectPath) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
<T extends java.lang.Enum<T>> T[]	readEnumArray(java.lang.String objectPath, java.lang.Class<T> enumClass) Deprecated. Reads an Enum value array from the data set objectPath.
HDF5EnumerationValueArray	readEnumArray(java.lang.String objectPath, HDF5EnumerationType enumType) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
java.lang.String[]	readEnumArrayAsString(java.lang.String objectPath) Deprecated. Reads an Enum array (of rank 1) from the data set objectPath.
HDF5EnumerationValueArray	readEnumArrayBlock(java.lang.String objectPath, HDF5EnumerationType enumType, int blockSize, long blockNumber) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
HDF5EnumerationValueArray	readEnumArrayBlock(java.lang.String objectPath, int blockSize, long blockNumber) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
HDF5EnumerationValueArray	readEnumArrayBlockWithOffset(java.lang.String objectPath, HDF5EnumerationType enumType, int blockSize, long offset) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
HDF5EnumerationValueArray	readEnumArrayBlockWithOffset(java.lang.String objectPath, int blockSize, long offset) Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.
java.lang.String	readEnumAsString(java.lang.String objectPath) Deprecated. Reads an Enum value from the data set objectPath.

Method Detail

getEnumType

@Deprecated
HDF5EnumerationType getEnumType(java.lang.String dataTypeName)

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

Returns the enumeration type name for this HDF5 file. Use this method only when you know that the type exists. If the dataTypeName starts with '/', it will be considered a data type path instead of a data type name.

Parameters:

dataTypeName - The name of the enumeration in the HDF5 file.

getEnumType

@Deprecated
HDF5EnumerationType getEnumType(java.lang.String dataTypeName,
                                         java.lang.String[] values)
                                throws HDF5JavaException

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

Returns the enumeration type name for this HDF5 file. Will check the type in the file with the values. If the dataTypeName starts with '/', it will be considered a data type path instead of a data type name.

Parameters:

dataTypeName - The name of the enumeration in the HDF5 file.

values - The values of the enumeration.

Throws:

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

getEnumType

@Deprecated
HDF5EnumerationType getEnumType(java.lang.String dataTypeName,
                                         java.lang.String[] values,
                                         boolean check)
                                throws HDF5JavaException

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

Returns the enumeration type name for this HDF5 file. If the dataTypeName starts with '/', it will be considered a data type path instead of a data type name.

Parameters:

dataTypeName - The name of the enumeration in the HDF5 file.

values - The values of the enumeration.

check - If true and if the data type already exists, check whether it is compatible with the values provided.

Throws:

HDF5JavaException - If check = true, the data type exists and is not compatible with the values provided.

getEnumTypeForObject

@Deprecated
HDF5EnumerationType getEnumTypeForObject(java.lang.String dataSetPath)

Deprecated. Use getDataSetEnumType(String) instead.

Returns the enumeration type for the data set dataSetPath.

Parameters:

dataSetPath - The name of data set to get the enumeration type for.

getDataSetEnumType

@Deprecated
HDF5EnumerationType getDataSetEnumType(java.lang.String dataSetPath)

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

Returns the enumeration type for the data set dataSetPath.

Parameters:

dataSetPath - The name of data set to get the enumeration type for.

getEnumAttributeAsString

@Deprecated
java.lang.String getEnumAttributeAsString(java.lang.String objectPath,
                                                   java.lang.String attributeName)
                                          throws HDF5JavaException

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

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.

getEnumAttribute

@Deprecated
HDF5EnumerationValue getEnumAttribute(java.lang.String objectPath,
                                               java.lang.String attributeName)
                                      throws HDF5JavaException

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

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.

getEnumAttribute

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

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

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.

getEnumArrayAttributeAsString

@Deprecated
java.lang.String[] getEnumArrayAttributeAsString(java.lang.String objectPath,
                                                          java.lang.String attributeName)
                                                 throws HDF5JavaException

Deprecated. Use getEnumArrayAttribute(String, String) instead and call HDF5EnumerationValueArray.toStringArray().

Reads an enum array 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 as Strinsg.

Throws:

HDF5JavaException - If the attribute is not an enum type.

getEnumArrayAttribute

@Deprecated
HDF5EnumerationValueArray getEnumArrayAttribute(java.lang.String objectPath,
                                                         java.lang.String attributeName)
                                                throws HDF5JavaException

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

Reads an enum array 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.

readEnumAsString

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

Deprecated.

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.

readEnum

@Deprecated
HDF5EnumerationValue readEnum(java.lang.String objectPath)
                              throws HDF5JavaException

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

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.

readEnum

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

Deprecated.

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.

readEnum

@Deprecated
HDF5EnumerationValue readEnum(java.lang.String objectPath,
                                       HDF5EnumerationType enumType)
                              throws HDF5JavaException

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

Reads an Enum value from the data set objectPath.

This method is faster than readEnum(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.

readEnumArray

@Deprecated
HDF5EnumerationValueArray readEnumArray(java.lang.String objectPath,
                                                 HDF5EnumerationType enumType)
                                        throws HDF5JavaException

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

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.

readEnumArray

@Deprecated
HDF5EnumerationValueArray readEnumArray(java.lang.String objectPath)
                                        throws HDF5JavaException

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

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.

readEnumArray

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

Deprecated.

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.

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.

readEnumArrayAsString

java.lang.String[] readEnumArrayAsString(java.lang.String objectPath)
                                         throws HDF5JavaException

Deprecated.

Reads an Enum array (of rank 1) 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 an array of Strings.

Throws:

HDF5JavaException - If the objectPath is not an enum type.

readEnumArrayBlock

@Deprecated
HDF5EnumerationValueArray readEnumArrayBlock(java.lang.String objectPath,
                                                      int blockSize,
                                                      long blockNumber)

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

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.

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

readEnumArrayBlock

@Deprecated
HDF5EnumerationValueArray readEnumArrayBlock(java.lang.String objectPath,
                                                      HDF5EnumerationType enumType,
                                                      int blockSize,
                                                      long blockNumber)

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

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.

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

readEnumArrayBlockWithOffset

@Deprecated
HDF5EnumerationValueArray readEnumArrayBlockWithOffset(java.lang.String objectPath,
                                                                int blockSize,
                                                                long offset)

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

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.

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

readEnumArrayBlockWithOffset

@Deprecated
HDF5EnumerationValueArray readEnumArrayBlockWithOffset(java.lang.String objectPath,
                                                                HDF5EnumerationType enumType,
                                                                int blockSize,
                                                                long offset)

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

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.

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

getEnumArrayNaturalBlocks

@Deprecated
java.lang.Iterable<HDF5DataBlock<HDF5EnumerationValueArray>> getEnumArrayNaturalBlocks(java.lang.String objectPath)
                                                                                       throws HDF5JavaException

Deprecated. Use the corresponding method in IHDF5LegacyReader.enums() instead.

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

getEnumArrayNaturalBlocks

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

Deprecated. Use the corresponding method in IHDF5Reader.enumeration() instead.

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