ch.systemsx.cisd.hdf5

Interface IHDF5TimeDurationReader

All Known Subinterfaces:

IHDF5TimeDurationWriter

All Known Implementing Classes:

HDF5TimeDurationWriter

public interface IHDF5TimeDurationReader

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

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

Method Summary

Modifier and Type	Method and Description
HDF5TimeDurationArray	getArrayAttr(java.lang.String objectPath, java.lang.String attributeName) Reads a time duration array attribute named attributeName from the data set objectPath.
java.lang.Iterable<HDF5DataBlock<HDF5TimeDurationArray>>	getArrayNaturalBlocks(java.lang.String objectPath) Provides all natural blocks of this one-dimensional data set of time durations to iterate over.
HDF5TimeDuration	getAttr(java.lang.String objectPath, java.lang.String attributeName) Reads a time duration attribute named attributeName from the data set objectPath.
HDF5TimeDurationMDArray	getMDArrayAttr(java.lang.String objectPath, java.lang.String attributeName) Reads a multi-dimension time duration array attribute named attributeName from the data set objectPath.
java.lang.Iterable<HDF5MDDataBlock<HDF5TimeDurationMDArray>>	getMDArrayNaturalBlocks(java.lang.String dataSetPath) Provides all natural blocks of this multi-dimensional data set to iterate over.
boolean	isTimeDuration(java.lang.String objectPath) Returns true, if the data set given by objectPath is a time duration and false otherwise.
boolean	isTimeDuration(java.lang.String objectPath, java.lang.String attributeName) Returns true, if the attribute attributeName of data set objectPath is a time duration and false otherwise.
HDF5TimeDuration	read(java.lang.String objectPath) Reads a time duration value and its unit from the data set objectPath.
HDF5TimeDurationArray	readArray(java.lang.String objectPath) Reads a time duration array from the data set objectPath.
HDF5TimeDurationArray	readArrayBlock(java.lang.String objectPath, int blockSize, long blockNumber) Reads a block of a time duration array (of rank 1) from the data set objectPath.
HDF5TimeDurationArray	readArrayBlockWithOffset(java.lang.String objectPath, int blockSize, long offset) Reads a block of a time duration array (of rank 1) from the data set objectPath.
HDF5TimeDurationMDArray	readMDArray(java.lang.String objectPath) Reads a multi-dimensional array of time durations from the data set objectPath.
HDF5TimeDurationMDArray	readMDArrayBlock(java.lang.String objectPath, int[] blockDimensions, long[] blockNumber) Reads a multi-dimensional array of time durations from the data set objectPath.
HDF5TimeDurationMDArray	readMDArrayBlockWithOffset(java.lang.String objectPath, int[] blockDimensions, long[] offset) Reads a multi-dimensional array of time durations from the data set objectPath.
int[]	readToMDArrayBlockWithOffset(java.lang.String objectPath, HDF5TimeDurationMDArray array, int[] blockDimensions, long[] offset, int[] memoryOffset) Reads a block of the multi-dimensional long array data set objectPath into a given array in memory.
int[]	readToMDArrayWithOffset(java.lang.String objectPath, HDF5TimeDurationMDArray array, int[] memoryOffset) Reads a multi-dimensional array of time durations from the data set objectPath into a given array in memory.
HDF5TimeUnit	tryGetTimeUnit(java.lang.String objectPath) Returns the time unit, if the data set given by objectPath is a time duration and null otherwise.
HDF5TimeUnit	tryGetTimeUnit(java.lang.String objectPath, java.lang.String attributeName) Returns the time unit, if the attribute given by attributeName of object objectPath is a time duration and null otherwise.

Method Detail

isTimeDuration

boolean isTimeDuration(java.lang.String objectPath,
                       java.lang.String attributeName)
                throws HDF5JavaException

Returns true, if the attribute attributeName of data set objectPath is a time duration and false otherwise.

Throws:

HDF5JavaException

tryGetTimeUnit

HDF5TimeUnit tryGetTimeUnit(java.lang.String objectPath,
                            java.lang.String attributeName)
                     throws HDF5JavaException

Returns the time unit, if the attribute given by attributeName of object objectPath is a time duration and null otherwise.

Throws:

HDF5JavaException

getAttr

HDF5TimeDuration getAttr(java.lang.String objectPath,
                         java.lang.String attributeName)

Reads a time duration attribute named attributeName from the data set objectPath.

Parameters:

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

attributeName - The name of the attribute to read.

Returns:

The time duration.

Throws:

HDF5JavaException - If the objectPath is not tagged as a type variant that corresponds to a time duration.

getArrayAttr

HDF5TimeDurationArray getArrayAttr(java.lang.String objectPath,
                                   java.lang.String attributeName)

Reads a time duration array attribute named attributeName from the data set objectPath.

Parameters:

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

attributeName - The name of the attribute to read.

Returns:

The time duration.

Throws:

HDF5JavaException - If the objectPath is not tagged as a type variant that corresponds to a time duration.

getMDArrayAttr

HDF5TimeDurationMDArray getMDArrayAttr(java.lang.String objectPath,
                                       java.lang.String attributeName)

Reads a multi-dimension time duration array attribute named attributeName from the data set objectPath.

Parameters:

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

attributeName - The name of the attribute to read.

Returns:

The time duration.

Throws:

HDF5JavaException - If the objectPath is not tagged as a type variant that corresponds to a time duration.

isTimeDuration

boolean isTimeDuration(java.lang.String objectPath)
                throws HDF5JavaException

Returns true, if the data set given by objectPath is a time duration and false otherwise.

Throws:

HDF5JavaException

tryGetTimeUnit

HDF5TimeUnit tryGetTimeUnit(java.lang.String objectPath)
                     throws HDF5JavaException

Returns the time unit, if the data set given by objectPath is a time duration and null otherwise.

Throws:

HDF5JavaException

read

HDF5TimeDuration read(java.lang.String objectPath)
               throws HDF5JavaException

Reads a time duration value and its unit from the data set objectPath. It needs to be tagged as one of the type variants that indicate a time duration, for example HDF5DataTypeVariant.TIME_DURATION_SECONDS.

This tagging is done by the writer when using IHDF5SimpleWriter.writeTimeDuration(String, HDF5TimeDuration) or can be done by calling IHDF5ObjectReadWriteInfoProviderHandler.setTypeVariant(String, HDF5DataTypeVariant).

Parameters:

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

Returns:

The time duration and its unit.

Throws:

HDF5JavaException - If the objectPath is not tagged as a type variant that corresponds to a time duration.

readArray

HDF5TimeDurationArray readArray(java.lang.String objectPath)
                         throws HDF5JavaException

Reads a time duration array from the data set objectPath. It needs to be tagged as one of the type variants that indicate a time duration, for example HDF5DataTypeVariant.TIME_DURATION_SECONDS.

This tagging is done by the writer when using IHDF5SimpleWriter.writeTimeDuration(String, HDF5TimeDuration) or can be done by calling IHDF5ObjectReadWriteInfoProviderHandler.setTypeVariant(String, HDF5DataTypeVariant), most conveniantly by code like

 writer.addTypeVariant("/dataSetPath", HDF5TimeUnit.SECONDS.getTypeVariant());
 

Parameters:

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

Returns:

The time duration in seconds.

Throws:

HDF5JavaException - If the objectPath is not tagged as a type variant that corresponds to a time duration.

readArrayBlock

HDF5TimeDurationArray readArrayBlock(java.lang.String objectPath,
                                     int blockSize,
                                     long blockNumber)
                              throws HDF5JavaException

Reads a block of a time duration array (of rank 1) from the data set objectPath. It needs to be tagged as one of the type variants that indicate a time duration, for example HDF5DataTypeVariant.TIME_DURATION_SECONDS.

This tagging is done by the writer when using IHDF5SimpleWriter.writeTimeDuration(String, HDF5TimeDuration) or can be done by calling IHDF5ObjectReadWriteInfoProviderHandler.setTypeVariant(String, HDF5DataTypeVariant), most conveniently by code like

 writer.addTypeVariant("/dataSetPath", HDF5TimeUnit.SECONDS.getTypeVariant());
 

Parameters:

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

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

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

Returns:

The data read from the data set. The length will be min(size - blockSize*blockNumber, blockSize).

Throws:

HDF5JavaException - If the objectPath is not tagged as a type variant that corresponds to a time duration.

readArrayBlockWithOffset

HDF5TimeDurationArray readArrayBlockWithOffset(java.lang.String objectPath,
                                               int blockSize,
                                               long offset)
                                        throws HDF5JavaException

Reads a block of a time duration array (of rank 1) from the data set objectPath. It needs to be tagged as one of the type variants that indicate a time duration, for example HDF5DataTypeVariant.TIME_DURATION_SECONDS.

This tagging is done by the writer when using IHDF5SimpleWriter.writeTimeDuration(String, HDF5TimeDuration) or can be done by calling IHDF5ObjectReadWriteInfoProviderHandler.setTypeVariant(String, HDF5DataTypeVariant), most conveniently by code like

 writer.addTypeVariant("/dataSetPath", HDF5TimeUnit.SECONDS.getTypeVariant());
 

Parameters:

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

blockSize - The block size (this will be the length of the long[] returned).

offset - The offset of the block in the data set to start reading from (starting with 0).

Returns:

The data block read from the data set.

Throws:

HDF5JavaException - If the objectPath is not tagged as a type variant that corresponds to a time duration.

getArrayNaturalBlocks

java.lang.Iterable<HDF5DataBlock<HDF5TimeDurationArray>> getArrayNaturalBlocks(java.lang.String objectPath)
                                                                        throws HDF5JavaException

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

Parameters:

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

Throws:

HDF5JavaException - If the data set is not of a time duration data type or not of rank 1.

See Also:

HDF5DataBlock

readMDArray

HDF5TimeDurationMDArray readMDArray(java.lang.String objectPath)
                             throws HDF5JavaException

Reads a multi-dimensional array of time durations from the data set objectPath.

Parameters:

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

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not tagged as a type variant that corresponds to a time duration.

readMDArrayBlock

HDF5TimeDurationMDArray readMDArrayBlock(java.lang.String objectPath,
                                         int[] blockDimensions,
                                         long[] blockNumber)
                                  throws HDF5JavaException

Reads a multi-dimensional array of time durations from the data set objectPath.

Parameters:

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

blockDimensions - The extent of the block in each dimension.

blockNumber - The block number in each dimension (offset: multiply with the blockDimensions in the according dimension).

Returns:

The data block read from the data set.

Throws:

HDF5JavaException

readMDArrayBlockWithOffset

HDF5TimeDurationMDArray readMDArrayBlockWithOffset(java.lang.String objectPath,
                                                   int[] blockDimensions,
                                                   long[] offset)

Reads a multi-dimensional array of time durations from the data set objectPath.

Parameters:

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

blockDimensions - The extent of the block in each dimension.

offset - The offset in the data set to start reading from in each dimension.

Returns:

The data block read from the data set.

readToMDArrayWithOffset

int[] readToMDArrayWithOffset(java.lang.String objectPath,
                              HDF5TimeDurationMDArray array,
                              int[] memoryOffset)

Reads a multi-dimensional array of time durations from the data set objectPath into a given array in memory.

Parameters:

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

array - The array to read the data into.

memoryOffset - The offset in the array to write the data to.

Returns:

The effective dimensions of the block in array that was filled.

readToMDArrayBlockWithOffset

int[] readToMDArrayBlockWithOffset(java.lang.String objectPath,
                                   HDF5TimeDurationMDArray array,
                                   int[] blockDimensions,
                                   long[] offset,
                                   int[] memoryOffset)

Reads a block of the multi-dimensional long array data set objectPath into a given array in memory.

Parameters:

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

array - The array to read the data into.

blockDimensions - The size of the block to read along each axis.

offset - The offset of the block in the data set.

memoryOffset - The offset of the block in the array to write the data to.

Returns:

The effective dimensions of the block in array that was filled.

getMDArrayNaturalBlocks

java.lang.Iterable<HDF5MDDataBlock<HDF5TimeDurationMDArray>> getMDArrayNaturalBlocks(java.lang.String dataSetPath)

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

See Also:

HDF5MDDataBlock