ch.systemsx.cisd.hdf5

Interface IHDF5DateTimeReader

All Known Subinterfaces:

IHDF5DateTimeWriter

All Known Implementing Classes:

HDF5DateTimeWriter

public interface IHDF5DateTimeReader

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

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

Method Summary

Modifier and Type	Method and Description
java.util.Date[]	getArrayAttr(java.lang.String objectPath, java.lang.String attributeName) Reads a time stamp array attribute named attributeName from the data set objectPath and returns it as a Date[].
long[]	getArrayAttrAsLong(java.lang.String objectPath, java.lang.String attributeName) Reads a time stamp array attribute named attributeName from the data set objectPath.
java.util.Date	getAttr(java.lang.String objectPath, java.lang.String attributeName) Reads a time stamp attribute named attributeName from the data set objectPath and returns it as a Date.
long	getAttrAsLong(java.lang.String objectPath, java.lang.String attributeName) Reads a time stamp attribute named attributeName from the data set objectPath.
java.lang.Iterable<HDF5DataBlock<java.util.Date[]>>	getDateArrayNaturalBlocks(java.lang.String dataSetPath) Provides all natural blocks of this one-dimensional data set of Dates to iterate over.
java.lang.Iterable<HDF5MDDataBlock<ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date>>>	getDateMDArrayNaturalBlocks(java.lang.String dataSetPath) Provides all natural blocks of this multi-dimensional data set to iterate over.
ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date>	getMDArrayAttr(java.lang.String objectPath, java.lang.String attributeName) Reads a multi-dimension time stamp array attribute named attributeName from the data set objectPath.
ch.systemsx.cisd.base.mdarray.MDLongArray	getMDArrayAttrAsLong(java.lang.String objectPath, java.lang.String attributeName) Reads a multi-dimension time stamp array attribute named attributeName from the data set objectPath.
java.lang.Iterable<HDF5DataBlock<long[]>>	getTimeStampArrayNaturalBlocks(java.lang.String dataSetPath) Provides all natural blocks of this one-dimensional data set of time stamps to iterate over.
java.lang.Iterable<HDF5MDDataBlock<ch.systemsx.cisd.base.mdarray.MDLongArray>>	getTimeStampMDArrayNaturalBlocks(java.lang.String dataSetPath) Provides all natural blocks of this multi-dimensional data set to iterate over.
boolean	isTimeStamp(java.lang.String objectPath) Returns true, if the data set given by objectPath is a time stamp and false otherwise.
boolean	isTimeStamp(java.lang.String objectPath, java.lang.String attributeName) Returns true, if the attribute attributeName of data set objectPath is a time stamp and false otherwise.
java.util.Date	readDate(java.lang.String objectPath) Reads a time stamp value from the data set objectPath and returns it as a Date.
java.util.Date[]	readDateArray(java.lang.String objectPath) Reads a time stamp array (of rank 1) from the data set objectPath and returns it as an array of Dates.
java.util.Date[]	readDateArrayBlock(java.lang.String objectPath, int blockSize, long blockNumber) Reads a block of a Date array (of rank 1) from the data set objectPath.
java.util.Date[]	readDateArrayBlockWithOffset(java.lang.String objectPath, int blockSize, long offset) Reads a block of a Date array (of rank 1) from the data set objectPath.
ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date>	readDateMDArray(java.lang.String objectPath) Reads a multi-dimensional array of Dates from the data set objectPath.
ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date>	readDateMDArrayBlock(java.lang.String objectPath, int[] blockDimensions, long[] blockNumber) Reads a multi-dimensional array of Dates from the data set objectPath.
ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date>	readDateMDArrayBlockWithOffset(java.lang.String objectPath, int[] blockDimensions, long[] offset) Reads a multi-dimensional array of Dates from the data set objectPath.
long	readTimeStamp(java.lang.String objectPath) Reads a time stamp value from the data set objectPath.
long[]	readTimeStampArray(java.lang.String objectPath) Reads a time stamp array from the data set objectPath.
long[]	readTimeStampArrayBlock(java.lang.String objectPath, int blockSize, long blockNumber) Reads a block of a time stamp array (of rank 1) from the data set objectPath.
long[]	readTimeStampArrayBlockWithOffset(java.lang.String objectPath, int blockSize, long offset) Reads a block of a time stamp array (of rank 1) from the data set objectPath.
ch.systemsx.cisd.base.mdarray.MDLongArray	readTimeStampMDArray(java.lang.String objectPath) Reads a multi-dimensional array of time stamps from the data set objectPath.
ch.systemsx.cisd.base.mdarray.MDLongArray	readTimeStampMDArrayBlock(java.lang.String objectPath, int[] blockDimensions, long[] blockNumber) Reads a multi-dimensional array of time stamps from the data set objectPath.
ch.systemsx.cisd.base.mdarray.MDLongArray	readTimeStampMDArrayBlockWithOffset(java.lang.String objectPath, int[] blockDimensions, long[] offset) Reads a multi-dimensional array of time stamps from the data set objectPath.
int[]	readToMDArrayBlockWithOffset(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDLongArray array, int[] blockDimensions, long[] offset, int[] memoryOffset) Reads a block of the multi-dimensional array data set objectPath of type time stamp into a given array in memory.
int[]	readToMDArrayWithOffset(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDLongArray array, int[] memoryOffset) Reads a multi-dimensional array data set objectPath of type time stamp into a given array in memory.

Method Detail

isTimeStamp

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

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

Throws:

HDF5JavaException

getAttrAsLong

long getAttrAsLong(java.lang.String objectPath,
                   java.lang.String attributeName)

Reads a time stamp 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 stamp as number of milliseconds since January 1, 1970, 00:00:00 GMT.

Throws:

HDF5JavaException - If the attribute attributeName of objct objectPath is not defined as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

getArrayAttrAsLong

long[] getArrayAttrAsLong(java.lang.String objectPath,
                          java.lang.String attributeName)

Reads a time stamp 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 stamp array; each element is a number of milliseconds since January 1, 1970, 00:00:00 GMT.

Throws:

HDF5JavaException - If the attribute attributeName of objct objectPath is not defined as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

getMDArrayAttrAsLong

ch.systemsx.cisd.base.mdarray.MDLongArray getMDArrayAttrAsLong(java.lang.String objectPath,
                                                               java.lang.String attributeName)

Reads a multi-dimension time stamp 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 stamp array; each element is a number of milliseconds since January 1, 1970, 00:00:00 GMT.

Throws:

HDF5JavaException - If the attribute attributeName of objct objectPath is not defined as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

getAttr

java.util.Date getAttr(java.lang.String objectPath,
                       java.lang.String attributeName)

Reads a time stamp attribute named attributeName from the data set objectPath and returns it as a Date.

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 stamp as Date.

Throws:

HDF5JavaException - If the attribute attributeName of objct objectPath is not defined as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

getArrayAttr

java.util.Date[] getArrayAttr(java.lang.String objectPath,
                              java.lang.String attributeName)

Reads a time stamp array attribute named attributeName from the data set objectPath and returns it as a Date[].

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 stamp as Date.

Throws:

HDF5JavaException - If the attribute attributeName of objct objectPath is not defined as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

getMDArrayAttr

ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date> getMDArrayAttr(java.lang.String objectPath,
                                                                     java.lang.String attributeName)

Reads a multi-dimension time stamp 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 stamp as Date.

Throws:

HDF5JavaException - If the attribute attributeName of objct objectPath is not defined as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

isTimeStamp

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

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

Throws:

HDF5JavaException

readTimeStamp

long readTimeStamp(java.lang.String objectPath)
            throws HDF5JavaException

Reads a time stamp value from the data set objectPath. The time stamp is stored as a long value in the HDF5 file. It needs to be tagged as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

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.

Returns:

The time stamp as number of milliseconds since January 1, 1970, 00:00:00 GMT.

Throws:

HDF5JavaException - If the objectPath is not defined as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

readTimeStampArray

long[] readTimeStampArray(java.lang.String objectPath)
                   throws HDF5JavaException

Reads a time stamp array from the data set objectPath. The time stamp is stored as a long value in the HDF5 file. It needs to be tagged as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

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.

Returns:

The time stamp as number of milliseconds since January 1, 1970, 00:00:00 GMT.

Throws:

HDF5JavaException - If the objectPath is not defined as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

readTimeStampArrayBlock

long[] readTimeStampArrayBlock(java.lang.String objectPath,
                               int blockSize,
                               long blockNumber)

Reads a block of a time stamp array (of rank 1) from the data set objectPath. The time stamp is stored as a long value in the HDF5 file. It needs to be tagged as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

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

readTimeStampArrayBlockWithOffset

long[] readTimeStampArrayBlockWithOffset(java.lang.String objectPath,
                                         int blockSize,
                                         long offset)

Reads a block of a time stamp array (of rank 1) from the data set objectPath. The time stamp is stored as a long value in the HDF5 file. It needs to be tagged as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

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.

getTimeStampArrayNaturalBlocks

java.lang.Iterable<HDF5DataBlock<long[]>> getTimeStampArrayNaturalBlocks(java.lang.String dataSetPath)
                                                                  throws HDF5JavaException

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

Throws:

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

See Also:

HDF5DataBlock

readDate

java.util.Date readDate(java.lang.String objectPath)
                 throws HDF5JavaException

Reads a time stamp value from the data set objectPath and returns it as a Date. The time stamp is stored as a long value in the HDF5 file. It needs to be tagged as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

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.

Returns:

The time stamp as Date.

Throws:

HDF5JavaException - If the objectPath does not denote a time stamp.

readDateArray

java.util.Date[] readDateArray(java.lang.String objectPath)
                        throws HDF5JavaException

Reads a time stamp array (of rank 1) from the data set objectPath and returns it as an array of Dates. The time stamp array is stored as a an array of long values in the HDF5 file. It needs to be tagged as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

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.

Returns:

The time stamp as Date.

Throws:

HDF5JavaException - If the objectPath does not denote a time stamp.

readDateArrayBlock

java.util.Date[] readDateArrayBlock(java.lang.String objectPath,
                                    int blockSize,
                                    long blockNumber)

Reads a block of a Date array (of rank 1) from the data set objectPath. The time stamp is stored as a long value in the HDF5 file. It needs to be tagged as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

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

readDateArrayBlockWithOffset

java.util.Date[] readDateArrayBlockWithOffset(java.lang.String objectPath,
                                              int blockSize,
                                              long offset)

Reads a block of a Date array (of rank 1) from the data set objectPath. The time stamp is stored as a long value in the HDF5 file. It needs to be tagged as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

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.

getDateArrayNaturalBlocks

java.lang.Iterable<HDF5DataBlock<java.util.Date[]>> getDateArrayNaturalBlocks(java.lang.String dataSetPath)
                                                                       throws HDF5JavaException

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

Throws:

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

See Also:

HDF5DataBlock

readTimeStampMDArray

ch.systemsx.cisd.base.mdarray.MDLongArray readTimeStampMDArray(java.lang.String objectPath)

Reads a multi-dimensional array of time stamps 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.

readTimeStampMDArrayBlock

ch.systemsx.cisd.base.mdarray.MDLongArray readTimeStampMDArrayBlock(java.lang.String objectPath,
                                                                    int[] blockDimensions,
                                                                    long[] blockNumber)

Reads a multi-dimensional array of time stamps 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.

readTimeStampMDArrayBlockWithOffset

ch.systemsx.cisd.base.mdarray.MDLongArray readTimeStampMDArrayBlockWithOffset(java.lang.String objectPath,
                                                                              int[] blockDimensions,
                                                                              long[] offset)

Reads a multi-dimensional array of time stamps 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,
                              ch.systemsx.cisd.base.mdarray.MDLongArray array,
                              int[] memoryOffset)

Reads a multi-dimensional array data set objectPath of type time stamp 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,
                                   ch.systemsx.cisd.base.mdarray.MDLongArray array,
                                   int[] blockDimensions,
                                   long[] offset,
                                   int[] memoryOffset)

Reads a block of the multi-dimensional array data set objectPath of type time stamp 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.

getTimeStampMDArrayNaturalBlocks

java.lang.Iterable<HDF5MDDataBlock<ch.systemsx.cisd.base.mdarray.MDLongArray>> getTimeStampMDArrayNaturalBlocks(java.lang.String dataSetPath)

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

See Also:

HDF5MDDataBlock

readDateMDArray

ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date> readDateMDArray(java.lang.String objectPath)

Reads a multi-dimensional array of Dates 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.

readDateMDArrayBlock

ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date> readDateMDArrayBlock(java.lang.String objectPath,
                                                                           int[] blockDimensions,
                                                                           long[] blockNumber)

Reads a multi-dimensional array of Dates 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.

readDateMDArrayBlockWithOffset

ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date> readDateMDArrayBlockWithOffset(java.lang.String objectPath,
                                                                                     int[] blockDimensions,
                                                                                     long[] offset)

Reads a multi-dimensional array of Dates 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.

getDateMDArrayNaturalBlocks

java.lang.Iterable<HDF5MDDataBlock<ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date>>> getDateMDArrayNaturalBlocks(java.lang.String dataSetPath)

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

See Also:

HDF5MDDataBlock