ch.systemsx.cisd.hdf5

Interface IHDF5CompoundReader

All Superinterfaces:

IHDF5CompoundInformationRetriever

All Known Subinterfaces:

IHDF5CompoundWriter

public interface IHDF5CompoundReader
extends IHDF5CompoundInformationRetriever

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

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

Nested Class Summary

Nested classes/interfaces inherited from interface ch.systemsx.cisd.hdf5.IHDF5CompoundInformationRetriever

IHDF5CompoundInformationRetriever.IByteArrayInspector

Method Summary

Modifier and Type	Method and Description
<T> T[]	getArrayAttr(java.lang.String objectPath, java.lang.String attributeName, java.lang.Class<T> pojoClass) Reads a compound array (of rank 1) attribute named attributeName from the object objectPath.
<T> T[]	getArrayAttr(java.lang.String objectPath, java.lang.String attributeName, HDF5CompoundType<T> type) Reads a compound array (of rank 1) attribute named attributeName from the object objectPath.
<T> java.lang.Iterable<HDF5DataBlock<T[]>>	getArrayBlocks(java.lang.String objectPath, java.lang.Class<T> pojoClass) Provides all natural blocks of this one-dimensional data set of compounds to iterate over.
<T> java.lang.Iterable<HDF5DataBlock<T[]>>	getArrayBlocks(java.lang.String objectPath, HDF5CompoundType<T> type) Provides all natural blocks of this one-dimensional data set of compounds to iterate over.
<T> java.lang.Iterable<HDF5DataBlock<T[]>>	getArrayBlocks(java.lang.String objectPath, HDF5CompoundType<T> type, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Provides all natural blocks of this one-dimensional data set of compounds to iterate over.
<T> T	getAttr(java.lang.String objectPath, java.lang.String attributeName, java.lang.Class<T> pojoClass) Reads a compound attribute named attributeName from the object objectPath.
<T> T	getAttr(java.lang.String objectPath, java.lang.String attributeName, HDF5CompoundType<T> type) Reads a compound attribute named attributeName from the object objectPath.
<T> ch.systemsx.cisd.base.mdarray.MDArray<T>	getMDArrayAttr(java.lang.String objectPath, java.lang.String attributeName, java.lang.Class<T> pojoClass) Reads a compound array (of rank N) attribute named attributeName from the object objectPath.
<T> ch.systemsx.cisd.base.mdarray.MDArray<T>	getMDArrayAttr(java.lang.String objectPath, java.lang.String attributeName, HDF5CompoundType<T> type) Reads a compound array (of rank N) attribute named attributeName from the object objectPath.
<T> java.lang.Iterable<HDF5MDDataBlock<ch.systemsx.cisd.base.mdarray.MDArray<T>>>	getMDArrayBlocks(java.lang.String objectPath, java.lang.Class<T> pojoClass) Provides all natural blocks of this multi-dimensional data set of compounds to iterate over.
<T> java.lang.Iterable<HDF5MDDataBlock<ch.systemsx.cisd.base.mdarray.MDArray<T>>>	getMDArrayBlocks(java.lang.String objectPath, HDF5CompoundType<T> type) Provides all natural blocks of this multi-dimensional data set to iterate over.
<T> java.lang.Iterable<HDF5MDDataBlock<ch.systemsx.cisd.base.mdarray.MDArray<T>>>	getMDArrayBlocks(java.lang.String objectPath, HDF5CompoundType<T> type, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Provides all natural blocks of this multi-dimensional data set to iterate over.
<T> T	read(java.lang.String objectPath, java.lang.Class<T> pojoClass) Reads a compound from the data set objectPath.
<T> T	read(java.lang.String objectPath, HDF5CompoundType<T> type) Reads a compound from the data set objectPath.
<T> T	read(java.lang.String objectPath, HDF5CompoundType<T> type, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Reads a compound from the data set objectPath.
<T> T[]	readArray(java.lang.String objectPath, java.lang.Class<T> pojoClass) Reads a compound array (of rank 1) from the data set objectPath.
<T> T[]	readArray(java.lang.String objectPath, HDF5CompoundType<T> type) Reads a compound array (of rank 1) from the data set objectPath.
<T> T[]	readArray(java.lang.String objectPath, HDF5CompoundType<T> type, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Reads a compound array (of rank 1) from the data set objectPath.
<T> T[]	readArrayBlock(java.lang.String objectPath, HDF5CompoundType<T> type, int blockSize, long blockNumber) Reads a compound array (of rank 1) from the data set objectPath.
<T> T[]	readArrayBlock(java.lang.String objectPath, HDF5CompoundType<T> type, int blockSize, long blockNumber, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Reads a compound array (of rank 1) from the data set objectPath.
<T> T[]	readArrayBlockWithOffset(java.lang.String objectPath, HDF5CompoundType<T> type, int blockSize, long offset) Reads a compound array (of rank 1) from the data set objectPath.
<T> T[]	readArrayBlockWithOffset(java.lang.String objectPath, HDF5CompoundType<T> type, int blockSize, long offset, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Reads a compound array (of rank 1) from the data set objectPath.
<T> ch.systemsx.cisd.base.mdarray.MDArray<T>	readMDArray(java.lang.String objectPath, java.lang.Class<T> pojoClass) Reads a compound array from the data set objectPath.
<T> ch.systemsx.cisd.base.mdarray.MDArray<T>	readMDArray(java.lang.String objectPath, HDF5CompoundType<T> type) Reads a compound array from the data set objectPath.
<T> ch.systemsx.cisd.base.mdarray.MDArray<T>	readMDArray(java.lang.String objectPath, HDF5CompoundType<T> type, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Reads a compound array from the data set objectPath.
<T> ch.systemsx.cisd.base.mdarray.MDArray<T>	readMDArrayBlock(java.lang.String objectPath, HDF5CompoundType<T> type, int[] blockDimensions, long[] blockNumber) Reads a block from a compound array from the data set objectPath.
<T> ch.systemsx.cisd.base.mdarray.MDArray<T>	readMDArrayBlock(java.lang.String objectPath, HDF5CompoundType<T> type, int[] blockDimensions, long[] blockNumber, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Reads a block from a compound array from the data set objectPath.
<T> ch.systemsx.cisd.base.mdarray.MDArray<T>	readMDArrayBlockWithOffset(java.lang.String objectPath, HDF5CompoundType<T> type, int[] blockDimensions, long[] offset) Reads a block from a compound array from the data set objectPath.
<T> ch.systemsx.cisd.base.mdarray.MDArray<T>	readMDArrayBlockWithOffset(java.lang.String objectPath, HDF5CompoundType<T> type, int[] blockDimensions, long[] offset, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Reads a block from a compound array from the data set objectPath.

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

getAttributeType, getAttributeType, getAttributeType, getAttributeType, getDataSetInfo, getDataSetInfo, getDataSetType, getDataSetType, getDataSetType, getDataSetType, getDataSetType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getMemberInfo, getMemberInfo, getMemberInfo, getNamedType, getNamedType, getNamedType, getNamedType, getNamedType, getNamedType, getType, getType, getType

Method Detail

getAttr

<T> T getAttr(java.lang.String objectPath,
              java.lang.String attributeName,
              HDF5CompoundType<T> type)
       throws HDF5JavaException

Reads a compound attribute named attributeName from the object objectPath.

Parameters:

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

type - The type definition of this compound type.

Returns:

The data read from the attribute.

Throws:

HDF5JavaException - If the attributeName is not a compound attribute.

getAttr

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

Reads a compound attribute named attributeName from the object objectPath.

Parameters:

objectPath - The name (including path information) of the 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 attribute.

Throws:

HDF5JavaException - If the attributeName is not a compound attribute.

getArrayAttr

<T> T[] getArrayAttr(java.lang.String objectPath,
                     java.lang.String attributeName,
                     HDF5CompoundType<T> type)
              throws HDF5JavaException

Reads a compound array (of rank 1) attribute named attributeName from the object objectPath.

Parameters:

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

type - The type definition of this compound type.

Returns:

The data read from the attribute.

Throws:

HDF5JavaException - If the attributeName is not a compound attribute.

getArrayAttr

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

Reads a compound array (of rank 1) attribute named attributeName from the object objectPath.

Parameters:

objectPath - The name (including path information) of the 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 attribute.

Throws:

HDF5JavaException - If the attributeName is not a compound attribute.

getMDArrayAttr

<T> ch.systemsx.cisd.base.mdarray.MDArray<T> getMDArrayAttr(java.lang.String objectPath,
                                                            java.lang.String attributeName,
                                                            HDF5CompoundType<T> type)
                                                     throws HDF5JavaException

Reads a compound array (of rank N) attribute named attributeName from the object objectPath.

Parameters:

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

type - The type definition of this compound type.

Returns:

The data read from the attribute.

Throws:

HDF5JavaException - If the attributeName is not a compound attribute.

getMDArrayAttr

<T> ch.systemsx.cisd.base.mdarray.MDArray<T> getMDArrayAttr(java.lang.String objectPath,
                                                            java.lang.String attributeName,
                                                            java.lang.Class<T> pojoClass)
                                                     throws HDF5JavaException

Reads a compound array (of rank N) attribute named attributeName from the object objectPath.

Parameters:

objectPath - The name (including path information) of the 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 attribute.

Throws:

HDF5JavaException - If the attributeName is not a compound attribute.

read

<T> T read(java.lang.String objectPath,
           HDF5CompoundType<T> type)
    throws HDF5JavaException

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.

read

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

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

read

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

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.

readArray

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

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.

readArray

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

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.

readArray

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

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

readArrayBlock

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

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.

readArrayBlock

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

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.

readArrayBlockWithOffset

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

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.

readArrayBlockWithOffset

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

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.

getArrayBlocks

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

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

getArrayBlocks

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

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

getArrayBlocks

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

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

readMDArray

<T> ch.systemsx.cisd.base.mdarray.MDArray<T> readMDArray(java.lang.String objectPath,
                                                         HDF5CompoundType<T> type)
                                                  throws HDF5JavaException

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.

readMDArray

<T> ch.systemsx.cisd.base.mdarray.MDArray<T> readMDArray(java.lang.String objectPath,
                                                         java.lang.Class<T> pojoClass)
                                                  throws HDF5JavaException

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

readMDArray

<T> ch.systemsx.cisd.base.mdarray.MDArray<T> readMDArray(java.lang.String objectPath,
                                                         HDF5CompoundType<T> type,
                                                         IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)
                                                  throws HDF5JavaException

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.

readMDArrayBlock

<T> ch.systemsx.cisd.base.mdarray.MDArray<T> readMDArrayBlock(java.lang.String objectPath,
                                                              HDF5CompoundType<T> type,
                                                              int[] blockDimensions,
                                                              long[] blockNumber)
                                                       throws HDF5JavaException

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.

readMDArrayBlock

<T> ch.systemsx.cisd.base.mdarray.MDArray<T> readMDArrayBlock(java.lang.String objectPath,
                                                              HDF5CompoundType<T> type,
                                                              int[] blockDimensions,
                                                              long[] blockNumber,
                                                              IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)
                                                       throws HDF5JavaException

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.

readMDArrayBlockWithOffset

<T> ch.systemsx.cisd.base.mdarray.MDArray<T> readMDArrayBlockWithOffset(java.lang.String objectPath,
                                                                        HDF5CompoundType<T> type,
                                                                        int[] blockDimensions,
                                                                        long[] offset)
                                                                 throws HDF5JavaException

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.

readMDArrayBlockWithOffset

<T> ch.systemsx.cisd.base.mdarray.MDArray<T> readMDArrayBlockWithOffset(java.lang.String objectPath,
                                                                        HDF5CompoundType<T> type,
                                                                        int[] blockDimensions,
                                                                        long[] offset,
                                                                        IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)
                                                                 throws HDF5JavaException

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.

getMDArrayBlocks

<T> java.lang.Iterable<HDF5MDDataBlock<ch.systemsx.cisd.base.mdarray.MDArray<T>>> getMDArrayBlocks(java.lang.String objectPath,
                                                                                                   HDF5CompoundType<T> 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 compound type.

Throws:

HDF5JavaException

See Also:

HDF5MDDataBlock

getMDArrayBlocks

<T> java.lang.Iterable<HDF5MDDataBlock<ch.systemsx.cisd.base.mdarray.MDArray<T>>> getMDArrayBlocks(java.lang.String objectPath,
                                                                                                   HDF5CompoundType<T> type,
                                                                                                   IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)
                                                                                            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 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

getMDArrayBlocks

<T> java.lang.Iterable<HDF5MDDataBlock<ch.systemsx.cisd.base.mdarray.MDArray<T>>> getMDArrayBlocks(java.lang.String objectPath,
                                                                                                   java.lang.Class<T> pojoClass)
                                                                                            throws HDF5JavaException

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