ch.systemsx.cisd.hdf5

Interface IHDF5StringWriter

All Superinterfaces:

IHDF5StringReader

All Known Implementing Classes:

HDF5StringWriter

public interface IHDF5StringWriter
extends IHDF5StringReader

An interface that provides methods for writing String values to HDF5 files.

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

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

setAttr

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

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.

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

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

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.

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

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

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.

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

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.

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

Parameters:

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

name - The name of the attribute.

value - The value of the attribute.

maxLength - The maximal length of any element in value.

setMDArrayAttr

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

Parameters:

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

name - The name of the attribute.

value - The value of the attribute.

setMDArrayAttr

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

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.

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.

setAttrVL

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.

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

Parameters:

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

name - The name of the attribute.

value - The value of the attribute.

write

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

Writes out a String with a fixed maximal length.

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

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

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

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

Writes out a String with a fixed maximal length.

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

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

Writes out a String with a fixed maximal length.

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

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

Writes out a String array (of rank 1).

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

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

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.

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

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

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

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

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

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

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.

writeMDArray

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

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.

Parameters:

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

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

writeMDArray

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). Each element of the array will have a fixed maximal length which is defined by the longest string in data.

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.

writeMDArray

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). Each element of the array will have a fixed maximal length which is given by maxLength.

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.

writeMDArray

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). Each element of the array will have a fixed maximal length which is given by maxLength.

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.

createArray

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

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

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

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

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

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

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

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

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

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.

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

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

Writes out a block of a String array (of rank 1). The data set needs to have been created by 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 createArray(String, int, long, int, 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,
                               java.lang.String[] data,
                               int dataSize,
                               long offset)

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

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

createMDArray

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

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

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

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

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

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

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

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

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

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.

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

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). The data set needs to have been created by 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 createMDArray(String, int, long[], int[], 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 in each dimension.

writeMDArrayBlockWithOffset

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). The data set needs to have been created by 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 createMDArray(String, int, long[], int[], 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.

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

writeVL

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

Writes out a String with variable maximal length.

The advantage of this method over 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.

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

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.

The advantage of this method over 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.

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

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.

The advantage of this method over 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.

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

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

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

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

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

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

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.

createArrayVL

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.

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

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

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

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

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.

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

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.

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

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.

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

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.

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

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

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

Parameters:

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

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

writeMDArrayVL

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). Each element of the array will have a variable maximal length.

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.