ch.systemsx.cisd.hdf5

Class HDF5TimeDurationWriter

java.lang.Object

ch.systemsx.cisd.hdf5.HDF5TimeDurationWriter

All Implemented Interfaces:

IHDF5TimeDurationReader, IHDF5TimeDurationWriter

public class HDF5TimeDurationWriter
extends java.lang.Object
implements IHDF5TimeDurationWriter

Implementation of IHDF5TimeDurationWriter.

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.
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.
java.lang.Iterable<HDF5DataBlock<HDF5TimeDuration[]>>	getTimeDurationAndUnitArrayNaturalBlocks(java.lang.String objectPath)
java.lang.Iterable<HDF5DataBlock<long[]>>	getTimeDurationArrayNaturalBlocks(java.lang.String objectPath, HDF5TimeUnit timeUnit)
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.
long	readTimeDuration(java.lang.String objectPath, HDF5TimeUnit timeUnit)
HDF5TimeDuration	readTimeDurationAndUnit(java.lang.String objectPath)
HDF5TimeDuration[]	readTimeDurationAndUnitArray(java.lang.String objectPath)
HDF5TimeDuration[]	readTimeDurationAndUnitArrayBlock(java.lang.String objectPath, int blockSize, long blockNumber)
HDF5TimeDuration[]	readTimeDurationAndUnitArrayBlockWithOffset(java.lang.String objectPath, int blockSize, long offset)
long[]	readTimeDurationArray(java.lang.String objectPath, HDF5TimeUnit timeUnit)
long[]	readTimeDurationArrayBlock(java.lang.String objectPath, int blockSize, long blockNumber, HDF5TimeUnit timeUnit)
long[]	readTimeDurationArrayBlockWithOffset(java.lang.String objectPath, int blockSize, long offset, HDF5TimeUnit timeUnit)
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.
void	setArrayAttr(java.lang.String objectPath, java.lang.String name, HDF5TimeDurationArray timeDurations) Set a time duration array value as attribute on the referenced object.
void	setAttr(java.lang.String objectPath, java.lang.String name, HDF5TimeDuration timeDuration) Set a time duration value as attribute on the referenced object.
void	setAttr(java.lang.String objectPath, java.lang.String name, 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.
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.
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.
void	writeTimeDuration(java.lang.String objectPath, long timeDuration)
void	writeTimeDurationArray(java.lang.String objectPath, HDF5TimeDuration[] timeDurations)
void	writeTimeDurationArray(java.lang.String objectPath, HDF5TimeDuration[] timeDurations, HDF5IntStorageFeatures features)
void	writeTimeDurationArray(java.lang.String objectPath, long[] timeDurations)
void	writeTimeDurationArray(java.lang.String objectPath, long[] timeDurations, HDF5TimeUnit timeUnit)
void	writeTimeDurationArray(java.lang.String objectPath, long[] timeDurations, HDF5TimeUnit timeUnit, HDF5IntStorageFeatures features)
void	writeTimeDurationArrayBlock(java.lang.String objectPath, HDF5TimeDuration[] data, long blockNumber)
void	writeTimeDurationArrayBlock(java.lang.String objectPath, long[] data, long blockNumber, HDF5TimeUnit timeUnit)
void	writeTimeDurationArrayBlockWithOffset(java.lang.String objectPath, HDF5TimeDuration[] data, int dataSize, long offset)
void	writeTimeDurationArrayBlockWithOffset(java.lang.String objectPath, long[] data, int dataSize, long offset, HDF5TimeUnit timeUnit)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Description copied from interface: IHDF5TimeDurationWriter

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.

Specified by:

setAttr in interface IHDF5TimeDurationWriter

Parameters:

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

name - The name of the attribute.

timeDuration - The value of the attribute.

timeUnit - The unit of the attribute.

setAttr

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

Description copied from interface: IHDF5TimeDurationWriter

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.

Specified by:

setAttr in interface IHDF5TimeDurationWriter

Parameters:

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

name - The name of the attribute.

timeDuration - The value of the attribute.

setArrayAttr

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

Description copied from interface: IHDF5TimeDurationWriter

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.

Specified by:

setArrayAttr in interface IHDF5TimeDurationWriter

Parameters:

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

name - The name of the attribute.

timeDurations - The value of the attribute.

setMDArrayAttr

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

Description copied from interface: IHDF5TimeDurationWriter

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.

Specified by:

setMDArrayAttr in interface IHDF5TimeDurationWriter

Parameters:

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

attributeName - The name of the attribute.

timeDurations - The value of the attribute.

writeTimeDuration

public void writeTimeDuration(java.lang.String objectPath,
                              long timeDuration)

write

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

Description copied from interface: IHDF5TimeDurationWriter

Writes out a time duration value.

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

Specified by:

write in interface IHDF5TimeDurationWriter

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

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

Description copied from interface: IHDF5TimeDurationWriter

Writes out a time duration value.

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

Specified by:

write in interface IHDF5TimeDurationWriter

Parameters:

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

timeDuration - The duration of time to write.

createArray

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

Description copied from interface: IHDF5TimeDurationWriter

Creates a time duration array (of rank 1).

Note: Time durations are stored as long values.

Specified by:

createArray in interface IHDF5TimeDurationWriter

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

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

Description copied from interface: IHDF5TimeDurationWriter

Creates a time duration array (of rank 1).

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

Specified by:

createArray in interface IHDF5TimeDurationWriter

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

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

Description copied from interface: IHDF5TimeDurationWriter

Creates a time duration array (of rank 1).

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

Specified by:

createArray in interface IHDF5TimeDurationWriter

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.

createArray

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

Description copied from interface: IHDF5TimeDurationWriter

Creates a time duration array (of rank 1).

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

Specified by:

createArray in interface IHDF5TimeDurationWriter

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.

writeTimeDurationArray

public void writeTimeDurationArray(java.lang.String objectPath,
                                   long[] timeDurations)

writeArray

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

Description copied from interface: IHDF5TimeDurationWriter

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

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

Specified by:

writeArray in interface IHDF5TimeDurationWriter

Parameters:

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

timeDurations - The time durations to write.

writeArray

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

Description copied from interface: IHDF5TimeDurationWriter

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

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

Specified by:

writeArray in interface IHDF5TimeDurationWriter

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.

writeTimeDurationArray

public void writeTimeDurationArray(java.lang.String objectPath,
                                   long[] timeDurations,
                                   HDF5TimeUnit timeUnit)

writeTimeDurationArray

public void writeTimeDurationArray(java.lang.String objectPath,
                                   long[] timeDurations,
                                   HDF5TimeUnit timeUnit,
                                   HDF5IntStorageFeatures features)

writeTimeDurationArray

public void writeTimeDurationArray(java.lang.String objectPath,
                                   HDF5TimeDuration[] timeDurations)

writeTimeDurationArray

public void writeTimeDurationArray(java.lang.String objectPath,
                                   HDF5TimeDuration[] timeDurations,
                                   HDF5IntStorageFeatures features)

writeArrayBlock

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

Description copied from interface: IHDF5TimeDurationWriter

Writes out a block of a time duration array. The data set needs to have been created by IHDF5TimeDurationWriter.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 IHDF5TimeDurationWriter.createArray(String, long, int, HDF5TimeUnit, HDF5GenericStorageFeatures) call that was used to create the data set.

Specified by:

writeArrayBlock in interface IHDF5TimeDurationWriter

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

public void writeArrayBlockWithOffset(java.lang.String objectPath,
                                      HDF5TimeDurationArray data,
                                      int dataSize,
                                      long offset)

Description copied from interface: IHDF5TimeDurationWriter

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

Use this method instead of IHDF5TimeDurationWriter.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 IHDF5TimeDurationWriter.createArray(String, long, int, HDF5TimeUnit, HDF5GenericStorageFeatures) call that was used to create the data set.

Specified by:

writeArrayBlockWithOffset in interface IHDF5TimeDurationWriter

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.

writeTimeDurationArrayBlock

public void writeTimeDurationArrayBlock(java.lang.String objectPath,
                                        long[] data,
                                        long blockNumber,
                                        HDF5TimeUnit timeUnit)

writeTimeDurationArrayBlockWithOffset

public void writeTimeDurationArrayBlockWithOffset(java.lang.String objectPath,
                                                  long[] data,
                                                  int dataSize,
                                                  long offset,
                                                  HDF5TimeUnit timeUnit)

writeTimeDurationArrayBlock

public void writeTimeDurationArrayBlock(java.lang.String objectPath,
                                        HDF5TimeDuration[] data,
                                        long blockNumber)

writeTimeDurationArrayBlockWithOffset

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

writeMDArray

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

Description copied from interface: IHDF5TimeDurationWriter

Writes out a multi-dimensional array of time durations.

Specified by:

writeMDArray in interface IHDF5TimeDurationWriter

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

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

Description copied from interface: IHDF5TimeDurationWriter

Writes out a multi-dimensional array of time durations.

Specified by:

writeMDArray in interface IHDF5TimeDurationWriter

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

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

Description copied from interface: IHDF5TimeDurationWriter

Creates a multi-dimensional array of time durations.

Specified by:

createMDArray in interface IHDF5TimeDurationWriter

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

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

Description copied from interface: IHDF5TimeDurationWriter

Creates a multi-dimensional array of time durations.

Specified by:

createMDArray in interface IHDF5TimeDurationWriter

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

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

Description copied from interface: IHDF5TimeDurationWriter

Creates a multi-dimensional array of time durations.

Specified by:

createMDArray in interface IHDF5TimeDurationWriter

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

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

Description copied from interface: IHDF5TimeDurationWriter

Creates a multi-dimensional array of time durations.

Specified by:

createMDArray in interface IHDF5TimeDurationWriter

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

public void writeMDArrayBlock(java.lang.String objectPath,
                              HDF5TimeDurationMDArray data,
                              long[] blockNumber)

Description copied from interface: IHDF5TimeDurationWriter

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

Specified by:

writeMDArrayBlock in interface IHDF5TimeDurationWriter

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

public void writeMDArrayBlockWithOffset(java.lang.String objectPath,
                                        HDF5TimeDurationMDArray data,
                                        long[] offset)

Description copied from interface: IHDF5TimeDurationWriter

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

Specified by:

writeMDArrayBlockWithOffset in interface IHDF5TimeDurationWriter

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

public void writeMDArrayBlockWithOffset(java.lang.String objectPath,
                                        HDF5TimeDurationMDArray data,
                                        int[] blockDimensions,
                                        long[] offset,
                                        int[] memoryOffset)

Description copied from interface: IHDF5TimeDurationWriter

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

Specified by:

writeMDArrayBlockWithOffset in interface IHDF5TimeDurationWriter

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.

getAttr

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

Description copied from interface: IHDF5TimeDurationReader

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

Specified by:

getAttr in interface IHDF5TimeDurationReader

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.

isTimeDuration

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

Description copied from interface: IHDF5TimeDurationReader

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

Specified by:

isTimeDuration in interface IHDF5TimeDurationReader

Throws:

HDF5JavaException

tryGetTimeUnit

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

Description copied from interface: IHDF5TimeDurationReader

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

Specified by:

tryGetTimeUnit in interface IHDF5TimeDurationReader

Throws:

HDF5JavaException

getArrayAttr

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

Description copied from interface: IHDF5TimeDurationReader

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

Specified by:

getArrayAttr in interface IHDF5TimeDurationReader

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.

getMDArrayAttr

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

Description copied from interface: IHDF5TimeDurationReader

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

Specified by:

getMDArrayAttr in interface IHDF5TimeDurationReader

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.

isTimeDuration

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

Description copied from interface: IHDF5TimeDurationReader

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

Specified by:

isTimeDuration in interface IHDF5TimeDurationReader

Throws:

HDF5JavaException

tryGetTimeUnit

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

Description copied from interface: IHDF5TimeDurationReader

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

Specified by:

tryGetTimeUnit in interface IHDF5TimeDurationReader

Throws:

HDF5JavaException

read

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

Description copied from interface: IHDF5TimeDurationReader

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

Specified by:

read in interface IHDF5TimeDurationReader

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.

readTimeDuration

public long readTimeDuration(java.lang.String objectPath,
                             HDF5TimeUnit timeUnit)
                      throws HDF5JavaException

Throws:

HDF5JavaException

readTimeDurationAndUnit

public HDF5TimeDuration readTimeDurationAndUnit(java.lang.String objectPath)
                                         throws HDF5JavaException

Throws:

HDF5JavaException

readArray

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

Description copied from interface: IHDF5TimeDurationReader

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());
 

Specified by:

readArray in interface IHDF5TimeDurationReader

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.

readTimeDurationArray

public long[] readTimeDurationArray(java.lang.String objectPath,
                                    HDF5TimeUnit timeUnit)
                             throws HDF5JavaException

Throws:

HDF5JavaException

readTimeDurationAndUnitArray

public HDF5TimeDuration[] readTimeDurationAndUnitArray(java.lang.String objectPath)
                                                throws HDF5JavaException

Throws:

HDF5JavaException

readTimeDurationArrayBlock

public long[] readTimeDurationArrayBlock(java.lang.String objectPath,
                                         int blockSize,
                                         long blockNumber,
                                         HDF5TimeUnit timeUnit)

readArrayBlock

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

Description copied from interface: IHDF5TimeDurationReader

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());
 

Specified by:

readArrayBlock in interface IHDF5TimeDurationReader

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

readArrayBlockWithOffset

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

Description copied from interface: IHDF5TimeDurationReader

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());
 

Specified by:

readArrayBlockWithOffset in interface IHDF5TimeDurationReader

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.

readTimeDurationArrayBlockWithOffset

public long[] readTimeDurationArrayBlockWithOffset(java.lang.String objectPath,
                                                   int blockSize,
                                                   long offset,
                                                   HDF5TimeUnit timeUnit)

readTimeDurationAndUnitArrayBlock

public HDF5TimeDuration[] readTimeDurationAndUnitArrayBlock(java.lang.String objectPath,
                                                            int blockSize,
                                                            long blockNumber)
                                                     throws HDF5JavaException

Throws:

HDF5JavaException

readTimeDurationAndUnitArrayBlockWithOffset

public HDF5TimeDuration[] readTimeDurationAndUnitArrayBlockWithOffset(java.lang.String objectPath,
                                                                      int blockSize,
                                                                      long offset)
                                                               throws HDF5JavaException

Throws:

HDF5JavaException

getTimeDurationAndUnitArrayNaturalBlocks

public java.lang.Iterable<HDF5DataBlock<HDF5TimeDuration[]>> getTimeDurationAndUnitArrayNaturalBlocks(java.lang.String objectPath)
                                                                                               throws HDF5JavaException

Throws:

HDF5JavaException

readMDArray

public HDF5TimeDurationMDArray readMDArray(java.lang.String objectPath)

Description copied from interface: IHDF5TimeDurationReader

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

Specified by:

readMDArray in interface IHDF5TimeDurationReader

Parameters:

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

Returns:

The data read from the data set.

readMDArrayBlock

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

Description copied from interface: IHDF5TimeDurationReader

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

Specified by:

readMDArrayBlock in interface IHDF5TimeDurationReader

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.

readMDArrayBlockWithOffset

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

Description copied from interface: IHDF5TimeDurationReader

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

Specified by:

readMDArrayBlockWithOffset in interface IHDF5TimeDurationReader

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

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

Description copied from interface: IHDF5TimeDurationReader

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

Specified by:

readToMDArrayWithOffset in interface IHDF5TimeDurationReader

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

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

Description copied from interface: IHDF5TimeDurationReader

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

Specified by:

readToMDArrayBlockWithOffset in interface IHDF5TimeDurationReader

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.

getArrayNaturalBlocks

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

Description copied from interface: IHDF5TimeDurationReader

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

Specified by:

getArrayNaturalBlocks in interface IHDF5TimeDurationReader

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

getTimeDurationArrayNaturalBlocks

public java.lang.Iterable<HDF5DataBlock<long[]>> getTimeDurationArrayNaturalBlocks(java.lang.String objectPath,
                                                                                   HDF5TimeUnit timeUnit)
                                                                            throws HDF5JavaException

Throws:

HDF5JavaException

getMDArrayNaturalBlocks

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

Description copied from interface: IHDF5TimeDurationReader

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

Specified by:

getMDArrayNaturalBlocks in interface IHDF5TimeDurationReader

See Also:

HDF5MDDataBlock