ch.systemsx.cisd.hdf5

Interface IHDF5CompoundWriter

All Superinterfaces:

IHDF5CompoundInformationRetriever, IHDF5CompoundReader

public interface IHDF5CompoundWriter
extends IHDF5CompoundReader

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

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

Nested Class Summary

Nested classes/interfaces inherited from interface ch.systemsx.cisd.hdf5.IHDF5CompoundInformationRetriever

IHDF5CompoundInformationRetriever.IByteArrayInspector

Method Summary

Modifier and Type	Method and Description
<T> void	createArray(java.lang.String objectPath, HDF5CompoundType<T> type, int size) Creates an array (of rank 1) of compound values.
<T> void	createArray(java.lang.String objectPath, HDF5CompoundType<T> type, long size, HDF5GenericStorageFeatures features) Creates an array (of rank 1) of compound values.
<T> void	createArray(java.lang.String objectPath, HDF5CompoundType<T> type, long size, int blockSize) Creates an array (of rank 1) of compound values.
<T> void	createArray(java.lang.String objectPath, HDF5CompoundType<T> type, long size, int blockSize, HDF5GenericStorageFeatures features) Creates an array (of rank 1) of compound values.
<T> void	createMDArray(java.lang.String objectPath, HDF5CompoundType<T> type, int[] dimensions) Creates an array (of rank N) of compound values.
<T> void	createMDArray(java.lang.String objectPath, HDF5CompoundType<T> type, int[] dimensions, HDF5GenericStorageFeatures features) Creates an array (of rank N) of compound values.
<T> void	createMDArray(java.lang.String objectPath, HDF5CompoundType<T> type, long[] dimensions, int[] blockDimensions) Creates an array (of rank N) of compound values.
<T> void	createMDArray(java.lang.String objectPath, HDF5CompoundType<T> type, long[] dimensions, int[] blockDimensions, HDF5GenericStorageFeatures features) Creates an array (of rank N) of compound values.
<T> HDF5CompoundType<T>	getAnonType(java.lang.Class<T> pojoClass, HDF5CompoundMemberMapping... members) Returns the anonymous compound type for this HDF5 file, using the default name chosen by JHDF5 which is based on the simple name of pojoClass.
<T> HDF5CompoundType<T>	getClonedType(HDF5CompoundType<T> templateType) Returns the compound type cloned from the given templateType.
<T> HDF5CompoundType<T>	getInferredAnonType(java.lang.Class<T> pojoClass) Returns the anonymous compound type name> for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection.
<T> HDF5CompoundType<T>	getInferredAnonType(java.lang.Class<T> pojoClass, HDF5CompoundMappingHints hints) Returns the anonymous compound type name> for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection.
HDF5CompoundType<java.util.List<?>>	getInferredAnonType(java.util.List<java.lang.String> memberNames, java.util.List<?> template) Returns the anonymous compound type for this HDF5 file, inferring the mapping from the Java types of the members.
HDF5CompoundType<java.util.List<?>>	getInferredAnonType(java.util.List<java.lang.String> memberNames, java.util.List<?> template, HDF5CompoundMappingHints hints) Returns the anonymous compound type for this HDF5 file, inferring the mapping from the Java types of the members.
HDF5CompoundType<java.lang.Object[]>	getInferredAnonType(java.lang.String[] memberNames, java.lang.Object[] template) Returns the anonymous compound type for this HDF5 file, inferring the mapping from the Java types of the members.
HDF5CompoundType<java.lang.Object[]>	getInferredAnonType(java.lang.String[] memberNames, java.lang.Object[] template, HDF5CompoundMappingHints hints) Returns the anonymous compound type for this HDF5 file, inferring the mapping from the Java types of the members.
<T> HDF5CompoundType<T>	getInferredAnonType(T template) Returns the anonymous compound type for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection and using the default name chosen by JHDF5 which is based on the simple name of T.
<T> HDF5CompoundType<T>	getInferredAnonType(T[] template) Returns the anonymous compound type name> for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection.
<T> HDF5CompoundType<T>	getInferredAnonType(T[] template, HDF5CompoundMappingHints hints) Returns the anonymous compound type name> for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection.
<T> HDF5CompoundType<T>	getInferredAnonType(T template, HDF5CompoundMappingHints hints) Returns anonyous the compound type name> for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection.
<T> void	setArrayAttr(java.lang.String objectPath, java.lang.String attributeName, HDF5CompoundType<T> type, T[] value) Sets a compound attribute array (of rank 1) to the referenced object.
<T> void	setArrayAttr(java.lang.String objectPath, java.lang.String attributeName, T[] value) Sets a compound attribute array (of rank 1) to the referenced object.
<T> void	setAttr(java.lang.String objectPath, java.lang.String attributeName, HDF5CompoundType<T> type, T value) Sets a compound attribute to the referenced object.
<T> void	setAttr(java.lang.String objectPath, java.lang.String attributeName, T value) Sets a compound attribute to the referenced object.
<T> void	setMDArrayAttr(java.lang.String objectPath, java.lang.String attributeName, HDF5CompoundType<T> type, ch.systemsx.cisd.base.mdarray.MDArray<T> value) Sets a compound attribute array (of rank N) to the referenced object.
<T> void	setMDArrayAttr(java.lang.String objectPath, java.lang.String attributeName, ch.systemsx.cisd.base.mdarray.MDArray<T> value) Sets a compound attribute array (of rank N) to the referenced object.
<T> void	write(java.lang.String objectPath, HDF5CompoundType<T> type, T data) Writes out a compound value of type given in data.
<T> void	write(java.lang.String objectPath, HDF5CompoundType<T> type, T data, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Writes out an array (of rank 1) of compound values.
<T> void	write(java.lang.String objectPath, T data) Writes out a compound value.
<T> void	writeArray(java.lang.String objectPath, HDF5CompoundType<T> type, T[] data) Writes out an array (of rank 1) of compound values.
<T> void	writeArray(java.lang.String objectPath, HDF5CompoundType<T> type, T[] data, HDF5GenericStorageFeatures features) Writes out an array (of rank 1) of compound values.
<T> void	writeArray(java.lang.String objectPath, HDF5CompoundType<T> type, T[] data, HDF5GenericStorageFeatures features, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Writes out an array (of rank 1) of compound values.
<T> void	writeArray(java.lang.String objectPath, T[] data) Writes out an array (of rank 1) of compound values.
<T> void	writeArray(java.lang.String objectPath, T[] data, HDF5GenericStorageFeatures features) Writes out an array (of rank 1) of compound values.
<T> void	writeArrayBlock(java.lang.String objectPath, HDF5CompoundType<T> type, T[] data, long blockNumber) Writes out a block blockNumber of an array (of rank 1) of compound values.
<T> void	writeArrayBlock(java.lang.String objectPath, HDF5CompoundType<T> type, T[] data, long blockNumber, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Writes out a block blockNumber of an array (of rank 1) of compound values.
<T> void	writeArrayBlockWithOffset(java.lang.String objectPath, HDF5CompoundType<T> type, T[] data, long offset) Writes out a block of an array (of rank 1) of compound values with given offset.
<T> void	writeArrayBlockWithOffset(java.lang.String objectPath, HDF5CompoundType<T> type, T[] data, long offset, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Writes out a block of an array (of rank 1) of compound values with given offset.
<T> void	writeMDArray(java.lang.String objectPath, HDF5CompoundType<T> type, ch.systemsx.cisd.base.mdarray.MDArray<T> data) Writes out an array (of rank N) of compound values.
<T> void	writeMDArray(java.lang.String objectPath, HDF5CompoundType<T> type, ch.systemsx.cisd.base.mdarray.MDArray<T> data, HDF5GenericStorageFeatures features) Writes out an array (of rank N) of compound values.
<T> void	writeMDArray(java.lang.String objectPath, HDF5CompoundType<T> type, ch.systemsx.cisd.base.mdarray.MDArray<T> data, HDF5GenericStorageFeatures features, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Writes out an array (of rank N) of compound values.
<T> void	writeMDArray(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDArray<T> data) Writes out an array (of rank N) of compound values.
<T> void	writeMDArray(java.lang.String objectPath, ch.systemsx.cisd.base.mdarray.MDArray<T> data, HDF5GenericStorageFeatures features) Writes out an array (of rank N) of compound values.
<T> void	writeMDArrayBlock(java.lang.String objectPath, HDF5CompoundType<T> type, ch.systemsx.cisd.base.mdarray.MDArray<T> data, long[] blockNumber) Writes out a block of an array (of rank N) of compound values.
<T> void	writeMDArrayBlock(java.lang.String objectPath, HDF5CompoundType<T> type, ch.systemsx.cisd.base.mdarray.MDArray<T> data, long[] blockNumber, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Writes out a block of an array (of rank N) of compound values.
<T> void	writeMDArrayBlockWithOffset(java.lang.String objectPath, HDF5CompoundType<T> type, ch.systemsx.cisd.base.mdarray.MDArray<T> data, int[] blockDimensions, long[] offset, int[] memoryOffset) Writes out a block of an array (of rank N) of compound values give a given offset.
<T> void	writeMDArrayBlockWithOffset(java.lang.String objectPath, HDF5CompoundType<T> type, ch.systemsx.cisd.base.mdarray.MDArray<T> data, int[] blockDimensions, long[] offset, int[] memoryOffset, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Writes out a block of an array (of rank N) of compound values give a given offset.
<T> void	writeMDArrayBlockWithOffset(java.lang.String objectPath, HDF5CompoundType<T> type, ch.systemsx.cisd.base.mdarray.MDArray<T> data, long[] offset) Writes out a block of an array (of rank N) of compound values give a given offset.
<T> void	writeMDArrayBlockWithOffset(java.lang.String objectPath, HDF5CompoundType<T> type, ch.systemsx.cisd.base.mdarray.MDArray<T> data, long[] offset, IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull) Writes out a block of an array (of rank N) of compound values give a given offset.

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

getArrayAttr, getArrayAttr, getArrayBlocks, getArrayBlocks, getArrayBlocks, getAttr, getAttr, getMDArrayAttr, getMDArrayAttr, getMDArrayBlocks, getMDArrayBlocks, getMDArrayBlocks, read, read, read, readArray, readArray, readArray, readArrayBlock, readArrayBlock, readArrayBlockWithOffset, readArrayBlockWithOffset, readMDArray, readMDArray, readMDArray, readMDArrayBlock, readMDArrayBlock, readMDArrayBlockWithOffset, readMDArrayBlockWithOffset

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

getAttributeType, getAttributeType, getAttributeType, getAttributeType, getDataSetInfo, getDataSetInfo, getDataSetType, getDataSetType, getDataSetType, getDataSetType, getDataSetType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getInferredType, getMemberInfo, getMemberInfo, getMemberInfo, getNamedType, getNamedType, getNamedType, getNamedType, getNamedType, getNamedType, getType, getType, getType

Method Detail

getClonedType

<T> HDF5CompoundType<T> getClonedType(HDF5CompoundType<T> templateType)

Returns the compound type cloned from the given templateType. This method can be used to get a compound type from a different file.

Parameters:

templateType - The compound type to clone. Will typically be a compound type from another reader or writer. The type needs to be open (which means that the reader / writer from which it has been obtained has to be still open).

getAnonType

<T> HDF5CompoundType<T> getAnonType(java.lang.Class<T> pojoClass,
                                    HDF5CompoundMemberMapping... members)

Returns the anonymous compound type for this HDF5 file, using the default name chosen by JHDF5 which is based on the simple name of pojoClass.

Parameters:

pojoClass - The plain old Java type that corresponds to this HDF5 type.

members - The mapping from the Java compound type to the HDF5 type.

getInferredAnonType

<T> HDF5CompoundType<T> getInferredAnonType(java.lang.Class<T> pojoClass,
                                            HDF5CompoundMappingHints hints)

Returns the anonymous compound type name> for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection.

Parameters:

pojoClass - The plain old Java type that corresponds to this HDF5 type.

hints - The hints to provide to the mapping procedure.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getInferredAnonType

<T> HDF5CompoundType<T> getInferredAnonType(java.lang.Class<T> pojoClass)

Returns the anonymous compound type name> for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection.

Parameters:

pojoClass - The plain old Java type that corresponds to this HDF5 type.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getInferredAnonType

<T> HDF5CompoundType<T> getInferredAnonType(T template,
                                            HDF5CompoundMappingHints hints)

Returns anonyous the compound type name> for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection.

Parameters:

template - The compound to infer the HDF5 compound type from.

hints - The hints to provide to the mapping procedure.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getInferredAnonType

<T> HDF5CompoundType<T> getInferredAnonType(T template)

Returns the anonymous compound type for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection and using the default name chosen by JHDF5 which is based on the simple name of T.

Parameters:

template - The compound to infer the HDF5 compound type from.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getInferredAnonType

<T> HDF5CompoundType<T> getInferredAnonType(T[] template)

Returns the anonymous compound type name> for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection.

Parameters:

template - The compound array to infer the HDF5 compound type from.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getInferredAnonType

<T> HDF5CompoundType<T> getInferredAnonType(T[] template,
                                            HDF5CompoundMappingHints hints)

Returns the anonymous compound type name> for this HDF5 file, inferring the mapping from the Java compound type to the HDF5 type by reflection.

Parameters:

template - The compound array to infer the HDF5 compound type from.

hints - The hints to provide to the mapping procedure.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getInferredAnonType

HDF5CompoundType<java.util.List<?>> getInferredAnonType(java.util.List<java.lang.String> memberNames,
                                                        java.util.List<?> template,
                                                        HDF5CompoundMappingHints hints)

Returns the anonymous compound type for this HDF5 file, inferring the mapping from the Java types of the members.

Parameters:

memberNames - The names of the members.

template - The compound to infer the HDF5 compound type from. Needs to have the same length as memberNames.

hints - The hints to provide to the mapping procedure.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getInferredAnonType

HDF5CompoundType<java.util.List<?>> getInferredAnonType(java.util.List<java.lang.String> memberNames,
                                                        java.util.List<?> template)

Returns the anonymous compound type for this HDF5 file, inferring the mapping from the Java types of the members.

Parameters:

memberNames - The names of the members.

template - The compound to infer the HDF5 compound type from. Needs to have the same length as memberNames.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getInferredAnonType

HDF5CompoundType<java.lang.Object[]> getInferredAnonType(java.lang.String[] memberNames,
                                                         java.lang.Object[] template,
                                                         HDF5CompoundMappingHints hints)

Returns the anonymous compound type for this HDF5 file, inferring the mapping from the Java types of the members.

Parameters:

memberNames - The names of the members.

template - The compound to infer the HDF5 compound type from. Needs to have the same length than memberNames.

hints - The hints to provide to the mapping procedure.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

getInferredAnonType

HDF5CompoundType<java.lang.Object[]> getInferredAnonType(java.lang.String[] memberNames,
                                                         java.lang.Object[] template)

Returns the anonymous compound type for this HDF5 file, inferring the mapping from the Java types of the members.

Parameters:

memberNames - The names of the members.

template - The compound to infer the HDF5 compound type from. Needs to have the same length than memberNames.

See Also:

HDF5CompoundMemberMapping.inferMapping(java.lang.Class<?>)

setAttr

<T> void setAttr(java.lang.String objectPath,
                 java.lang.String attributeName,
                 HDF5CompoundType<T> type,
                 T value)

Sets a compound attribute to the referenced object.

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

Parameters:

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

attributeName - The name of the attribute.

type - The type definition of this compound type.

value - The value of the attribute. May be a Data Transfer Object, a HDF5CompoundDataMap, HDF5CompoundDataList or Object[] .

setAttr

<T> void setAttr(java.lang.String objectPath,
                 java.lang.String attributeName,
                 T value)

Sets a compound attribute to the referenced object.

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

Parameters:

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

attributeName - The name of the attribute.

value - The value of the attribute. May be a Data Transfer Object, a HDF5CompoundDataMap, HDF5CompoundDataList or Object[] .

setArrayAttr

<T> void setArrayAttr(java.lang.String objectPath,
                      java.lang.String attributeName,
                      HDF5CompoundType<T> type,
                      T[] value)

Sets a compound attribute array (of rank 1) to the referenced object.

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

Parameters:

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

attributeName - The name of the attribute.

type - The type definition of this compound type.

value - The value of the attribute. Data Transfer Object, a HDF5CompoundDataMap, HDF5CompoundDataList or Object[] .

setArrayAttr

<T> void setArrayAttr(java.lang.String objectPath,
                      java.lang.String attributeName,
                      T[] value)

Sets a compound attribute array (of rank 1) to the referenced object.

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

Parameters:

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

attributeName - The name of the attribute.

value - The value of the attribute. May be a Data Transfer Object, a HDF5CompoundDataMap, HDF5CompoundDataList or Object[] .

setMDArrayAttr

<T> void setMDArrayAttr(java.lang.String objectPath,
                        java.lang.String attributeName,
                        HDF5CompoundType<T> type,
                        ch.systemsx.cisd.base.mdarray.MDArray<T> value)

Sets a compound attribute array (of rank N) to the referenced object.

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

Parameters:

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

attributeName - The name of the attribute.

type - The type definition of this compound type.

value - The value of the attribute. Data Transfer Object, a HDF5CompoundDataMap, HDF5CompoundDataList or Object[] .

setMDArrayAttr

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

Sets a compound attribute array (of rank N) to the referenced object.

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

Parameters:

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

attributeName - The name of the attribute.

value - The value of the attribute. May be a Data Transfer Object, a HDF5CompoundDataMap, HDF5CompoundDataList or Object[] .

write

<T> void write(java.lang.String objectPath,
               HDF5CompoundType<T> type,
               T data)

Writes out a compound value of type given in data.

Parameters:

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

type - The type definition of this compound type.

data - The value of the data set.

write

<T> void write(java.lang.String objectPath,
               T data)

Writes out a compound value. The type is inferred based on the values.

Parameters:

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

data - The value of the data set. May be a pojo (Data Transfer Object), a HDF5CompoundDataMap, HDF5CompoundDataList or Object[] .

See Also:

CompoundType, CompoundElement

write

<T> void write(java.lang.String objectPath,
               HDF5CompoundType<T> type,
               T data,
               IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)

Writes out an array (of rank 1) of compound values. Uses a compact storage layout. Must only be used for small data sets.

Parameters:

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

type - The type definition of this compound type.

data - The value of the data set.

inspectorOrNull - The inspector to be called after translating the Java objects to a byte array and before writing the byte array to the HDF5 file.

writeArray

<T> void writeArray(java.lang.String objectPath,
                    HDF5CompoundType<T> type,
                    T[] data)

Writes out an array (of rank 1) of compound values.

Parameters:

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

type - The type definition of this compound type.

data - The value of the data set.

writeArray

<T> void writeArray(java.lang.String objectPath,
                    HDF5CompoundType<T> type,
                    T[] data,
                    HDF5GenericStorageFeatures features)

Writes out an array (of rank 1) of compound values.

Parameters:

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

type - The type definition of this compound type.

data - The value of the data set.

features - The storage features of the data set.

writeArray

<T> void writeArray(java.lang.String objectPath,
                    HDF5CompoundType<T> type,
                    T[] data,
                    HDF5GenericStorageFeatures features,
                    IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)

Writes out an array (of rank 1) of compound values.

Parameters:

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

type - The type definition of this compound type.

data - The value of the data set.

features - The storage features of the data set.

inspectorOrNull - The inspector to be called after translating the Java objects to a byte array and before writing the byte array to the HDF5 file.

writeArray

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

Writes out an array (of rank 1) of compound values. The type is inferred based on the values.

Parameters:

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

data - The value of the data set. May be a pojo (Data Transfer Object), a HDF5CompoundDataMap, HDF5CompoundDataList or Object[] .

See Also:

CompoundType, CompoundElement

writeArray

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

Writes out an array (of rank 1) of compound values. The type is inferred based on the values.

Parameters:

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

data - The value of the data set. May be a HDF5CompoundDataMap, HDF5CompoundDataList or Object[].

features - The storage features of the data set.

See Also:

CompoundType, CompoundElement

writeArrayBlock

<T> void writeArrayBlock(java.lang.String objectPath,
                         HDF5CompoundType<T> type,
                         T[] data,
                         long blockNumber)

Writes out a block blockNumber of an array (of rank 1) of compound values.

Parameters:

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

type - The type definition of this compound type.

data - The value of the data set.

blockNumber - The number of the block to write.

writeArrayBlock

<T> void writeArrayBlock(java.lang.String objectPath,
                         HDF5CompoundType<T> type,
                         T[] data,
                         long blockNumber,
                         IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)

Writes out a block blockNumber of an array (of rank 1) of compound values.

Parameters:

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

type - The type definition of this compound type.

data - The value of the data set.

blockNumber - The number of the block to write.

inspectorOrNull - The inspector to be called after translating the Java objects to a byte array and before writing the byte array to the HDF5 file.

writeArrayBlockWithOffset

<T> void writeArrayBlockWithOffset(java.lang.String objectPath,
                                   HDF5CompoundType<T> type,
                                   T[] data,
                                   long offset)

Writes out a block of an array (of rank 1) of compound values with given offset.

Parameters:

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

type - The type definition of this compound type.

data - The value of the data set.

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

writeArrayBlockWithOffset

<T> void writeArrayBlockWithOffset(java.lang.String objectPath,
                                   HDF5CompoundType<T> type,
                                   T[] data,
                                   long offset,
                                   IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)

Writes out a block of an array (of rank 1) of compound values with given offset.

Parameters:

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

type - The type definition of this compound type.

data - The value of the data set.

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

inspectorOrNull - The inspector to be called after translating the Java objects to a byte array and before writing the byte array to the HDF5 file.

createArray

<T> void createArray(java.lang.String objectPath,
                     HDF5CompoundType<T> type,
                     int size)

Creates an array (of rank 1) of compound values.

Parameters:

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

type - The type definition of this compound type.

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

createArray

<T> void createArray(java.lang.String objectPath,
                     HDF5CompoundType<T> type,
                     long size,
                     int blockSize)

Creates an array (of rank 1) of compound values.

Parameters:

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

type - The type definition of this compound type.

size - The size of the compound array to create.

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

createArray

<T> void createArray(java.lang.String objectPath,
                     HDF5CompoundType<T> type,
                     long size,
                     int blockSize,
                     HDF5GenericStorageFeatures features)

Creates an array (of rank 1) of compound values.

Parameters:

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

type - The type definition of this compound type.

size - The size of the compound array to create.

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

features - The storage features of the data set.

createArray

<T> void createArray(java.lang.String objectPath,
                     HDF5CompoundType<T> type,
                     long size,
                     HDF5GenericStorageFeatures features)

Creates an array (of rank 1) of compound values.

Parameters:

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

type - The type definition of this compound type.

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.

writeMDArray

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

Writes out an array (of rank N) of compound values.

Parameters:

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

type - The type definition of this compound type.

data - The data to write.

writeMDArray

<T> void writeMDArray(java.lang.String objectPath,
                      HDF5CompoundType<T> type,
                      ch.systemsx.cisd.base.mdarray.MDArray<T> data,
                      HDF5GenericStorageFeatures features)

Writes out an array (of rank N) of compound values.

Parameters:

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

type - The type definition of this compound type.

data - The data to write.

features - The storage features of the data set.

writeMDArray

<T> void writeMDArray(java.lang.String objectPath,
                      HDF5CompoundType<T> type,
                      ch.systemsx.cisd.base.mdarray.MDArray<T> data,
                      HDF5GenericStorageFeatures features,
                      IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)

Writes out an array (of rank N) of compound values.

Parameters:

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

type - The type definition of this compound type.

data - The data to write.

features - The storage features of the data set.

inspectorOrNull - The inspector to be called after translating the Java objects to a byte array and before writing the byte array to the HDF5.

writeMDArray

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

Writes out an array (of rank N) of compound values. The type is inferred based on the values.

Parameters:

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

data - The value of the data set. May be a pojo (Data Transfer Object), a HDF5CompoundDataMap, HDF5CompoundDataList or Object[] .

See Also:

CompoundType, CompoundElement

writeMDArray

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

Writes out an array (of rank N) of compound values. The type is inferred based on the values.

Parameters:

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

data - The value of the data set. May be a pojo (Data Transfer Object), a HDF5CompoundDataMap, HDF5CompoundDataList or Object[] .

features - The storage features of the data set.

See Also:

CompoundType, CompoundElement

writeMDArrayBlock

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

Writes out a block of an array (of rank N) of compound values.

Parameters:

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

type - The type definition of this compound type.

data - The data to write.

blockNumber - The block number in each dimension (offset: multiply with the extend in the according dimension).

writeMDArrayBlock

<T> void writeMDArrayBlock(java.lang.String objectPath,
                           HDF5CompoundType<T> type,
                           ch.systemsx.cisd.base.mdarray.MDArray<T> data,
                           long[] blockNumber,
                           IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)

Writes out a block of an array (of rank N) of compound values.

Parameters:

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

type - The type definition of this compound type.

data - The data to write.

blockNumber - The extent of the block to write on each axis.

inspectorOrNull - The inspector to be called after translating the Java objects to a byte array and before writing the byte array to the HDF5.

writeMDArrayBlockWithOffset

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

Writes out a block of an array (of rank N) of compound values give a given offset.

Parameters:

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

type - The type definition of this compound type.

data - The data to write.

offset - The offset of the block to write on each axis.

writeMDArrayBlockWithOffset

<T> void writeMDArrayBlockWithOffset(java.lang.String objectPath,
                                     HDF5CompoundType<T> type,
                                     ch.systemsx.cisd.base.mdarray.MDArray<T> data,
                                     long[] offset,
                                     IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)

Writes out a block of an array (of rank N) of compound values give a given offset.

Parameters:

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

type - The type definition of this compound type.

data - The data to write.

offset - The offset of the block to write on each axis.

inspectorOrNull - The inspector to be called after translating the Java objects to a byte array and before writing the byte array to the HDF5.

writeMDArrayBlockWithOffset

<T> void writeMDArrayBlockWithOffset(java.lang.String objectPath,
                                     HDF5CompoundType<T> type,
                                     ch.systemsx.cisd.base.mdarray.MDArray<T> data,
                                     int[] blockDimensions,
                                     long[] offset,
                                     int[] memoryOffset)

Writes out a block of an array (of rank N) of compound values give a given offset.

Parameters:

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

type - The type definition of this compound type.

data - The data to write.

blockDimensions - The dimensions of the block to write to the data set.

offset - The offset of the block in the data set to start writing to in each dimension.

memoryOffset - The offset of the block in the data array.

writeMDArrayBlockWithOffset

<T> void writeMDArrayBlockWithOffset(java.lang.String objectPath,
                                     HDF5CompoundType<T> type,
                                     ch.systemsx.cisd.base.mdarray.MDArray<T> data,
                                     int[] blockDimensions,
                                     long[] offset,
                                     int[] memoryOffset,
                                     IHDF5CompoundInformationRetriever.IByteArrayInspector inspectorOrNull)

Writes out a block of an array (of rank N) of compound values give a given offset.

Parameters:

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

type - The type definition of this compound type.

data - The data to write.

blockDimensions - The dimensions of the block to write to the data set.

offset - The offset of the block in the data set to start writing to in each dimension.

memoryOffset - The offset of the block in the data array.

inspectorOrNull - The inspector to be called after translating the Java objects to a byte array and before writing the byte array to the HDF5.

createMDArray

<T> void createMDArray(java.lang.String objectPath,
                       HDF5CompoundType<T> type,
                       int[] dimensions)

Creates an array (of rank N) of compound values.

Parameters:

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

type - The type definition of this compound type.

dimensions - The dimensions of the compound array to create. This will be the total dimensions for non-extendable data sets and the dimensions of one chunk (along each axis) for extendable (chunked) data sets. For extendable data sets the initial size of the array (along each axis) will be 0, see IHDF5WriterConfigurator.dontUseExtendableDataTypes().

createMDArray

<T> void createMDArray(java.lang.String objectPath,
                       HDF5CompoundType<T> type,
                       long[] dimensions,
                       int[] blockDimensions)

Creates an array (of rank N) of compound values.

Parameters:

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

type - The type definition of this compound type.

dimensions - The extent of the compound array along each of the axis.

blockDimensions - The extent of one block along each of the axis. (for block-wise IO). Ignored if no extendable data sets are used (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()) and deflate == false.

createMDArray

<T> void createMDArray(java.lang.String objectPath,
                       HDF5CompoundType<T> type,
                       long[] dimensions,
                       int[] blockDimensions,
                       HDF5GenericStorageFeatures features)

Creates an array (of rank N) of compound values.

Parameters:

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

type - The type definition of this compound type.

dimensions - The extent of the compound array along each of the axis.

blockDimensions - The extent of one block along each of the axis. (for block-wise IO). Ignored if no extendable data sets are used (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()) and deflate == false.

features - The storage features of the data set.

createMDArray

<T> void createMDArray(java.lang.String objectPath,
                       HDF5CompoundType<T> type,
                       int[] dimensions,
                       HDF5GenericStorageFeatures features)

Creates an array (of rank N) of compound values.

Parameters:

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

type - The type definition of this compound type.

dimensions - The dimensions of the byte array to create. This will be the total dimensions for non-extendable data sets and the dimensions of one chunk (along each axis) for extendable (chunked) data sets. For extendable data sets the initial size of the array (along each axis) will be 0, see HDF5GenericStorageFeatures.

features - The storage features of the data set.