ch.systemsx.cisd.hdf5

Interface IHDF5TimeDurationWriter

All Superinterfaces:

IHDF5TimeDurationReader

All Known Implementing Classes:

HDF5TimeDurationWriter

public interface IHDF5TimeDurationWriter
extends IHDF5TimeDurationReader

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

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

Method Summary

Modifier and Type	Method and Description
void	createArray(java.lang.String objectPath, int size, HDF5TimeUnit timeUnit) Creates a time duration array (of rank 1).
void	createArray(java.lang.String objectPath, int size, HDF5TimeUnit timeUnit, HDF5GenericStorageFeatures features) Creates a time duration array (of rank 1).
void	createArray(java.lang.String objectPath, long size, int blockSize, HDF5TimeUnit timeUnit) Creates a time duration array (of rank 1).
void	createArray(java.lang.String objectPath, long size, int blockSize, HDF5TimeUnit timeUnit, HDF5GenericStorageFeatures features) Creates a time duration array (of rank 1).
void	createMDArray(java.lang.String objectPath, int[] dimensions, HDF5TimeUnit timeUnit) Creates a multi-dimensional array of time durations.
void	createMDArray(java.lang.String objectPath, int[] dimensions, HDF5TimeUnit timeUnit, HDF5IntStorageFeatures features) Creates a multi-dimensional array of time durations.
void	createMDArray(java.lang.String objectPath, long[] dimensions, int[] blockDimensions, HDF5TimeUnit timeUnit) Creates a multi-dimensional array of time durations.
void	createMDArray(java.lang.String objectPath, long[] dimensions, int[] blockDimensions, HDF5TimeUnit timeUnit, HDF5IntStorageFeatures features) Creates a multi-dimensional array of time durations.
void	setArrayAttr(java.lang.String objectPath, java.lang.String attributeName, HDF5TimeDurationArray timeDurations) Set a time duration array value as attribute on the referenced object.
void	setAttr(java.lang.String objectPath, java.lang.String attributeName, HDF5TimeDuration timeDuration) Set a time duration value as attribute on the referenced object.
void	setAttr(java.lang.String objectPath, java.lang.String attributeName, long timeDuration, HDF5TimeUnit timeUnit) Set a time duration value as attribute on the referenced object.
void	setMDArrayAttr(java.lang.String objectPath, java.lang.String attributeName, HDF5TimeDurationMDArray timeDurations) Set a multi-dimensional time duration array value as attribute on the referenced object.
void	write(java.lang.String objectPath, HDF5TimeDuration timeDuration) Writes out a time duration value.
void	write(java.lang.String objectPath, long timeDuration, HDF5TimeUnit timeUnit) Writes out a time duration value.
void	writeArray(java.lang.String objectPath, HDF5TimeDurationArray timeDurations) Writes out a time duration array (of rank 1).
void	writeArray(java.lang.String objectPath, HDF5TimeDurationArray timeDurations, HDF5IntStorageFeatures features) Writes out a time duration array (of rank 1).
void	writeArrayBlock(java.lang.String objectPath, HDF5TimeDurationArray data, long blockNumber) Writes out a block of a time duration array.
void	writeArrayBlockWithOffset(java.lang.String objectPath, HDF5TimeDurationArray data, int dataSize, long offset) Writes out a block of a time duration array.
void	writeMDArray(java.lang.String objectPath, HDF5TimeDurationMDArray data) Writes out a multi-dimensional array of time durations.
void	writeMDArray(java.lang.String objectPath, HDF5TimeDurationMDArray data, HDF5IntStorageFeatures features) Writes out a multi-dimensional array of time durations.
void	writeMDArrayBlock(java.lang.String objectPath, HDF5TimeDurationMDArray data, long[] blockNumber) Writes out a block of a multi-dimensional array of time durations.
void	writeMDArrayBlockWithOffset(java.lang.String objectPath, HDF5TimeDurationMDArray data, int[] blockDimensions, long[] offset, int[] memoryOffset) Writes out a block of a multi-dimensional array of time durations.
void	writeMDArrayBlockWithOffset(java.lang.String objectPath, HDF5TimeDurationMDArray data, long[] offset) Writes out a block of a multi-dimensional array of time durations.

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

getArrayAttr, getArrayNaturalBlocks, getAttr, getMDArrayAttr, getMDArrayNaturalBlocks, isTimeDuration, isTimeDuration, read, readArray, readArrayBlock, readArrayBlockWithOffset, readMDArray, readMDArrayBlock, readMDArrayBlockWithOffset, readToMDArrayBlockWithOffset, readToMDArrayWithOffset, tryGetTimeUnit, tryGetTimeUnit

Method Detail

setAttr

void setAttr(java.lang.String objectPath,
             java.lang.String attributeName,
             long timeDuration,
             HDF5TimeUnit timeUnit)

Set a time duration 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.

timeDuration - The value of the attribute.

timeUnit - The unit of the attribute.

setAttr

void setAttr(java.lang.String objectPath,
             java.lang.String attributeName,
             HDF5TimeDuration timeDuration)

Set a time duration 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.

timeDuration - The value of the attribute.

setArrayAttr

void setArrayAttr(java.lang.String objectPath,
                  java.lang.String attributeName,
                  HDF5TimeDurationArray timeDurations)

Set a time duration array value as attribute on the referenced object. The smallest time unit in timeDurations will be used as the time unit of the array.

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

Note: Time durations are stored as a long[] array.

Parameters:

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

attributeName - The name of the attribute.

timeDurations - The value of the attribute.

setMDArrayAttr

void setMDArrayAttr(java.lang.String objectPath,
                    java.lang.String attributeName,
                    HDF5TimeDurationMDArray timeDurations)

Set a multi-dimensional time duration array value as attribute on the referenced object. The smallest time unit in timeDurations will be used as the time unit of the array.

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

Note: Time durations are stored as a long[] array.

Parameters:

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

attributeName - The name of the attribute.

timeDurations - The value of the attribute.

write

void write(java.lang.String objectPath,
           long timeDuration,
           HDF5TimeUnit timeUnit)

Writes out a time duration value.

Note: Time durations 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.

timeDuration - The duration of time to write in the given timeUnit.

timeUnit - The unit of the time duration.

write

void write(java.lang.String objectPath,
           HDF5TimeDuration timeDuration)

Writes out a time duration value.

Note: Time durations 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.

timeDuration - The duration of time to write.

createArray

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

Creates a time duration array (of rank 1).

Note: Time durations 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().

timeUnit - The unit of the time duration.

createArray

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

Creates a time duration array (of rank 1).

Note: Time durations 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.

size - The size 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.

timeUnit - The unit of the time duration.

createArray

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

Creates a time duration array (of rank 1).

Note: Time durations 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.

size - The size 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.

timeUnit - The unit of the time duration.

features - The storage features of the data set.

createArray

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

Creates a time duration array (of rank 1).

Note: Time durations 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.

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.

timeUnit - The unit of the time duration.

features - The storage features of the data set.

writeArray

void writeArray(java.lang.String objectPath,
                HDF5TimeDurationArray timeDurations)

Writes out a time duration array (of rank 1).

Note: Time durations 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.

timeDurations - The time durations to write.

writeArray

void writeArray(java.lang.String objectPath,
                HDF5TimeDurationArray timeDurations,
                HDF5IntStorageFeatures features)

Writes out a time duration array (of rank 1).

Note: Time durations 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.

timeDurations - The time durations to write.

features - The storage features used to store the array.

writeArrayBlock

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

Writes out a block of a time duration array. The data set needs to have been created by createArray(String, long, int, HDF5TimeUnit, HDF5GenericStorageFeatures) beforehand.

Note: For best performance, the block size in this method should be chosen to be equal to the blockSize argument of the createArray(String, long, int, HDF5TimeUnit, HDF5GenericStorageFeatures) 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,
                               HDF5TimeDurationArray data,
                               int dataSize,
                               long offset)

Writes out a block of a time duration array. The data set needs to have been created by createArray(String, long, int, HDF5TimeUnit, HDF5GenericStorageFeatures) beforehand.

Use this method instead of writeArrayBlock(String, HDF5TimeDurationArray, 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 createArray(String, long, int, HDF5TimeUnit, HDF5GenericStorageFeatures) 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.

writeMDArray

void writeMDArray(java.lang.String objectPath,
                  HDF5TimeDurationMDArray data,
                  HDF5IntStorageFeatures features)

Writes out a multi-dimensional array of time durations.

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.

writeMDArray

void writeMDArray(java.lang.String objectPath,
                  HDF5TimeDurationMDArray data)

Writes out a multi-dimensional array of time durations.

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.

createMDArray

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

Creates a multi-dimensional array of time durations.

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,
                   HDF5TimeUnit timeUnit)

Creates a multi-dimensional array of time durations.

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,
                   HDF5TimeUnit timeUnit,
                   HDF5IntStorageFeatures features)

Creates a multi-dimensional array of time durations.

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,
                   HDF5TimeUnit timeUnit,
                   HDF5IntStorageFeatures features)

Creates a multi-dimensional array of time durations.

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,
                       HDF5TimeDurationMDArray data,
                       long[] blockNumber)

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

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,
                                 HDF5TimeDurationMDArray data,
                                 long[] offset)

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

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,
                                 HDF5TimeDurationMDArray data,
                                 int[] blockDimensions,
                                 long[] offset,
                                 int[] memoryOffset)

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

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.