ch.systemsx.cisd.hdf5

Interface IHDF5StringReader

All Known Subinterfaces:

IHDF5StringWriter

All Known Implementing Classes:

HDF5StringReader, HDF5StringWriter

public interface IHDF5StringReader

An interface that provides methods for reading String values from HDF5 files.

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

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getArrayAttr(java.lang.String objectPath, java.lang.String attributeName) Reads a string array attribute named attributeName from the object objectPath.
java.lang.String[]	getArrayAttrRaw(java.lang.String objectPath, java.lang.String attributeName) Reads a string array attribute named attributeName from the object objectPath.
java.lang.Iterable<HDF5DataBlock<java.lang.String[]>>	getArrayNaturalBlocks(java.lang.String objectPath) Provides all natural blocks of this one-dimensional string data set to iterate over.
java.lang.Iterable<HDF5DataBlock<java.lang.String[]>>	getArrayNaturalBlocksRaw(java.lang.String objectPath) Provides all natural blocks of this one-dimensional string data set to iterate over.
java.lang.String	getAttr(java.lang.String objectPath, java.lang.String attributeName) Reads a string attribute named attributeName from the object objectPath.
java.lang.String	getAttrRaw(java.lang.String objectPath, java.lang.String attributeName) Reads a string attribute named attributeName from the object objectPath.
ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String>	getMDArrayAttr(java.lang.String objectPath, java.lang.String attributeName) Reads a multi-dimensional string array attribute named attributeName from the object objectPath.
ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String>	getMDArrayAttrRaw(java.lang.String objectPath, java.lang.String attributeName) Reads a multi-dimensional string array attribute named attributeName from the object objectPath.
java.lang.Iterable<HDF5MDDataBlock<ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String>>>	getMDArrayNaturalBlocks(java.lang.String objectPath) Provides all natural blocks of this multi-dimensional string data set to iterate over.
java.lang.Iterable<HDF5MDDataBlock<ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String>>>	getMDArrayNaturalBlocksRaw(java.lang.String objectPath) Provides all natural blocks of this multi-dimensional string data set to iterate over.
java.lang.String	read(java.lang.String objectPath) Reads a string from the data set objectPath.
java.lang.String[]	readArray(java.lang.String objectPath) Reads a string array (of rank 1) from the data set objectPath.
java.lang.String[]	readArrayBlock(java.lang.String objectPath, int blockSize, long blockNumber) Reads a block of a string array (of rank 1) from the data set objectPath.
java.lang.String[]	readArrayBlockRaw(java.lang.String objectPath, int blockSize, long blockNumber) Reads a block of a string array (of rank 1) from the data set objectPath.
java.lang.String[]	readArrayBlockWithOffset(java.lang.String objectPath, int blockSize, long offset) Reads a block of a string array (of rank 1) from the data set objectPath.
java.lang.String[]	readArrayBlockWithOffsetRaw(java.lang.String objectPath, int blockSize, long offset) Reads a block of a string array (of rank 1) from the data set objectPath.
java.lang.String[]	readArrayRaw(java.lang.String objectPath) Reads a string array (of rank 1) from the data set objectPath.
ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String>	readMDArray(java.lang.String objectPath) Reads a string array (of rank N) from the data set objectPath.
ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String>	readMDArrayBlock(java.lang.String objectPath, int[] blockDimensions, long[] blockNumber) Reads a block of a string array (of rank N) from the data set objectPath.
ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String>	readMDArrayBlockRaw(java.lang.String objectPath, int[] blockDimensions, long[] blockNumber) Reads a block of a string array (of rank N) from the data set objectPath.
ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String>	readMDArrayBlockWithOffset(java.lang.String objectPath, int[] blockDimensions, long[] offset) Reads a block of a string array (of rank N) from the data set objectPath.
ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String>	readMDArrayBlockWithOffsetRaw(java.lang.String objectPath, int[] blockDimensions, long[] offset) Reads a block of a string array (of rank N) from the data set objectPath.
ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String>	readMDArrayRaw(java.lang.String objectPath) Reads a string array (of rank N) from the data set objectPath.
java.lang.String	readRaw(java.lang.String objectPath) Reads a String from the data set objectPath.

Method Detail

getAttr

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

Reads a string attribute named attributeName from the object objectPath. Considers '\0' as end of string.

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 attribute value read from the data set.

getAttrRaw

java.lang.String getAttrRaw(java.lang.String objectPath,
                            java.lang.String attributeName)

Reads a string attribute named attributeName from the object objectPath. Does not consider '\0' as end of string but reads the full length of the attribute.

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 attribute value read from the data set.

getArrayAttr

java.lang.String[] getArrayAttr(java.lang.String objectPath,
                                java.lang.String attributeName)

Reads a string array attribute named attributeName from the object objectPath. Considers '\0' as end of string.

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 attribute value read from the data set.

getArrayAttrRaw

java.lang.String[] getArrayAttrRaw(java.lang.String objectPath,
                                   java.lang.String attributeName)

Reads a string array attribute named attributeName from the object objectPath. Does not consider '\0' as end of string but reads the full length.

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 attribute value read from the data set.

getMDArrayAttr

ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> getMDArrayAttr(java.lang.String objectPath,
                                                                       java.lang.String attributeName)

Reads a multi-dimensional string array attribute named attributeName from the object objectPath. Considers '\0' as end of string.

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 attribute value read from the data set.

getMDArrayAttrRaw

ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> getMDArrayAttrRaw(java.lang.String objectPath,
                                                                          java.lang.String attributeName)

Reads a multi-dimensional string array attribute named attributeName from the object objectPath. Does not consider '\0' as end of string but reads the full length.

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 attribute value read from the data set.

read

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

Reads a string from the data set objectPath. Considers '\0' as end of string. This needs to be a string type.

Parameters:

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

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a string type.

readRaw

java.lang.String readRaw(java.lang.String objectPath)
                  throws HDF5JavaException

Reads a String from the data set objectPath. Does not consider '\0' as end of string but reads the full length of the string. This needs to be a string type.

Parameters:

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

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a string type.

readArray

java.lang.String[] readArray(java.lang.String objectPath)
                      throws HDF5JavaException

Reads a string array (of rank 1) from the data set objectPath. The elements of this data set need to be a string type. Considers '\0' as end of string.

Parameters:

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

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a string type.

readArrayRaw

java.lang.String[] readArrayRaw(java.lang.String objectPath)
                         throws HDF5JavaException

Reads a string array (of rank 1) from the data set objectPath. The elements of this data set need to be a string type. Does not consider '\0' as end of string but reads the full length.

Parameters:

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

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a string type.

readArrayBlock

java.lang.String[] readArrayBlock(java.lang.String objectPath,
                                  int blockSize,
                                  long blockNumber)

Reads a block of a string array (of rank 1) from the data set objectPath. The elements of this data set need to be a string type. Considers '\0' as end of string.

Parameters:

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

blockSize - The size of the block to read from the data set.

blockNumber - The number of the block to read from the data set (the offset is blockSize * blockNumber).

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a string type.

readArrayBlockRaw

java.lang.String[] readArrayBlockRaw(java.lang.String objectPath,
                                     int blockSize,
                                     long blockNumber)

Reads a block of a string array (of rank 1) from the data set objectPath. The elements of this data set need to be a string type. Does not consider '\0' as end of string but reads the full length.

Parameters:

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

blockSize - The size of the block to read from the data set.

blockNumber - The number of the block to read from the data set (the offset is blockSize * blockNumber).

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a string type.

readArrayBlockWithOffset

java.lang.String[] readArrayBlockWithOffset(java.lang.String objectPath,
                                            int blockSize,
                                            long offset)

Reads a block of a string array (of rank 1) from the data set objectPath. The elements of this data set need to be a string type. Considers '\0' as end of string.

Parameters:

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

blockSize - The size of the block to read from the data set.

offset - The offset of the block in the data set.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a string type.

readArrayBlockWithOffsetRaw

java.lang.String[] readArrayBlockWithOffsetRaw(java.lang.String objectPath,
                                               int blockSize,
                                               long offset)

Reads a block of a string array (of rank 1) from the data set objectPath. The elements of this data set need to be a string type. Does not consider '\0' as end of string but reads the full length.

Parameters:

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

blockSize - The size of the block to read from the data set.

offset - The offset of the block in the data set.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a string type.

readMDArray

ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> readMDArray(java.lang.String objectPath)

Reads a string array (of rank N) from the data set objectPath. The elements of this data set need to be a string type. Considers '\0' as end of string.

Parameters:

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

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a string type.

readMDArrayRaw

ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> readMDArrayRaw(java.lang.String objectPath)

Reads a string array (of rank N) from the data set objectPath. The elements of this data set need to be a string type. Does not considers '\0' as end of string but reads the full length.

Parameters:

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

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a string type.

readMDArrayBlock

ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> readMDArrayBlock(java.lang.String objectPath,
                                                                         int[] blockDimensions,
                                                                         long[] blockNumber)

Reads a block of a string array (of rank N) from the data set objectPath. The elements of this data set need to be a string type. Considers '\0' as end of string. Considers '\0' as end of string.

Parameters:

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

blockDimensions - The dimensions (along each axis) of the block to read from the data set.

blockNumber - The number of the block to read from the data set (the offset in each dimension i is blockSize[i] * blockNumber[i]).

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a string type.

readMDArrayBlockRaw

ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> readMDArrayBlockRaw(java.lang.String objectPath,
                                                                            int[] blockDimensions,
                                                                            long[] blockNumber)

Reads a block of a string array (of rank N) from the data set objectPath. The elements of this data set need to be a string type. Does not consider '\0' as end of string but reads the full length.

Parameters:

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

blockDimensions - The dimensions (along each axis) of the block to read from the data set.

blockNumber - The number of the block to read from the data set (the offset in each dimension i is blockSize[i] * blockNumber[i]).

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a string type.

readMDArrayBlockWithOffset

ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> readMDArrayBlockWithOffset(java.lang.String objectPath,
                                                                                   int[] blockDimensions,
                                                                                   long[] offset)

Reads a block of a string array (of rank N) from the data set objectPath. The elements of this data set need to be a string type. Considers '\0' as end of string.

Parameters:

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

blockDimensions - The dimensions (along each axis) of the block to read from the data set.

offset - The offset of the block in the data set.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a string type.

readMDArrayBlockWithOffsetRaw

ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String> readMDArrayBlockWithOffsetRaw(java.lang.String objectPath,
                                                                                      int[] blockDimensions,
                                                                                      long[] offset)

Reads a block of a string array (of rank N) from the data set objectPath. The elements of this data set need to be a string type. Does not consider '\0' as end of string but reads the full length.

Parameters:

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

blockDimensions - The dimensions (along each axis) of the block to read from the data set.

offset - The offset of the block in the data set.

Returns:

The data read from the data set.

Throws:

HDF5JavaException - If the objectPath is not a string type.

getArrayNaturalBlocks

java.lang.Iterable<HDF5DataBlock<java.lang.String[]>> getArrayNaturalBlocks(java.lang.String objectPath)
                                                                     throws HDF5JavaException

Provides all natural blocks of this one-dimensional string data set to iterate over. Considers '\0' as end of string.

Parameters:

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

Throws:

HDF5JavaException - If the data set is not of rank 1.

See Also:

HDF5DataBlock

getArrayNaturalBlocksRaw

java.lang.Iterable<HDF5DataBlock<java.lang.String[]>> getArrayNaturalBlocksRaw(java.lang.String objectPath)
                                                                        throws HDF5JavaException

Provides all natural blocks of this one-dimensional string data set to iterate over. Does not consider '\0' as end of string but reads the full length.

Parameters:

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

Throws:

HDF5JavaException - If the data set is not of rank 1.

See Also:

HDF5DataBlock

getMDArrayNaturalBlocks

java.lang.Iterable<HDF5MDDataBlock<ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String>>> getMDArrayNaturalBlocks(java.lang.String objectPath)

Provides all natural blocks of this multi-dimensional string data set to iterate over. Considers '\0' as end of string.

See Also:

HDF5MDDataBlock

getMDArrayNaturalBlocksRaw

java.lang.Iterable<HDF5MDDataBlock<ch.systemsx.cisd.base.mdarray.MDArray<java.lang.String>>> getMDArrayNaturalBlocksRaw(java.lang.String objectPath)

Provides all natural blocks of this multi-dimensional string data set to iterate over. Does not consider '\0' as end of string but reads the full length.

See Also:

HDF5MDDataBlock