ch.systemsx.cisd.hdf5

Interface IHDF5CompoundBasicReader

All Known Subinterfaces:

IHDF5CompoundBasicWriter, IHDF5LegacyReader, IHDF5LegacyWriter, IHDF5Reader, IHDF5Writer

Deprecated.

@Deprecated
public interface IHDF5CompoundBasicReader

An interface with legacy methods for reading compound 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
<T> HDF5CompoundType<T>	getAttributeCompoundType(java.lang.String objectPath, java.lang.String attributeName, java.lang.Class<T> pojoClass) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> java.lang.Iterable<HDF5DataBlock<T[]>>	getCompoundArrayNaturalBlocks(java.lang.String objectPath, java.lang.Class<T> pojoClass) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> java.lang.Iterable<HDF5DataBlock<T[]>>	getCompoundArrayNaturalBlocks(java.lang.String objectPath, HDF5CompoundType<T> type) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> java.lang.Iterable<HDF5DataBlock<T[]>>	getCompoundArrayNaturalBlocks(java.lang.String objectPath, HDF5CompoundType<T> type, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
HDF5CompoundMemberInformation[]	getCompoundDataSetInformation(java.lang.String dataSetPath) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
HDF5CompoundMemberInformation[]	getCompoundDataSetInformation(java.lang.String dataSetPath, boolean sortAlphabetically) Deprecated. Use getCompoundDataSetInformation(String) and Arrays.sort(compoundInformation), if needed.
<T> java.lang.Iterable<HDF5MDDataBlock<MDArray<T>>>	getCompoundMDArrayNaturalBlocks(java.lang.String objectPath, java.lang.Class<T> pojoClass) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> java.lang.Iterable<HDF5MDDataBlock<MDArray<T>>>	getCompoundMDArrayNaturalBlocks(java.lang.String objectPath, HDF5CompoundType<T> type) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> java.lang.Iterable<HDF5MDDataBlock<MDArray<T>>>	getCompoundMDArrayNaturalBlocks(java.lang.String objectPath, HDF5CompoundType<T> type, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> HDF5CompoundMemberInformation[]	getCompoundMemberInformation(java.lang.Class<T> compoundClass) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
HDF5CompoundMemberInformation[]	getCompoundMemberInformation(java.lang.String dataTypeName) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> HDF5CompoundType<T>	getCompoundType(java.lang.Class<T> pojoClass, HDF5CompoundMemberMapping... members) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> HDF5CompoundType<T>	getCompoundType(java.lang.String name, java.lang.Class<T> pojoClass, HDF5CompoundMemberMapping... members) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> HDF5CompoundType<T>	getDataSetCompoundType(java.lang.String objectPath, java.lang.Class<T> pojoClass) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> HDF5CompoundType<T>	getInferredCompoundType(java.lang.Class<T> pojoClass) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
HDF5CompoundType<java.util.List<?>>	getInferredCompoundType(java.util.List<java.lang.String> memberNames, java.util.List<?> template) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
HDF5CompoundType<java.lang.Object[]>	getInferredCompoundType(java.lang.String[] memberNames, java.lang.Object[] template) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> HDF5CompoundType<T>	getInferredCompoundType(java.lang.String name, java.lang.Class<T> pojoClass) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
HDF5CompoundType<java.util.List<?>>	getInferredCompoundType(java.lang.String name, java.util.List<java.lang.String> memberNames, java.util.List<?> template) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
HDF5CompoundType<java.lang.Object[]>	getInferredCompoundType(java.lang.String name, java.lang.String[] memberNames, java.lang.Object[] template) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> HDF5CompoundType<T>	getInferredCompoundType(java.lang.String name, T template) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> HDF5CompoundType<T>	getInferredCompoundType(java.lang.String name, T template, HDF5CompoundMappingHints hints) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> HDF5CompoundType<T>	getInferredCompoundType(T template) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> HDF5CompoundType<T>	getNamedCompoundType(java.lang.Class<T> pojoClass) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> HDF5CompoundType<T>	getNamedCompoundType(java.lang.String dataTypeName, java.lang.Class<T> pojoClass) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> T	readCompound(java.lang.String objectPath, java.lang.Class<T> pojoClass) Deprecated. Reads a compound from the data set objectPath.
<T> T	readCompound(java.lang.String objectPath, HDF5CompoundType<T> type) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> T	readCompound(java.lang.String objectPath, HDF5CompoundType<T> type, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> T[]	readCompoundArray(java.lang.String objectPath, java.lang.Class<T> pojoClass) Deprecated. Reads a compound array (of rank 1) from the data set objectPath.
<T> T[]	readCompoundArray(java.lang.String objectPath, HDF5CompoundType<T> type) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> T[]	readCompoundArray(java.lang.String objectPath, HDF5CompoundType<T> type, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> T[]	readCompoundArrayBlock(java.lang.String objectPath, HDF5CompoundType<T> type, int blockSize, long blockNumber) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> T[]	readCompoundArrayBlock(java.lang.String objectPath, HDF5CompoundType<T> type, int blockSize, long blockNumber, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> T[]	readCompoundArrayBlockWithOffset(java.lang.String objectPath, HDF5CompoundType<T> type, int blockSize, long offset) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> T[]	readCompoundArrayBlockWithOffset(java.lang.String objectPath, HDF5CompoundType<T> type, int blockSize, long offset, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> MDArray<T>	readCompoundMDArray(java.lang.String objectPath, java.lang.Class<T> pojoClass) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> MDArray<T>	readCompoundMDArray(java.lang.String objectPath, HDF5CompoundType<T> type) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> MDArray<T>	readCompoundMDArray(java.lang.String objectPath, HDF5CompoundType<T> type, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> MDArray<T>	readCompoundMDArrayBlock(java.lang.String objectPath, HDF5CompoundType<T> type, int[] blockDimensions, long[] blockNumber) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> MDArray<T>	readCompoundMDArrayBlock(java.lang.String objectPath, HDF5CompoundType<T> type, int[] blockDimensions, long[] blockNumber, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> MDArray<T>	readCompoundMDArrayBlockWithOffset(java.lang.String objectPath, HDF5CompoundType<T> type, int[] blockDimensions, long[] offset) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.
<T> MDArray<T>	readCompoundMDArrayBlockWithOffset(java.lang.String objectPath, HDF5CompoundType<T> type, int[] blockDimensions, long[] offset, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Deprecated. Use the corresponding method in IHDF5Reader.compound() instead.

Method Detail

getCompoundMemberInformation

@Deprecated
<T> HDF5CompoundMemberInformation[] getCompoundMemberInformation(java.lang.Class<T> compoundClass)

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

Returns the member information for the committed compound data type compoundClass (using its "simple name") in the order that the members appear in the compound type. It is a failure condition if this compound data type does not exist.

getCompoundMemberInformation

@Deprecated
HDF5CompoundMemberInformation[] getCompoundMemberInformation(java.lang.String dataTypeName)

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

Returns the member information for the committed compound data type dataTypeName in the order that the members appear in the compound type. It is a failure condition if this compound data type does not exist. 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 compound data type to get the member information for.

getCompoundDataSetInformation

@Deprecated
HDF5CompoundMemberInformation[] getCompoundDataSetInformation(java.lang.String dataSetPath)
                                                              throws HDF5JavaException

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

Returns the compound member information for the data set dataSetPath in the order that the members appear in the compound type. It is a failure condition if this data set does not exist or is not of compound type.

Call Arrays.sort(compoundInformation) to sort the array in alphabetical order of names.

Throws:

HDF5JavaException - If the data set is not of compound type.

getCompoundDataSetInformation

@Deprecated
HDF5CompoundMemberInformation[] getCompoundDataSetInformation(java.lang.String dataSetPath,
                                                                       boolean sortAlphabetically)
                                                              throws HDF5JavaException

Deprecated. Use getCompoundDataSetInformation(String) and Arrays.sort(compoundInformation), if needed.

Returns the compound member information for the data set dataSetPath in the order that the members appear in the compound type. The returned array will contain the members in alphabetical order, if sortAlphabetically is true or else in the order of definition of the compound type. It is a failure condition if this data set does not exist or is not of compound type.

Throws:

HDF5JavaException - If the data set is not of type compound.

getCompoundType

@Deprecated
<T> HDF5CompoundType<T> getCompoundType(java.lang.String name,
                                                 java.lang.Class<T> pojoClass,
                                                 HDF5CompoundMemberMapping... members)

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

Returns the compound type name> for this HDF5 file.

Parameters:

name - The name of the compound in the HDF5 file.

pojoClass - The plain old Java type that corresponds to this HDF5 type.

members - The mapping from the Java compound type to the HDF5 type.

getCompoundType

@Deprecated
<T> HDF5CompoundType<T> getCompoundType(java.lang.Class<T> pojoClass,
                                                 HDF5CompoundMemberMapping... members)

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

Returns the compound type for this HDF5 file, using the default name chosen by JHDF5 which is based on the simple name of pojoClass.

Parameters:

pojoClass - The plain old Java type that corresponds to this HDF5 type.

members - The mapping from the Java compound type to the HDF5 type.

getInferredCompoundType

@Deprecated
<T> HDF5CompoundType<T> getInferredCompoundType(java.lang.String name,
                                                         java.lang.Class<T> pojoClass)

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

Returns the compound type name> for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection.

Parameters:

name - The name of the compound in the HDF5 file.

pojoClass - The plain old Java type that corresponds to this HDF5 type.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getInferredCompoundType

@Deprecated
<T> HDF5CompoundType<T> getInferredCompoundType(java.lang.Class<T> pojoClass)

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

Returns the compound type for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection and using the default name chosen by JHDF5 which is based on the simple name of pojoClass.

Parameters:

pojoClass - The plain old Java type that corresponds to this HDF5 type.

getInferredCompoundType

@Deprecated
<T> HDF5CompoundType<T> getInferredCompoundType(java.lang.String name,
                                                         T template,
                                                         HDF5CompoundMappingHints hints)

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

Returns the compound type name> for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection.

Parameters:

name - The name of the compound type in the HDF5 file.

template - The compound to infer the HDF5 compound type from.

hints - The hints to provide to the mapping procedure.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getInferredCompoundType

@Deprecated
<T> HDF5CompoundType<T> getInferredCompoundType(java.lang.String name,
                                                         T template)

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

Returns the compound type name> for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection.

Parameters:

name - The name of the compound type in the HDF5 file.

template - The compound to infer the HDF5 compound type from.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getInferredCompoundType

@Deprecated
<T> HDF5CompoundType<T> getInferredCompoundType(T template)

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

Returns the compound type for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection and using the default name chosen by JHDF5 which is based on the simple name of T.

Parameters:

template - The compound to infer the HDF5 compound type from.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getInferredCompoundType

@Deprecated
HDF5CompoundType<java.util.List<?>> getInferredCompoundType(java.lang.String name,
                                                                     java.util.List<java.lang.String> memberNames,
                                                                     java.util.List<?> template)

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

Returns the compound type for this HDF5 file, inferring the mapping from the Java types of the members.

Parameters:

name - The name of the compound type in the HDF5 file.

memberNames - The names of the members.

template - The compound to infer the HDF5 compound type from. Needs to have the same length as memberNames.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getInferredCompoundType

@Deprecated
HDF5CompoundType<java.util.List<?>> getInferredCompoundType(java.util.List<java.lang.String> memberNames,
                                                                     java.util.List<?> template)

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

Returns the compound type for this HDF5 file, inferring the mapping from the Java types of the members.

Parameters:

memberNames - The names of the members.

template - The compound to infer the HDF5 compound type from. Needs to have the same length as memberNames.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getInferredCompoundType

@Deprecated
HDF5CompoundType<java.lang.Object[]> getInferredCompoundType(java.lang.String name,
                                                                      java.lang.String[] memberNames,
                                                                      java.lang.Object[] template)

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

Returns the compound type for this HDF5 file, inferring the mapping from the Java types of the members.

Parameters:

name - The name of the compound type in the HDF5 file.

memberNames - The names of the members.

template - The compound to infer the HDF5 compound type from. Needs to have the same length than memberNames.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getInferredCompoundType

@Deprecated
HDF5CompoundType<java.lang.Object[]> getInferredCompoundType(java.lang.String[] memberNames,
                                                                      java.lang.Object[] template)

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

Returns the compound type for this HDF5 file, inferring the mapping from the Java types of the members.

Parameters:

memberNames - The names of the members.

template - The compound to infer the HDF5 compound type from. Needs to have the same length than memberNames.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getDataSetCompoundType

@Deprecated
<T> HDF5CompoundType<T> getDataSetCompoundType(java.lang.String objectPath,
                                                        java.lang.Class<T> pojoClass)

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

Returns the compound type for the given compound data set in objectPath, mapping it to pojoClass.

Parameters:

objectPath - The path of the compound dataset to get the type from.

pojoClass - The class to use for the mapping.

getAttributeCompoundType

@Deprecated
<T> HDF5CompoundType<T> getAttributeCompoundType(java.lang.String objectPath,
                                                          java.lang.String attributeName,
                                                          java.lang.Class<T> pojoClass)

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

Returns the compound type for the given compound attribute in attributeName of objectPath, mapping it to pojoClass.

Parameters:

objectPath - The path of the compound dataset to get the type from.

pojoClass - The class to use for the mapping.

getNamedCompoundType

@Deprecated
<T> HDF5CompoundType<T> getNamedCompoundType(java.lang.String dataTypeName,
                                                      java.lang.Class<T> pojoClass)

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

Returns the named compound type with name dataTypeName from file, mapping it to pojoClass. If the dataTypeName starts with '/', it will be considered a data type path instead of a data type name.

Note: This method only works for compound data types 'committed' to the HDF5 file. For files written with JHDF5 this will always be true, however, files created with other libraries may not choose to commit compound data types.

Parameters:

dataTypeName - The path to a committed data type, if starting with '/', or a name of a committed data type otherwise.

pojoClass - The class to use for the mapping.

Returns:

The compound data type.

getNamedCompoundType

@Deprecated
<T> HDF5CompoundType<T> getNamedCompoundType(java.lang.Class<T> pojoClass)

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

Returns the named compound type with name dataTypeName from file, mapping it to pojoClass. This method will use the default name for the compound data type as chosen by JHDF5 and thus will likely only work on files written with JHDF5. The default name is based on the simple name of compoundType.

Parameters:

pojoClass - The class to use for the mapping and to get the name of named data type from.

Returns:

The compound data type.

readCompound

@Deprecated
<T> T readCompound(java.lang.String objectPath,
                            HDF5CompoundType<T> type)
               throws HDF5JavaException

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

Reads a compound 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 compound type.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a compound data set.

readCompound

<T> T readCompound(java.lang.String objectPath,
                 java.lang.Class<T> pojoClass)
               throws HDF5JavaException

Deprecated.

Reads a compound from the data set objectPath.

Parameters:

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

pojoClass - The class to return the result in. Use HDF5CompoundDataMap to get it in a map, HDF5CompoundDataList to get it in a list, and Object[] to get it in an array, or use a pojo (Data Transfer Object), in which case the compound members will be mapped to Java fields.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a compound data set or if the mapping between the compound type and the POJO is not complete.

See Also:

CompoundType, CompoundElement

readCompound

@Deprecated
<T> T readCompound(java.lang.String objectPath,
                            HDF5CompoundType<T> type,
                            IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)
               throws HDF5JavaException

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

Reads a compound 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 compound type.

inspectorOrNull - The inspector to be called before the byte array read from the HDF5 file is translated back into a Java object.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a compound data set.

readCompoundArray

@Deprecated
<T> T[] readCompoundArray(java.lang.String objectPath,
                                   HDF5CompoundType<T> type)
                      throws HDF5JavaException

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

Reads a compound array (of rank 1) 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 compound type.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a compound data set.

readCompoundArray

@Deprecated
<T> T[] readCompoundArray(java.lang.String objectPath,
                                   HDF5CompoundType<T> type,
                                   IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)
                      throws HDF5JavaException

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

Reads a compound array (of rank 1) 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 compound type.

inspectorOrNull - The inspector to be called before the byte array read from the HDF5 file is translated back into Java objects.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a compound data set.

readCompoundArray

<T> T[] readCompoundArray(java.lang.String objectPath,
                        java.lang.Class<T> pojoClass)
                      throws HDF5JavaException

Deprecated.

Reads a compound array (of rank 1) from the data set objectPath.

Parameters:

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

pojoClass - The class to return the result in. Use HDF5CompoundDataMap to get it in a map, HDF5CompoundDataList to get it in a list, and Object[] to get it in an array, or use a pojo (Data Transfer Object), in which case the compound members will be mapped to Java fields.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a compound data set or if the mapping between the compound type and the POJO is not complete.

See Also:

CompoundType, CompoundElement

readCompoundArrayBlock

@Deprecated
<T> T[] readCompoundArrayBlock(java.lang.String objectPath,
                                        HDF5CompoundType<T> type,
                                        int blockSize,
                                        long blockNumber)
                           throws HDF5JavaException

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

Reads a compound array (of rank 1) 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 compound type.

blockSize - The block size (this will be the length of the float[] 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.

Throws:

HDF5JavaException - If the objectPath is not a compound data set.

readCompoundArrayBlock

@Deprecated
<T> T[] readCompoundArrayBlock(java.lang.String objectPath,
                                        HDF5CompoundType<T> type,
                                        int blockSize,
                                        long blockNumber,
                                        IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)
                           throws HDF5JavaException

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

Reads a compound array (of rank 1) 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 compound type.

blockSize - The block size (this will be the length of the float[] returned if the data set is long enough).

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

inspectorOrNull - The inspector to be called before the byte array read from the HDF5 file is translated back into Java objects.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a compound data set.

readCompoundArrayBlockWithOffset

@Deprecated
<T> T[] readCompoundArrayBlockWithOffset(java.lang.String objectPath,
                                                  HDF5CompoundType<T> type,
                                                  int blockSize,
                                                  long offset)
                                     throws HDF5JavaException

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

Reads a compound array (of rank 1) 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 compound type.

blockSize - The block size (this will be the length of the float[] returned if the data set is long enough).

offset - The offset of the block to read (starting with 0).

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a compound data set.

readCompoundArrayBlockWithOffset

@Deprecated
<T> T[] readCompoundArrayBlockWithOffset(java.lang.String objectPath,
                                                  HDF5CompoundType<T> type,
                                                  int blockSize,
                                                  long offset,
                                                  IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)
                                     throws HDF5JavaException

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

Reads a compound array (of rank 1) 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 compound type.

blockSize - The block size (this will be the length of the float[] returned if the data set is long enough).

offset - The offset of the block to read (starting with 0).

inspectorOrNull - The inspector to be called before the byte array read from the HDF5 file is translated back into Java objects.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a compound data set.

getCompoundArrayNaturalBlocks

@Deprecated
<T> java.lang.Iterable<HDF5DataBlock<T[]>> getCompoundArrayNaturalBlocks(java.lang.String objectPath,
                                                                                  HDF5CompoundType<T> type)
                                                                     throws HDF5JavaException

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

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

Parameters:

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

type - The type definition of this compound type.

Throws:

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

See Also:

HDF5DataBlock

getCompoundArrayNaturalBlocks

@Deprecated
<T> java.lang.Iterable<HDF5DataBlock<T[]>> getCompoundArrayNaturalBlocks(java.lang.String objectPath,
                                                                                  HDF5CompoundType<T> type,
                                                                                  IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)
                                                                     throws HDF5JavaException

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

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

Parameters:

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

type - The type definition of this compound type.

inspectorOrNull - The inspector to be called before the byte array read from the HDF5 file is translated back into Java objects.

Throws:

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

See Also:

HDF5DataBlock

getCompoundArrayNaturalBlocks

@Deprecated
<T> java.lang.Iterable<HDF5DataBlock<T[]>> getCompoundArrayNaturalBlocks(java.lang.String objectPath,
                                                                                  java.lang.Class<T> pojoClass)
                                                                     throws HDF5JavaException

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

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

Parameters:

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

pojoClass - The class to return the result in. Use HDF5CompoundDataMap to get it in a map, HDF5CompoundDataList to get it in a list, and Object[] to get it in an array, or use a pojo (Data Transfer Object), in which case the compound members will be mapped to Java fields.

Throws:

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

HDF5JavaException - If the data set is not of rank 1, not a compound data set or if the mapping between the compound type and the POJO is not complete.

See Also:

HDF5DataBlock

readCompoundMDArray

@Deprecated
<T> MDArray<T> readCompoundMDArray(java.lang.String objectPath,
                                            HDF5CompoundType<T> type)
                               throws HDF5JavaException

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

Reads a compound array 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 compound type.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a compound data set.

readCompoundMDArray

@Deprecated
<T> MDArray<T> readCompoundMDArray(java.lang.String objectPath,
                                            java.lang.Class<T> pojoClass)
                               throws HDF5JavaException

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

Reads a compound array from the data set objectPath.

Parameters:

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

pojoClass - The class to return the result in. Use HDF5CompoundDataMap to get it in a map, HDF5CompoundDataList to get it in a list, and Object[] to get it in an array, or use a pojo (Data Transfer Object), in which case the compound members will be mapped to Java fields.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a compound data set or if the mapping between the compound type and the POJO is not complete.

See Also:

CompoundType, CompoundElement

readCompoundMDArray

@Deprecated
<T> MDArray<T> readCompoundMDArray(java.lang.String objectPath,
                                            HDF5CompoundType<T> type,
                                            IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)
                               throws HDF5JavaException

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

Reads a compound array 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 compound type.

inspectorOrNull - The inspector to be called before the byte array read from the HDF5 file is translated back into Java objects.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a compound data set.

readCompoundMDArrayBlock

@Deprecated
<T> MDArray<T> readCompoundMDArrayBlock(java.lang.String objectPath,
                                                 HDF5CompoundType<T> type,
                                                 int[] blockDimensions,
                                                 long[] blockNumber)
                                    throws HDF5JavaException

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

Reads a block from a compound array 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 compound 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 a compound data set.

readCompoundMDArrayBlock

@Deprecated
<T> MDArray<T> readCompoundMDArrayBlock(java.lang.String objectPath,
                                                 HDF5CompoundType<T> type,
                                                 int[] blockDimensions,
                                                 long[] blockNumber,
                                                 IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)
                                    throws HDF5JavaException

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

Reads a block from a compound array 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 compound type.

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

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

inspectorOrNull - The inspector to be called before the byte array read from the HDF5 file is translated back into Java objects.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a compound type.

readCompoundMDArrayBlockWithOffset

@Deprecated
<T> MDArray<T> readCompoundMDArrayBlockWithOffset(java.lang.String objectPath,
                                                           HDF5CompoundType<T> type,
                                                           int[] blockDimensions,
                                                           long[] offset)
                                              throws HDF5JavaException

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

Reads a block from a compound array 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 compound 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 a compound data set.

readCompoundMDArrayBlockWithOffset

@Deprecated
<T> MDArray<T> readCompoundMDArrayBlockWithOffset(java.lang.String objectPath,
                                                           HDF5CompoundType<T> type,
                                                           int[] blockDimensions,
                                                           long[] offset,
                                                           IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)
                                              throws HDF5JavaException

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

Reads a block from a compound array 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 compound 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.

inspectorOrNull - The inspector to be called before the byte array read from the HDF5 file is translated back into Java objects.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a compound data set.

getCompoundMDArrayNaturalBlocks

@Deprecated
<T> java.lang.Iterable<HDF5MDDataBlock<MDArray<T>>> getCompoundMDArrayNaturalBlocks(java.lang.String objectPath,
                                                                                             HDF5CompoundType<T> type)
                                                                                throws HDF5JavaException

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

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 compound type.

Throws:

HDF5JavaException

See Also:

HDF5MDDataBlock

getCompoundMDArrayNaturalBlocks

@Deprecated
<T> java.lang.Iterable<HDF5MDDataBlock<MDArray<T>>> getCompoundMDArrayNaturalBlocks(java.lang.String objectPath,
                                                                                             HDF5CompoundType<T> type,
                                                                                             IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)
                                                                                throws HDF5JavaException

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

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 compound type.

inspectorOrNull - The inspector to be called before the byte array read from the HDF5 file is translated back into Java objects.

Throws:

HDF5JavaException

See Also:

HDF5MDDataBlock

getCompoundMDArrayNaturalBlocks

@Deprecated
<T> java.lang.Iterable<HDF5MDDataBlock<MDArray<T>>> getCompoundMDArrayNaturalBlocks(java.lang.String objectPath,
                                                                                             java.lang.Class<T> pojoClass)
                                                                                throws HDF5JavaException

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

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

Parameters:

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

pojoClass - The class to return the result in. Use HDF5CompoundDataMap to get it in a map, HDF5CompoundDataList to get it in a list, and Object[] to get it in an array.

Throws:

HDF5JavaException - If the data set is not a compound data set or if the mapping between the compound type and the POJO is not complete.

See Also:

HDF5DataBlock, CompoundType, CompoundElement