ch.systemsx.cisd.hdf5

Interface IHDF5EnumBasicWriter

All Known Subinterfaces:

IHDF5LegacyWriter, IHDF5Writer

Deprecated.

@Deprecated
public interface IHDF5EnumBasicWriter

An interface with legacy methods for writing 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	createEnumArray(java.lang.String objectPath, HDF5EnumerationType enumType, int size) Deprecated. Use the corresponding method in IHDF5Writer.enumeration() instead.
HDF5EnumerationType	createEnumArray(java.lang.String objectPath, HDF5EnumerationType enumType, long size, HDF5IntStorageFeatures features) Deprecated. Use the corresponding method in IHDF5Writer.enumeration() instead.
HDF5EnumerationType	createEnumArray(java.lang.String objectPath, HDF5EnumerationType enumType, long size, int blockSize) Deprecated. Use the corresponding method in IHDF5Writer.enumeration() instead.
HDF5EnumerationType	createEnumArray(java.lang.String objectPath, HDF5EnumerationType enumType, long size, int blockSize, HDF5IntStorageFeatures features) Deprecated. Use the corresponding method in IHDF5Writer.enumeration() instead.
HDF5EnumerationType	getEnumType(java.lang.String dataTypeName, java.lang.String[] values) Deprecated. Use the corresponding method in IHDF5Writer.enumeration() instead.
HDF5EnumerationType	getEnumType(java.lang.String dataTypeName, java.lang.String[] values, boolean check) Deprecated. Use the corresponding method in IHDF5Writer.enumeration() instead.
void	setEnumArrayAttribute(java.lang.String objectPath, java.lang.String name, HDF5EnumerationValueArray value) Deprecated. Use the corresponding method in IHDF5Writer.enumeration() instead.
void	setEnumAttribute(java.lang.String objectPath, java.lang.String name, java.lang.Enum<?> value) Deprecated. Use the corresponding method in IHDF5Writer.enumeration() instead.
void	setEnumAttribute(java.lang.String objectPath, java.lang.String name, HDF5EnumerationValue value) Deprecated. Use the corresponding method in IHDF5Writer.enumeration() instead.
<T extends java.lang.Enum<T>> void	writeEnum(java.lang.String objectPath, java.lang.Enum<T> value) Deprecated. Writes out an enum value.
void	writeEnum(java.lang.String objectPath, HDF5EnumerationValue value) Deprecated. Use the corresponding method in IHDF5Writer.enumeration() instead.
void	writeEnum(java.lang.String objectPath, java.lang.String[] options, java.lang.String value) Deprecated. Writes out an enum value.
<T extends java.lang.Enum<T>> void	writeEnumArray(java.lang.String objectPath, java.lang.Enum<T>[] data) Deprecated. Writes out an array of enum values.
void	writeEnumArray(java.lang.String objectPath, HDF5EnumerationValueArray data) Deprecated. Use the corresponding method in IHDF5Writer.enumeration() instead.
void	writeEnumArray(java.lang.String objectPath, HDF5EnumerationValueArray data, HDF5IntStorageFeatures features) Deprecated. Use the corresponding method in IHDF5Writer.enumeration() instead.
void	writeEnumArray(java.lang.String objectPath, java.lang.String[] options, java.lang.String[] data) Deprecated. Writes out an array of enum values.
void	writeEnumArrayBlock(java.lang.String objectPath, HDF5EnumerationValueArray data, long blockNumber) Deprecated. Use the corresponding method in IHDF5Writer.enumeration() instead.
void	writeEnumArrayBlockWithOffset(java.lang.String objectPath, HDF5EnumerationValueArray data, int dataSize, long offset) Deprecated. Use the corresponding method in IHDF5Writer.enumeration() instead.

Method Detail

getEnumType

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

Deprecated. Use the corresponding method in IHDF5Writer.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 IHDF5Writer.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.

setEnumAttribute

@Deprecated
void setEnumAttribute(java.lang.String objectPath,
                               java.lang.String name,
                               HDF5EnumerationValue value)

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

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.

setEnumAttribute

@Deprecated
void setEnumAttribute(java.lang.String objectPath,
                               java.lang.String name,
                               java.lang.Enum<?> value)

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

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.

setEnumArrayAttribute

@Deprecated
void setEnumArrayAttribute(java.lang.String objectPath,
                                    java.lang.String name,
                                    HDF5EnumerationValueArray value)

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

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

writeEnum

@Deprecated
void writeEnum(java.lang.String objectPath,
                        HDF5EnumerationValue value)

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

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.

writeEnum

<T extends java.lang.Enum<T>> void writeEnum(java.lang.String objectPath,
                                           java.lang.Enum<T> value)

Deprecated.

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.

writeEnum

void writeEnum(java.lang.String objectPath,
             java.lang.String[] options,
             java.lang.String value)

Deprecated.

Writes out an enum value.

Parameters:

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

options - The allowed values of the enumeration type.

value - The value of the data set.

writeEnumArray

@Deprecated
void writeEnumArray(java.lang.String objectPath,
                             HDF5EnumerationValueArray data)

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

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.

writeEnumArray

<T extends java.lang.Enum<T>> void writeEnumArray(java.lang.String objectPath,
                                                java.lang.Enum<T>[] data)

Deprecated.

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.

writeEnumArray

void writeEnumArray(java.lang.String objectPath,
                  java.lang.String[] options,
                  java.lang.String[] data)

Deprecated.

Writes out an array of enum values.

Parameters:

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

options - The allowed values of the enumeration type.

data - The data to write.

writeEnumArray

@Deprecated
void writeEnumArray(java.lang.String objectPath,
                             HDF5EnumerationValueArray data,
                             HDF5IntStorageFeatures features)

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

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.

createEnumArray

@Deprecated
HDF5EnumerationType createEnumArray(java.lang.String objectPath,
                                             HDF5EnumerationType enumType,
                                             int size)

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

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

createEnumArray

@Deprecated
HDF5EnumerationType createEnumArray(java.lang.String objectPath,
                                             HDF5EnumerationType enumType,
                                             long size,
                                             int blockSize)

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

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

createEnumArray

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

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

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.

createEnumArray

@Deprecated
HDF5EnumerationType createEnumArray(java.lang.String objectPath,
                                             HDF5EnumerationType enumType,
                                             long size,
                                             HDF5IntStorageFeatures features)

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

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.

writeEnumArrayBlock

@Deprecated
void writeEnumArrayBlock(java.lang.String objectPath,
                                  HDF5EnumerationValueArray data,
                                  long blockNumber)

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

Writes out a block of an enum array (of rank 1). The data set needs to have been created by createEnumArray(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 createEnumArray(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.

writeEnumArrayBlockWithOffset

@Deprecated
void writeEnumArrayBlockWithOffset(java.lang.String objectPath,
                                            HDF5EnumerationValueArray data,
                                            int dataSize,
                                            long offset)

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

Writes out a block of an enum array (of rank 1). The data set needs to have been created by createEnumArray(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 createEnumArray(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.