ch.systemsx.cisd.hdf5

Interface IHDF5EnumTypeRetriever

All Known Subinterfaces:

IHDF5EnumReader, IHDF5EnumWriter

public interface IHDF5EnumTypeRetriever

An interface for retrieving HDF5 enum types. Depending on whether it is reader or a writer that implements it, non-existing enum types may be created by calling the methods of this interface or an exception may be thrown.

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

Method Summary

Modifier and Type	Method and Description
HDF5EnumerationType	getAttributeType(java.lang.String dataSetPath, java.lang.String attributeName) Returns the enumeration type for the data set dataSetPath.
HDF5EnumerationType	getDataSetType(java.lang.String dataSetPath) Returns the enumeration type for the data set dataSetPath.
HDF5EnumerationType	getType(java.lang.Class<? extends java.lang.Enum<?>> enumClass, boolean check) Returns the enumeration type name for this HDF5 file.
<T extends java.lang.Enum<?>> HDF5EnumerationType	getType(java.lang.Class<T> enumClass) Returns the enumeration type name for this HDF5 file.
HDF5EnumerationType	getType(EnumerationType genericType) Returns the enumeration type name for this HDF5 file.
HDF5EnumerationType	getType(EnumerationType genericType, boolean check) Returns the enumeration type name for this HDF5 file.
HDF5EnumerationType	getType(java.lang.String dataTypeName) Returns the enumeration type name for this HDF5 file.
HDF5EnumerationType	getType(java.lang.String dataTypeName, java.lang.Class<? extends java.lang.Enum<?>> enumClass) Returns the enumeration type name for this HDF5 file.
<T extends java.lang.Enum<?>> HDF5EnumerationType	getType(java.lang.String dataTypeName, java.lang.Class<T> enumClass, boolean check) Returns the enumeration type name for this HDF5 file.
HDF5EnumerationType	getType(java.lang.String dataTypeName, java.lang.String[] values) Returns the enumeration type name for this HDF5 file.
HDF5EnumerationType	getType(java.lang.String dataTypeName, java.lang.String[] values, boolean check) Returns the enumeration type name for this HDF5 file.

Method Detail

getType

HDF5EnumerationType getType(java.lang.String dataTypeName)

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.

getDataSetType

HDF5EnumerationType getDataSetType(java.lang.String dataSetPath)

Returns the enumeration type for the data set dataSetPath.

Parameters:

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

getAttributeType

HDF5EnumerationType getAttributeType(java.lang.String dataSetPath,
                                     java.lang.String attributeName)

Returns the enumeration type for the data set dataSetPath.

Parameters:

dataSetPath - The name of data set.

attributeName - The name of the attribute to get the type for.

getType

HDF5EnumerationType getType(java.lang.String dataTypeName,
                            java.lang.String[] values)
                     throws HDF5JavaException

Returns the enumeration type name for this HDF5 file. If the type is read from the file, it 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.

getType

HDF5EnumerationType getType(EnumerationType genericType)
                     throws HDF5JavaException

Returns the enumeration type name for this HDF5 file. If the type is read from the file, it 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:

genericType - The generic enum type (independent of this file).

Throws:

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

getType

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

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.

getType

HDF5EnumerationType getType(EnumerationType genericType,
                            boolean check)
                     throws HDF5JavaException

Returns the enumeration type name for this HDF5 file. If the type is read from the file, it 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:

genericType - The generic enum type (independent of this file).

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.

getType

HDF5EnumerationType getType(java.lang.String dataTypeName,
                            java.lang.Class<? extends java.lang.Enum<?>> enumClass)
                     throws HDF5JavaException

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.

enumClass - The enumeration class to get the values from.

Throws:

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

getType

<T extends java.lang.Enum<?>> HDF5EnumerationType getType(java.lang.String dataTypeName,
                                                          java.lang.Class<T> enumClass,
                                                          boolean check)
                                                   throws HDF5JavaException

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.

enumClass - The enumeration class to get the values from.

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

Throws:

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

getType

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

Returns the enumeration type name for this HDF5 file. Will check the type in the file with the values. Will use the simple class name of enumClass as the data type name.

Parameters:

enumClass - The enumeration class to get the values from.

Throws:

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

getType

HDF5EnumerationType getType(java.lang.Class<? extends java.lang.Enum<?>> enumClass,
                            boolean check)
                     throws HDF5JavaException

Returns the enumeration type name for this HDF5 file. Will check the type in the file with the values. Will use the simple class name of enumClass as the data type name.

Parameters:

enumClass - The enumeration class to get the values from.

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

Throws:

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