ch.systemsx.cisd.hdf5

Class HDF5StringWriter

java.lang.Object

ch.systemsx.cisd.hdf5.HDF5StringReader

ch.systemsx.cisd.hdf5.HDF5StringWriter

All Implemented Interfaces:

IHDF5StringReader, IHDF5StringWriter

public class HDF5StringWriter
extends HDF5StringReader
implements IHDF5StringWriter

The implementation of IHDF5StringWriter.

Method Summary

Modifier and Type	Method and Description
void	createArray(java.lang.String objectPath, int maxLength, int size) Creates a String array (of rank 1) for Strings of length maxLength.
void	createArray(java.lang.String objectPath, int maxLength, int size, HDF5GenericStorageFeatures features) Creates a String array (of rank 1) for Strings of length maxLength.
void	createArray(java.lang.String objectPath, int maxLength, long size, int blockSize) Creates a String array (of rank 1) for Strings of length maxLength.
void	createArray(java.lang.String objectPath, int maxLength, long size, int blockSize, HDF5GenericStorageFeatures features) Creates a String array (of rank 1) for Strings of length maxLength.
void	createArrayVL(java.lang.String objectPath, int size) Creates a String[] where each String of the array has a variable maximal length.
void	createArrayVL(java.lang.String objectPath, int size, HDF5GenericStorageFeatures features) Creates a String[] where each String of the array has a variable maximal length.
void	createArrayVL(java.lang.String objectPath, long size, int blockSize) Creates a String[] where each String of the array has a variable maximal length.
void	createArrayVL(java.lang.String objectPath, long size, int blockSize, HDF5GenericStorageFeatures features) Creates a String[] where each String of the array has a variable maximal length.
void	createMDArray(java.lang.String objectPath, int maxLength, int[] dimensions) Creates a String array (of rank N) for Strings of length maxLength.
void	createMDArray(java.lang.String objectPath, int maxLength, int[] dimensions, HDF5GenericStorageFeatures features) Creates a String array (of rank N) for Strings of length maxLength.
void	createMDArray(java.lang.String objectPath, int maxLength, long[] dimensions, int[] blockSize) Creates a String array (of rank N) for Strings of length maxLength.
void	createMDArray(java.lang.String objectPath, int maxLength, long[] dimensions, int[] blockSize, HDF5GenericStorageFeatures features) Creates a String array (of rank N) for Strings of length maxLength.
void	createMDArrayVL(java.lang.String objectPath, int[] dimensions) Creates a multi-dimensional String array where each String of the array has a variable maximal length.
void	createMDArrayVL(java.lang.String objectPath, int[] dimensions, HDF5GenericStorageFeatures features) Creates a multi-dimensional String array where each String of the array has a variable maximal length.
void	createMDArrayVL(java.lang.String objectPath, long[] dimensions, int[] blockSize) Creates a multi-dimensional String array where each String of the array has a variable maximal length.
void	createMDArrayVL(java.lang.String objectPath, long[] dimensions, int[] blockSize, HDF5GenericStorageFeatures features) Creates a multi-dimensional String array where each String of the array has a variable maximal length.
void	setArrayAttr(java.lang.String objectPath, java.lang.String name, java.lang.String[] value) Sets a string array attribute on the referenced object.
void	setArrayAttr(java.lang.String objectPath, java.lang.String name, java.lang.String[] value, int maxLength) Sets a string array attribute on the referenced object.
void	setAttr(java.lang.String objectPath, java.lang.String name, java.lang.String value) Sets a string attribute on the referenced object.
void	setAttr(java.lang.String objectPath, java.lang.String name, java.lang.String value, int maxLength) Sets a string attribute on the referenced object.
void	setAttrVL(java.lang.String objectPath, java.lang.String name, java.lang.String value) Sets a string attribute with variable length on the referenced object.
void	setMDArrayAttr(java.lang.String objectPath, java.lang.String name, ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> value) Sets a multi-dimensional string array attribute on the referenced object.
void	setMDArrayAttr(java.lang.String objectPath, java.lang.String name, ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> value, int maxLength) Sets a multi-dimensional string array attribute on the referenced object.
void	write(java.lang.String objectPath, java.lang.String data) Writes out a String with a fixed maximal length (which is the length of the string data).
void	write(java.lang.String objectPath, java.lang.String data, HDF5GenericStorageFeatures features) Writes out a String with a fixed maximal length.
void	write(java.lang.String objectPath, java.lang.String data, int maxLength) Writes out a String with a fixed maximal length.
void	write(java.lang.String objectPath, java.lang.String data, int maxLength, HDF5GenericStorageFeatures features) Writes out a String with a fixed maximal length.
void	writeArray(java.lang.String objectPath, java.lang.String[] data) Writes out a String array (of rank 1).
void	writeArray(java.lang.String objectPath, java.lang.String[] data, HDF5GenericStorageFeatures features) Writes out a String array (of rank 1).
void	writeArray(java.lang.String objectPath, java.lang.String[] data, int maxLength) Writes out a String array (of rank 1).
void	writeArray(java.lang.String objectPath, java.lang.String[] data, int maxLength, HDF5GenericStorageFeatures features) Writes out a String array (of rank 1).
void	writeArrayBlock(java.lang.String objectPath, java.lang.String[] data, long blockNumber) Writes out a block of a String array (of rank 1).
void	writeArrayBlockWithOffset(java.lang.String objectPath, java.lang.String[] data, int dataSize, long offset) Writes out a block of a String array (of rank 1).
void	writeArrayVL(java.lang.String objectPath, java.lang.String[] data) Writes out a String[] where each String of the array has a variable maximal length.
void	writeArrayVL(java.lang.String objectPath, java.lang.String[] data, HDF5GenericStorageFeatures features) Writes out a String[] where each String of the array has a variable maximal length.
void	writeMDArray(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> data) Writes out a String array (of rank N).
void	writeMDArray(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> data, HDF5GenericStorageFeatures features) Writes out a String array (of rank N).
void	writeMDArray(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> data, int maxLength) Writes out a String array (of rank N).
void	writeMDArray(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> data, int maxLength, HDF5GenericStorageFeatures features) Writes out a String array (of rank N).
void	writeMDArrayBlock(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> data, long[] blockNumber) Writes out a block of a String array (of rank N).
void	writeMDArrayBlockWithOffset(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> data, long[] offset) Writes out a block of a String array (of rank N).
void	writeMDArrayVL(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> data) Writes out a String array (of rank N).
void	writeMDArrayVL(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> data, HDF5GenericStorageFeatures features) Writes out a String array (of rank N).
void	writeVL(java.lang.String objectPath, java.lang.String data) Writes out a String with variable maximal length.

Methods inherited from class ch.systemsx.cisd.hdf5.HDF5StringReader

getArrayAttr, getArrayAttrRaw, getArrayNaturalBlocks, getArrayNaturalBlocksRaw, getAttr, getAttrRaw, getMDArrayAttr, getMDArrayAttrRaw, getMDArrayNaturalBlocks, getMDArrayNaturalBlocksRaw, read, readArray, readArrayBlock, readArrayBlockRaw, readArrayBlockWithOffset, readArrayBlockWithOffsetRaw, readArrayRaw, readMDArray, readMDArrayBlock, readMDArrayBlockRaw, readMDArrayBlockWithOffset, readMDArrayBlockWithOffsetRaw, readMDArrayRaw, readRaw

Methods inherited from class java.lang.Object

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

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

getArrayAttr, getArrayAttrRaw, getArrayNaturalBlocks, getArrayNaturalBlocksRaw, getAttr, getAttrRaw, getMDArrayAttr, getMDArrayAttrRaw, getMDArrayNaturalBlocks, getMDArrayNaturalBlocksRaw, read, readArray, readArrayBlock, readArrayBlockRaw, readArrayBlockWithOffset, readArrayBlockWithOffsetRaw, readArrayRaw, readMDArray, readMDArrayBlock, readMDArrayBlockRaw, readMDArrayBlockWithOffset, readMDArrayBlockWithOffsetRaw, readMDArrayRaw, readRaw

Method Detail

setAttrVL

public void setAttrVL(java.lang.String objectPath,
                      java.lang.String name,
                      java.lang.String value)

Description copied from interface: IHDF5StringWriter

Sets a string attribute with variable length 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:

setAttrVL in interface IHDF5StringWriter

Parameters:

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

name - The name of the attribute.

value - The value of the attribute.

setAttr

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

Description copied from interface: IHDF5StringWriter

Sets a string 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 IHDF5StringWriter

Parameters:

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

name - The name of the attribute.

value - The value of the attribute.

setAttr

public void setAttr(java.lang.String objectPath,
                    java.lang.String name,
                    java.lang.String value,
                    int maxLength)

Description copied from interface: IHDF5StringWriter

Sets a string 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 IHDF5StringWriter

Parameters:

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

name - The name of the attribute.

value - The value of the attribute.

maxLength - The maximal length of the value.

setArrayAttr

public void setArrayAttr(java.lang.String objectPath,
                         java.lang.String name,
                         java.lang.String[] value)

Description copied from interface: IHDF5StringWriter

Sets a string array attribute on the referenced object. The length of the array is taken to be the longest string in value.

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

Specified by:

setArrayAttr in interface IHDF5StringWriter

Parameters:

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

name - The name of the attribute.

value - The value of the attribute.

setArrayAttr

public void setArrayAttr(java.lang.String objectPath,
                         java.lang.String name,
                         java.lang.String[] value,
                         int maxLength)

Description copied from interface: IHDF5StringWriter

Sets a string 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.

Specified by:

setArrayAttr in interface IHDF5StringWriter

Parameters:

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

name - The name of the attribute.

value - The value of the attribute.

maxLength - The maximal length of any element in value.

setMDArrayAttr

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

Description copied from interface: IHDF5StringWriter

Sets a multi-dimensional string array attribute on the referenced object. The length of the array is taken to be the longest string in value.

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

Specified by:

setMDArrayAttr in interface IHDF5StringWriter

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

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

Description copied from interface: IHDF5StringWriter

Sets a multi-dimensional string 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.

Specified by:

setMDArrayAttr in interface IHDF5StringWriter

Parameters:

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

name - The name of the attribute.

value - The value of the attribute.

maxLength - The maximal length of the value.

write

public void write(java.lang.String objectPath,
                  java.lang.String data,
                  int maxLength)

Description copied from interface: IHDF5StringWriter

Writes out a String with a fixed maximal length.

Specified by:

write in interface IHDF5StringWriter

Parameters:

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

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

maxLength - The maximal length of the data.

write

public void write(java.lang.String objectPath,
                  java.lang.String data)

Description copied from interface: IHDF5StringWriter

Writes out a String with a fixed maximal length (which is the length of the string data).

Specified by:

write in interface IHDF5StringWriter

Parameters:

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

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

write

public void write(java.lang.String objectPath,
                  java.lang.String data,
                  HDF5GenericStorageFeatures features)

Description copied from interface: IHDF5StringWriter

Writes out a String with a fixed maximal length.

Specified by:

write in interface IHDF5StringWriter

Parameters:

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

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

features - The storage features of the data set.

write

public void write(java.lang.String objectPath,
                  java.lang.String data,
                  int maxLength,
                  HDF5GenericStorageFeatures features)

Description copied from interface: IHDF5StringWriter

Writes out a String with a fixed maximal length.

Specified by:

write in interface IHDF5StringWriter

Parameters:

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

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

maxLength - The maximal length of the data.

features - The storage features of the data set.

writeArray

public void writeArray(java.lang.String objectPath,
                       java.lang.String[] data,
                       HDF5GenericStorageFeatures features)

Description copied from interface: IHDF5StringWriter

Writes out a String array (of rank 1).

Specified by:

writeArray in interface IHDF5StringWriter

Parameters:

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

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

features - The storage features of the data set.

writeArray

public void writeArray(java.lang.String objectPath,
                       java.lang.String[] data)

Description copied from interface: IHDF5StringWriter

Writes out a String array (of rank 1). Each element of the array will have a fixed maximal length which is defined by the longest string in data.

Specified by:

writeArray in interface IHDF5StringWriter

Parameters:

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

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

writeArray

public void writeArray(java.lang.String objectPath,
                       java.lang.String[] data,
                       int maxLength)

Description copied from interface: IHDF5StringWriter

Writes out a String array (of rank 1). Each element of the array will have a fixed maximal length which is given by maxLength.

Specified by:

writeArray in interface IHDF5StringWriter

Parameters:

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

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

maxLength - The maximal length of any of the strings in data.

writeArray

public void writeArray(java.lang.String objectPath,
                       java.lang.String[] data,
                       int maxLength,
                       HDF5GenericStorageFeatures features)
                throws HDF5JavaException

Description copied from interface: IHDF5StringWriter

Writes out a String array (of rank 1). Each element of the array will have a fixed maximal length which is given by maxLength.

Specified by:

writeArray in interface IHDF5StringWriter

Parameters:

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

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

maxLength - The maximal length of any of the strings in data.

features - The storage features of the data set.

Throws:

HDF5JavaException

createArray

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

Description copied from interface: IHDF5StringWriter

Creates a String array (of rank 1) for Strings of length maxLength.

Specified by:

createArray in interface IHDF5StringWriter

Parameters:

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

maxLength - The maximal length of one String in the array.

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

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

Description copied from interface: IHDF5StringWriter

Creates a String array (of rank 1) for Strings of length maxLength.

Specified by:

createArray in interface IHDF5StringWriter

Parameters:

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

maxLength - The maximal length of one String in the array.

size - The size of the String array to create. When using extendable data sets ((see IHDF5WriterConfigurator.dontUseExtendableDataTypes())), then no data set smaller than this size can be created, however data sets may be larger.

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

createArray

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

Description copied from interface: IHDF5StringWriter

Creates a String array (of rank 1) for Strings of length maxLength.

Specified by:

createArray in interface IHDF5StringWriter

Parameters:

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

maxLength - The maximal length of one String in the array.

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.

createArray

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

Description copied from interface: IHDF5StringWriter

Creates a String array (of rank 1) for Strings of length maxLength.

Specified by:

createArray in interface IHDF5StringWriter

Parameters:

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

maxLength - The maximal length of one String in the array.

size - The size of the String array to create. When using extendable data sets ((see IHDF5WriterConfigurator.dontUseExtendableDataTypes())), then no data set smaller than this size can be created, however data sets may be larger.

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

features - The storage features of the data set.

writeArrayBlock

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

Description copied from interface: IHDF5StringWriter

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

Specified by:

writeArrayBlock in interface IHDF5StringWriter

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,
                                      java.lang.String[] data,
                                      int dataSize,
                                      long offset)

Description copied from interface: IHDF5StringWriter

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

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

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

Specified by:

writeArrayBlockWithOffset in interface IHDF5StringWriter

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

public void writeMDArray(java.lang.String objectPath,
                         ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> data)
                  throws HDF5JavaException

Description copied from interface: IHDF5StringWriter

Writes out a String array (of rank N). Each element of the array will have a fixed maximal length which is defined by the longest string in data.

Specified by:

writeMDArray in interface IHDF5StringWriter

Parameters:

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

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

Throws:

HDF5JavaException

writeMDArray

public void writeMDArray(java.lang.String objectPath,
                         ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> data,
                         HDF5GenericStorageFeatures features)
                  throws HDF5JavaException

Description copied from interface: IHDF5StringWriter

Writes out a String array (of rank N). Each element of the array will have a fixed maximal length which is defined by the longest string in data.

Specified by:

writeMDArray in interface IHDF5StringWriter

Parameters:

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

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

features - The storage features of the data set.

Throws:

HDF5JavaException

writeMDArray

public void writeMDArray(java.lang.String objectPath,
                         ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> data,
                         int maxLength)
                  throws HDF5JavaException

Description copied from interface: IHDF5StringWriter

Writes out a String array (of rank N). Each element of the array will have a fixed maximal length which is given by maxLength.

Specified by:

writeMDArray in interface IHDF5StringWriter

Parameters:

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

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

maxLength - The maximal length of any of the strings in data.

Throws:

HDF5JavaException

writeMDArray

public void writeMDArray(java.lang.String objectPath,
                         ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> data,
                         int maxLength,
                         HDF5GenericStorageFeatures features)
                  throws HDF5JavaException

Description copied from interface: IHDF5StringWriter

Writes out a String array (of rank N). Each element of the array will have a fixed maximal length which is given by maxLength.

Specified by:

writeMDArray in interface IHDF5StringWriter

Parameters:

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

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

maxLength - The maximal length of any of the strings in data.

features - The storage features of the data set.

Throws:

HDF5JavaException

createMDArray

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

Description copied from interface: IHDF5StringWriter

Creates a String array (of rank N) for Strings of length maxLength.

Specified by:

createMDArray in interface IHDF5StringWriter

Parameters:

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

maxLength - The maximal length of one String in the array.

dimensions - The size of the String array to create. When using extendable data sets ((see IHDF5WriterConfigurator.dontUseExtendableDataTypes())), then no data set smaller than this size can be created, however data sets may be larger.

createMDArray

public void createMDArray(java.lang.String objectPath,
                          int maxLength,
                          long[] dimensions,
                          int[] blockSize)

Description copied from interface: IHDF5StringWriter

Creates a String array (of rank N) for Strings of length maxLength.

Specified by:

createMDArray in interface IHDF5StringWriter

Parameters:

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

maxLength - The maximal length of one String in the array.

dimensions - The size of the String array to create. When using extendable data sets ((see IHDF5WriterConfigurator.dontUseExtendableDataTypes())), then no data set smaller than this size can be created, however data sets may be larger.

blockSize - The size of one block in each dimension (for block-wise IO). Ignored if no extendable data sets are used (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()).

createMDArray

public void createMDArray(java.lang.String objectPath,
                          int maxLength,
                          int[] dimensions,
                          HDF5GenericStorageFeatures features)

Description copied from interface: IHDF5StringWriter

Creates a String array (of rank N) for Strings of length maxLength.

Specified by:

createMDArray in interface IHDF5StringWriter

Parameters:

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

maxLength - The maximal length of one String in the array.

dimensions - The size of the String array to create. When using extendable data sets ((see IHDF5WriterConfigurator.dontUseExtendableDataTypes())), then no data set smaller than this size can be created, however data sets may be larger.

features - The storage features of the data set.

createMDArray

public void createMDArray(java.lang.String objectPath,
                          int maxLength,
                          long[] dimensions,
                          int[] blockSize,
                          HDF5GenericStorageFeatures features)

Description copied from interface: IHDF5StringWriter

Creates a String array (of rank N) for Strings of length maxLength.

Specified by:

createMDArray in interface IHDF5StringWriter

Parameters:

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

maxLength - The maximal length of one String in the array.

dimensions - The size of the String array to create. When using extendable data sets ((see IHDF5WriterConfigurator.dontUseExtendableDataTypes())), then no data set smaller than this size can be created, however data sets may be larger.

blockSize - The size of one block in each dimension (for block-wise IO). Ignored if no extendable data sets are used (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()).

features - The storage features of the data set.

writeMDArrayBlock

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

Description copied from interface: IHDF5StringWriter

Writes out a block of a String array (of rank N). The data set needs to have been created by IHDF5StringWriter.createMDArray(String, int, 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 IHDF5StringWriter.createMDArray(String, int, long[], int[], HDF5GenericStorageFeatures) call that was used to create the data set.

Specified by:

writeMDArrayBlock in interface IHDF5StringWriter

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 in each dimension.

writeMDArrayBlockWithOffset

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

Description copied from interface: IHDF5StringWriter

Writes out a block of a String array (of rank N). The data set needs to have been created by IHDF5StringWriter.createMDArray(String, int, 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 IHDF5StringWriter.createMDArray(String, int, long[], int[], HDF5GenericStorageFeatures) call that was used to create the data set.

Specified by:

writeMDArrayBlockWithOffset in interface IHDF5StringWriter

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.

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

writeVL

public void writeVL(java.lang.String objectPath,
                    java.lang.String data)

Description copied from interface: IHDF5StringWriter

Writes out a String with variable maximal length.

The advantage of this method over IHDF5StringWriter.write(String, String) is that when writing a new string later it can have a different (also greater) length. The disadvantage is that it it is more time consuming to read and write this kind of string and that it can't be compressed.

Specified by:

writeVL in interface IHDF5StringWriter

Parameters:

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

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

writeArrayVL

public void writeArrayVL(java.lang.String objectPath,
                         java.lang.String[] data)

Description copied from interface: IHDF5StringWriter

Writes out a String[] where each String of the array has a variable maximal length.

The advantage of this method over IHDF5StringWriter.writeArray(String, String[]) is that when writing a new string later it can have a different (also greater) length. The disadvantage is that it it is more time consuming to read and write this kind of string and that it can't be compressed.

Specified by:

writeArrayVL in interface IHDF5StringWriter

Parameters:

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

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

writeArrayVL

public void writeArrayVL(java.lang.String objectPath,
                         java.lang.String[] data,
                         HDF5GenericStorageFeatures features)

Description copied from interface: IHDF5StringWriter

Writes out a String[] where each String of the array has a variable maximal length.

The advantage of this method over IHDF5StringWriter.writeArray(String, String[]) is that when writing a new string later it can have a different (also greater) length. The disadvantage is that it it is more time consuming to read and write this kind of string and that it can't be compressed.

Specified by:

writeArrayVL in interface IHDF5StringWriter

Parameters:

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

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

features - The storage features of the data set.

createArrayVL

public void createArrayVL(java.lang.String objectPath,
                          int size)

Description copied from interface: IHDF5StringWriter

Creates a String[] where each String of the array has a variable maximal length.

Specified by:

createArrayVL in interface IHDF5StringWriter

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

createArrayVL

public void createArrayVL(java.lang.String objectPath,
                          long size,
                          int blockSize)
                   throws HDF5JavaException

Description copied from interface: IHDF5StringWriter

Creates a String[] where each String of the array has a variable maximal length.

Specified by:

createArrayVL in interface IHDF5StringWriter

Parameters:

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

size - The intial size of the array.

blockSize - The size of block in the array.

Throws:

HDF5JavaException

createArrayVL

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

Description copied from interface: IHDF5StringWriter

Creates a String[] where each String of the array has a variable maximal length.

Specified by:

createArrayVL in interface IHDF5StringWriter

Parameters:

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

size - The initial size of the array.

blockSize - The size of block in the array.

features - The storage features of the data set.

createArrayVL

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

Description copied from interface: IHDF5StringWriter

Creates a String[] where each String of the array has a variable maximal length.

Specified by:

createArrayVL in interface IHDF5StringWriter

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

features - The storage features of the data set.

createMDArrayVL

public void createMDArrayVL(java.lang.String objectPath,
                            int[] dimensions,
                            HDF5GenericStorageFeatures features)

Description copied from interface: IHDF5StringWriter

Creates a multi-dimensional String array where each String of the array has a variable maximal length.

Specified by:

createMDArrayVL in interface IHDF5StringWriter

Parameters:

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

dimensions - The initial dimensions (along each axis) of the array.

features - The storage features of the data set.

createMDArrayVL

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

Description copied from interface: IHDF5StringWriter

Creates a multi-dimensional String array where each String of the array has a variable maximal length.

Specified by:

createMDArrayVL in interface IHDF5StringWriter

Parameters:

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

dimensions - The initial dimensions (along each axis) of the array.

createMDArrayVL

public void createMDArrayVL(java.lang.String objectPath,
                            long[] dimensions,
                            int[] blockSize,
                            HDF5GenericStorageFeatures features)

Description copied from interface: IHDF5StringWriter

Creates a multi-dimensional String array where each String of the array has a variable maximal length.

Specified by:

createMDArrayVL in interface IHDF5StringWriter

Parameters:

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

dimensions - The initial dimensions (along each axis) of the array.

blockSize - The size of a contiguously stored block (along each axis) in the array.

features - The storage features of the data set.

createMDArrayVL

public void createMDArrayVL(java.lang.String objectPath,
                            long[] dimensions,
                            int[] blockSize)

Description copied from interface: IHDF5StringWriter

Creates a multi-dimensional String array where each String of the array has a variable maximal length.

Specified by:

createMDArrayVL in interface IHDF5StringWriter

Parameters:

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

dimensions - The initial dimensions (along each axis) of the array.

blockSize - The size of a contiguously stored block (along each axis) in the array.

writeMDArrayVL

public void writeMDArrayVL(java.lang.String objectPath,
                           ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> data,
                           HDF5GenericStorageFeatures features)

Description copied from interface: IHDF5StringWriter

Writes out a String array (of rank N). Each element of the array will have a variable maximal length.

Specified by:

writeMDArrayVL in interface IHDF5StringWriter

Parameters:

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

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

features - The storage features of the data set.

writeMDArrayVL

public void writeMDArrayVL(java.lang.String objectPath,
                           ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> data)

Description copied from interface: IHDF5StringWriter

Writes out a String array (of rank N). Each element of the array will have a variable maximal length.

Specified by:

writeMDArrayVL in interface IHDF5StringWriter

Parameters:

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

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