ch.systemsx.cisd.hdf5

Interface IHDF5DateTimeWriter

All Superinterfaces:

IHDF5DateTimeReader

All Known Implementing Classes:

HDF5DateTimeWriter

public interface IHDF5DateTimeWriter
extends IHDF5DateTimeReader

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

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

Method Summary

Modifier and Type	Method and Description
void	createArray(java.lang.String objectPath, int size) Creates a time stamp array (of rank 1).
void	createArray(java.lang.String objectPath, int size, HDF5GenericStorageFeatures features) Creates a time stamp array (of rank 1).
void	createArray(java.lang.String objectPath, long size, int blockSize) Creates a time stamp array (of rank 1).
void	createArray(java.lang.String objectPath, long size, int blockSize, HDF5GenericStorageFeatures features) Creates a time stamp array (of rank 1).
void	createMDArray(java.lang.String objectPath, int[] dimensions) Creates a multi-dimensional array of time stamps / dates.
void	createMDArray(java.lang.String objectPath, int[] dimensions, HDF5IntStorageFeatures features) Creates a multi-dimensional array of time stamps / dates.
void	createMDArray(java.lang.String objectPath, long[] dimensions, int[] blockDimensions) Creates a multi-dimensional array of time stamps / dates.
void	createMDArray(java.lang.String objectPath, long[] dimensions, int[] blockDimensions, HDF5IntStorageFeatures features) Creates a multi-dimensional array of time stamps / dates.
void	setArrayAttr(java.lang.String objectPath, java.lang.String attributeName, java.util.Date[] dates) Set a date array value as attribute on the referenced object.
void	setArrayAttr(java.lang.String objectPath, java.lang.String attributeName, long[] timeStamps) Set a time stamp array value as attribute on the referenced object.
void	setAttr(java.lang.String objectPath, java.lang.String attributeName, java.util.Date date) Set a date value as attribute on the referenced object.
void	setAttr(java.lang.String objectPath, java.lang.String attributeName, long timeStamp) Set a time stamp value as attribute on the referenced object.
void	setMDArrayAttr(java.lang.String objectPath, java.lang.String name, ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date> value) Sets a multi-dimensional timestamp array attribute on the referenced object.
void	setMDArrayAttr(java.lang.String objectPath, java.lang.String name, ch.systemsx.cisd.base.mdarray.MDLongArray value) Sets a multi-dimensional timestamp array attribute on the referenced object.
void	write(java.lang.String objectPath, java.util.Date date) Writes out a time stamp value provided as a Date.
void	write(java.lang.String objectPath, long timeStamp) Writes out a time stamp value.
void	writeArray(java.lang.String objectPath, java.util.Date[] dates) Writes out a Date array (of rank 1).
void	writeArray(java.lang.String objectPath, java.util.Date[] dates, HDF5GenericStorageFeatures features) Writes out a Date array (of rank 1).
void	writeArray(java.lang.String objectPath, long[] timeStamps) Writes out a time stamp array (of rank 1).
void	writeArray(java.lang.String objectPath, long[] timeStamps, HDF5GenericStorageFeatures features) Writes out a time stamp array (of rank 1).
void	writeArrayBlock(java.lang.String objectPath, long[] data, long blockNumber) Writes out a block of a time stamp array (which is stored as a long array of rank 1).
void	writeArrayBlockWithOffset(java.lang.String objectPath, long[] data, int dataSize, long offset) Writes out a block of a time stamp array (which is stored as a long array of rank 1).
void	writeMDArray(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date> data, HDF5IntStorageFeatures features) Writes out a multi-dimensional array of dates.
void	writeMDArray(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDLongArray data, HDF5IntStorageFeatures features) Writes out a multi-dimensional array of time stamps.
void	writeMDArrayBlock(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date> data, long[] blockNumber) Writes out a block of a multi-dimensional array of dates.
void	writeMDArrayBlock(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDLongArray data, long[] blockNumber) Writes out a block of a multi-dimensional array of time stamps.
void	writeMDArrayBlockWithOffset(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date> data, int[] blockDimensions, long[] offset, int[] memoryOffset) Writes out a block of a multi-dimensional array of dates.
void	writeMDArrayBlockWithOffset(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date> data, long[] offset) Writes out a block of a multi-dimensional array of daates.
void	writeMDArrayBlockWithOffset(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDLongArray data, int[] blockDimensions, long[] offset, int[] memoryOffset) Writes out a block of a multi-dimensional array of time stamps.
void	writeMDArrayBlockWithOffset(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDLongArray data, long[] offset) Writes out a block of a multi-dimensional array of time stamps.

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

getArrayAttr, getArrayAttrAsLong, getAttr, getAttrAsLong, getDateArrayNaturalBlocks, getDateMDArrayNaturalBlocks, getMDArrayAttr, getMDArrayAttrAsLong, getTimeStampArrayNaturalBlocks, getTimeStampMDArrayNaturalBlocks, isTimeStamp, isTimeStamp, readDate, readDateArray, readDateArrayBlock, readDateArrayBlockWithOffset, readDateMDArray, readDateMDArrayBlock, readDateMDArrayBlockWithOffset, readTimeStamp, readTimeStampArray, readTimeStampArrayBlock, readTimeStampArrayBlockWithOffset, readTimeStampMDArray, readTimeStampMDArrayBlock, readTimeStampMDArrayBlockWithOffset, readToMDArrayBlockWithOffset, readToMDArrayWithOffset

Method Detail

setAttr

void setAttr(java.lang.String objectPath,
             java.lang.String attributeName,
             java.util.Date date)

Set a date value as attribute on the referenced object.

The referenced object must exist, that is it need to have been written before by one of the write() methods.

Parameters:

objectPath - The name of the object to add the attribute to.

attributeName - The name of the attribute.

date - The value of the attribute.

setArrayAttr

void setArrayAttr(java.lang.String objectPath,
                  java.lang.String attributeName,
                  java.util.Date[] dates)

Set a date array value as attribute on the referenced object.

The referenced object must exist, that is it need to have been written before by one of the write() methods.

Parameters:

objectPath - The name of the object to add the attribute to.

attributeName - The name of the attribute.

dates - The value of the attribute.

setAttr

void setAttr(java.lang.String objectPath,
             java.lang.String attributeName,
             long timeStamp)

Set a time stamp value as attribute on the referenced object.

The referenced object must exist, that is it need to have been written before by one of the write() methods.

Parameters:

objectPath - The name of the object to add the attribute to.

attributeName - The name of the attribute.

timeStamp - The value of the attribute.

setArrayAttr

void setArrayAttr(java.lang.String objectPath,
                  java.lang.String attributeName,
                  long[] timeStamps)

Set a time stamp array value as attribute on the referenced object.

The referenced object must exist, that is it need to have been written before by one of the write() methods.

Parameters:

objectPath - The name of the object to add the attribute to.

attributeName - The name of the attribute.

timeStamps - The value of the attribute.

setMDArrayAttr

void setMDArrayAttr(java.lang.String objectPath,
                    java.lang.String name,
                    ch.systemsx.cisd.base.mdarray.MDLongArray value)

Sets a multi-dimensional timestamp array attribute on the referenced object.

The referenced object must exist, that is it need to have been written before by one of the write() methods.

Parameters:

objectPath - The name of the object to add the attribute to.

name - The name of the attribute.

value - The value of the attribute.

setMDArrayAttr

void setMDArrayAttr(java.lang.String objectPath,
                    java.lang.String name,
                    ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date> value)

Sets a multi-dimensional timestamp array attribute on the referenced object.

The referenced object must exist, that is it need to have been written before by one of the write() methods.

Parameters:

objectPath - The name of the object to add the attribute to.

name - The name of the attribute.

value - The value of the attribute.

write

void write(java.lang.String objectPath,
           long timeStamp)

Writes out a time stamp value. The data set will be tagged as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

Note: Time stamps are stored as long values.

Parameters:

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

timeStamp - The timestamp to write as number of milliseconds since January 1, 1970, 00:00:00 GMT.

createArray

void createArray(java.lang.String objectPath,
                 long size,
                 int blockSize)

Creates a time stamp array (of rank 1).

Note: Time stamps are stored as long values.

Parameters:

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

size - The length of the data set to create.

blockSize - The size of one block (for block-wise IO). Ignored if no extendable data sets are used (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()) and deflate == false.

createArray

void createArray(java.lang.String objectPath,
                 int size)

Creates a time stamp array (of rank 1).

Note: Time stamps are stored as long values.

Parameters:

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

size - The size of the byte array to create. This will be the total size for non-extendable data sets and the size of one chunk for extendable (chunked) data sets. For extendable data sets the initial size of the array will be 0, see IHDF5WriterConfigurator.dontUseExtendableDataTypes().

createArray

void createArray(java.lang.String objectPath,
                 long size,
                 int blockSize,
                 HDF5GenericStorageFeatures features)

Creates a time stamp array (of rank 1).

Note: Time stamps are stored as long values.

Parameters:

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

size - The length of the data set to create.

blockSize - The size of one block (for block-wise IO). Ignored if no extendable data sets are used (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()) and deflate == false.

features - The storage features of the data set.

createArray

void createArray(java.lang.String objectPath,
                 int size,
                 HDF5GenericStorageFeatures features)

Creates a time stamp array (of rank 1).

Note: Time stamps are stored as long values.

Parameters:

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

size - The size of the array to create. This will be the total size for non-extendable data sets and the size of one chunk for extendable (chunked) data sets. For extendable data sets the initial size of the array will be 0, see HDF5GenericStorageFeatures.

features - The storage features of the data set.

writeArray

void writeArray(java.lang.String objectPath,
                long[] timeStamps)

Writes out a time stamp array (of rank 1). The data set will be tagged as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

Note: Time stamps are stored as long values.

Parameters:

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

timeStamps - The timestamps to write as number of milliseconds since January 1, 1970, 00:00:00 GMT.

writeArray

void writeArray(java.lang.String objectPath,
                long[] timeStamps,
                HDF5GenericStorageFeatures features)

Writes out a time stamp array (of rank 1). The data set will be tagged as type variant HDF5DataTypeVariant.TIMESTAMP_MILLISECONDS_SINCE_START_OF_THE_EPOCH.

Note: Time stamps are stored as long values.

Parameters:

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

timeStamps - The timestamps to write as number of milliseconds since January 1, 1970, 00:00:00 GMT.

features - The storage features of the data set.

writeArrayBlock

void writeArrayBlock(java.lang.String objectPath,
                     long[] data,
                     long blockNumber)

Writes out a block of a time stamp array (which is stored as a long array of rank 1). The data set needs to have been created by createArray(String, long, int, HDF5GenericStorageFeatures) beforehand.

Note: For best performance, the block size in this method should be chosen to be equal to the blockSize argument of the IHDF5LongWriter.createArray(String, long, int, HDF5IntStorageFeatures) call that was used to create the data set.

Parameters:

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

data - The data to write. The length defines the block size. Must not be null or of length 0.

blockNumber - The number of the block to write.

writeArrayBlockWithOffset

void writeArrayBlockWithOffset(java.lang.String objectPath,
                               long[] data,
                               int dataSize,
                               long offset)

Writes out a block of a time stamp array (which is stored as a long array of rank 1). The data set needs to have been created by createArray(String, long, int, HDF5GenericStorageFeatures) beforehand.

Use this method instead of writeArrayBlock(String, long[], long) if the total size of the data set is not a multiple of the block size.

Note: For best performance, the typical dataSize in this method should be chosen to be equal to the blockSize argument of the IHDF5LongWriter.createArray(String, long, int, HDF5IntStorageFeatures) call that was used to create the data set.

Parameters:

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

data - The data to write. The length defines the block size. Must not be null or of length 0.

dataSize - The (real) size of data (needs to be <= data.length )

offset - The offset in the data set to start writing to.

write

void write(java.lang.String objectPath,
           java.util.Date date)

Writes out a time stamp value provided as a Date.

Note: The time stamp is stored as long array and tagged as the according type variant.

Parameters:

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

date - The date to write.

See Also:

write(String, long)

writeArray

void writeArray(java.lang.String objectPath,
                java.util.Date[] dates)

Writes out a Date array (of rank 1).

Note: Time stamps are stored as long[] arrays and tagged as the according type variant.

Parameters:

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

dates - The dates to write.

See Also:

writeArray(String, long[])

writeArray

void writeArray(java.lang.String objectPath,
                java.util.Date[] dates,
                HDF5GenericStorageFeatures features)

Writes out a Date array (of rank 1).

Note: Time date is stored as long[] arrays and tagged as the according type variant.

Parameters:

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

dates - The dates to write.

features - The storage features of the data set.

See Also:

writeArray(String, long[], HDF5GenericStorageFeatures)

writeMDArray

void writeMDArray(java.lang.String objectPath,
                  ch.systemsx.cisd.base.mdarray.MDLongArray data,
                  HDF5IntStorageFeatures features)

Writes out a multi-dimensional array of time stamps.

Parameters:

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

data - The data to write. Must not be null. All columns need to have the same length.

features - The storage features of the data set.

createMDArray

void createMDArray(java.lang.String objectPath,
                   int[] dimensions)

Creates a multi-dimensional array of time stamps / dates.

Parameters:

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

dimensions - When the writer is configured to use extendable data types (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()), the initial dimensions and the dimensions of a chunk of the array will be dimensions. When the writer is configured to enforce a on-extendable data set, the initial dimensions equal the dimensions and will be dimensions.

createMDArray

void createMDArray(java.lang.String objectPath,
                   long[] dimensions,
                   int[] blockDimensions)

Creates a multi-dimensional array of time stamps / dates.

Parameters:

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

dimensions - The dimensions of the array.

blockDimensions - The dimensions of one block (chunk) of the array.

createMDArray

void createMDArray(java.lang.String objectPath,
                   int[] dimensions,
                   HDF5IntStorageFeatures features)

Creates a multi-dimensional array of time stamps / dates.

Parameters:

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

dimensions - The dimensions of the long array to create. When requesting a chunked data set (e.g. HDF5IntStorageFeatures.INT_CHUNKED), the initial size of the array will be 0 and the chunk size will be dimensions. When allowing a chunked data set (e.g. HDF5IntStorageFeatures.INT_NO_COMPRESSION when the writer is not configured to avoid extendable data types, see IHDF5WriterConfigurator.dontUseExtendableDataTypes()), the initial size and the chunk size of the array will be dimensions. When enforcing a on-extendable data set (e.g. HDF5IntStorageFeatures.INT_CONTIGUOUS), the initial size equals the total size and will be dimensions.

features - The storage features of the data set.

createMDArray

void createMDArray(java.lang.String objectPath,
                   long[] dimensions,
                   int[] blockDimensions,
                   HDF5IntStorageFeatures features)

Creates a multi-dimensional array of time stamps / dates.

Parameters:

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

dimensions - The dimensions of the array.

blockDimensions - The dimensions of one block (chunk) of the array.

features - The storage features of the data set.

writeMDArrayBlock

void writeMDArrayBlock(java.lang.String objectPath,
                       ch.systemsx.cisd.base.mdarray.MDLongArray data,
                       long[] blockNumber)

Writes out a block of a multi-dimensional array of time stamps.

Parameters:

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

data - The data to write. Must not be null. All columns need to have the same length.

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

writeMDArrayBlockWithOffset

void writeMDArrayBlockWithOffset(java.lang.String objectPath,
                                 ch.systemsx.cisd.base.mdarray.MDLongArray data,
                                 long[] offset)

Writes out a block of a multi-dimensional array of time stamps.

Parameters:

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

data - The data to write. Must not be null. All columns need to have the same length.

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

writeMDArrayBlockWithOffset

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

Writes out a block of a multi-dimensional array of time stamps.

Parameters:

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

data - The data to write. Must not be null.

blockDimensions - The dimensions of the block to write to the data set.

offset - The offset of the block in the data set to start writing to in each dimension.

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

writeMDArray

void writeMDArray(java.lang.String objectPath,
                  ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date> data,
                  HDF5IntStorageFeatures features)

Writes out a multi-dimensional array of dates.

Parameters:

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

data - The data to write. Must not be null. All columns need to have the same length.

features - The storage features of the data set.

writeMDArrayBlock

void writeMDArrayBlock(java.lang.String objectPath,
                       ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date> data,
                       long[] blockNumber)

Writes out a block of a multi-dimensional array of dates.

Parameters:

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

data - The data to write. Must not be null. All columns need to have the same length.

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

writeMDArrayBlockWithOffset

void writeMDArrayBlockWithOffset(java.lang.String objectPath,
                                 ch.systemsx.cisd.base.mdarray.MDArray<java.util.Date> data,
                                 long[] offset)

Writes out a block of a multi-dimensional array of daates.

Parameters:

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

data - The data to write. Must not be null. All columns need to have the same length.

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

writeMDArrayBlockWithOffset

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

Writes out a block of a multi-dimensional array of dates.

Parameters:

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

data - The data to write. Must not be null.

blockDimensions - The dimensions of the block to write to the data set.

offset - The offset of the block in the data set to start writing to in each dimension.

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