ch.systemsx.cisd.hdf5

Interface IHDF5CompoundInformationRetriever

All Known Subinterfaces:

IHDF5CompoundReader, IHDF5CompoundWriter

public interface IHDF5CompoundInformationRetriever

An interface to get information on HDF5 compound data sets and compound data types, and to create compound types from mappings to Java classes.

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

What is an HDF5CompoundType?

A HDF5CompoundType is a Java object representing both an HDF5 compound type in a particular HDF5 file and the mapping of this HDF5 compound type to a representation in Java. A Java representation can be either a plain-old Java object (POJO) where Java fields correspond to HDF5 compound members, a map (see HDF5CompoundDataMap) where each HDF5 compound member is represented by one key-value pair, a list (see HDF5CompoundDataList) or Object[], where the members of the HDF5 compound type are stored by their position (or order) in the HDF5 compound type.

It is important to understand that creating the HDF5 compound type in memory (what members of what types it contains in what order) and mapping the members to Java (including the Java type and, for POJOs, the field) are two distinct steps. Different methods of this interface use two different approaches on how to create the HDF5 compound type: getType() and getInferredType() create them anew, based on the POJO class and the HDF5CompoundMemberMappings provided, while getNamedType(), getDataSetType() and getAttributeType() read them from the HDF5 file. Whenever you are reading a compound from an HDF5 file, the second approach should be preferred as the HDF5 file is the authorative source of information on HDF5 types.

The following Java types can be mapped to compound members:

• Primitive values
• Primitive arrays
• Primitive matrices (except char[][])
• String (fixed-length and variable-lengt)
• BitSet
• Date
• HDF5EnumerationValue
• HDF5EnumerationValueArray
• Sub-classes of MDAbstractArray
• References to data sets

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IHDF5CompoundInformationRetriever.IByteArrayInspector An interface for inspecting the byte array of compounds and compound arrays just after they are read from or before they are written to the HDF5 file.

Method Summary

Modifier and Type	Method and Description
<T> HDF5CompoundType<T>	getAttributeType(java.lang.String objectPath, java.lang.String attributeName, java.lang.Class<T> pojoClass) Returns the compound type for the given compound attribute in attributeName of objectPath, mapping it to pojoClass.
<T> HDF5CompoundType<T>	getAttributeType(java.lang.String objectPath, java.lang.String attributeName, java.lang.Class<T> pojoClass, HDF5CompoundMappingHints hints) Returns the compound type for the given compound attribute in attributeName of objectPath, mapping it to pojoClass.
<T> HDF5CompoundType<T>	getAttributeType(java.lang.String objectPath, java.lang.String attributeName, java.lang.Class<T> pojoClass, HDF5CompoundMappingHints hints, HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions) Returns the compound type for the given compound attribute in attributeName of objectPath, mapping it to pojoClass.
<T> HDF5CompoundType<T>	getAttributeType(java.lang.String objectPath, java.lang.String attributeName, java.lang.Class<T> pojoClass, HDF5CompoundMappingHints hints, HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions, boolean requireTypesToBeEqual) Returns the compound type for the given compound attribute in attributeName of objectPath, mapping it to pojoClass.
HDF5CompoundMemberInformation[]	getDataSetInfo(java.lang.String dataSetPath) Returns the compound member information for the data set dataSetPath in the order that the members appear in the compound type.
HDF5CompoundMemberInformation[]	getDataSetInfo(java.lang.String dataSetPath, HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions) Returns the compound member information for the data set dataSetPath in the order that the members appear in the compound type.
<T> HDF5CompoundType<T>	getDataSetType(java.lang.String objectPath, java.lang.Class<T> pojoClass) Returns the compound type for the given compound data set in objectPath, mapping it to pojoClass.
<T> HDF5CompoundType<T>	getDataSetType(java.lang.String objectPath, java.lang.Class<T> pojoClass, boolean requireTypesToBeEqual, HDF5CompoundMemberMapping... members) Returns the compound type for the given compound data set in objectPath, mapping it to pojoClass.
<T> HDF5CompoundType<T>	getDataSetType(java.lang.String objectPath, java.lang.Class<T> pojoClass, HDF5CompoundMappingHints hints) Returns the compound type for the given compound data set in objectPath, mapping it to pojoClass.
<T> HDF5CompoundType<T>	getDataSetType(java.lang.String objectPath, java.lang.Class<T> pojoClass, HDF5CompoundMappingHints hints, boolean requireTypesToBeEqual) Returns the compound type for the given compound data set in objectPath, mapping it to pojoClass.
<T> HDF5CompoundType<T>	getDataSetType(java.lang.String objectPath, java.lang.Class<T> pojoClass, HDF5CompoundMemberMapping... members) Returns the compound type for the given compound data set in objectPath, mapping it to pojoClass.
<T> HDF5CompoundType<T>	getInferredType(java.lang.Class<T> pojoClass) Returns a compound type for this HDF5 file, compatible with pojoClass.
<T> HDF5CompoundType<T>	getInferredType(java.lang.Class<T> pojoClass, HDF5CompoundMappingHints hints) Returns a compound type for this HDF5 file, compatible with pojoClass.
HDF5CompoundType<java.util.List<?>>	getInferredType(java.util.List<java.lang.String> memberNames, java.util.List<?> template) Returns a compound type name> for this HDF5 file, compatible with template and memberNames.
HDF5CompoundType<java.util.List<?>>	getInferredType(java.util.List<java.lang.String> memberNames, java.util.List<?> template, HDF5CompoundMappingHints hints) Returns a compound type name> for this HDF5 file, compatible with template and memberNames.
HDF5CompoundType<java.lang.Object[]>	getInferredType(java.lang.String[] memberNames, java.lang.Object[] template) Returns a compound type name> for this HDF5 file, compatible with template and memberNames.
HDF5CompoundType<java.lang.Object[]>	getInferredType(java.lang.String[] memberNames, java.lang.Object[] template, HDF5CompoundMappingHints hints) Returns a compound type name> for this HDF5 file, compatible with template and memberNames.
<T> HDF5CompoundType<T>	getInferredType(java.lang.String name, java.lang.Class<T> pojoClass) Returns a compound type name> for this HDF5 file, compatible with pojoClass.
<T> HDF5CompoundType<T>	getInferredType(java.lang.String name, java.lang.Class<T> pojoClass, HDF5CompoundMappingHints hints) Returns a compound type name> for this HDF5 file, compatible with pojoClass.
<T> HDF5CompoundType<T>	getInferredType(java.lang.String name, java.lang.Class<T> pojoClass, HDF5CompoundMappingHints hints, boolean requireTypesToBeEqual) Returns a compound type name> for this HDF5 file, compatible with pojoClass.
HDF5CompoundType<java.util.List<?>>	getInferredType(java.lang.String name, java.util.List<java.lang.String> memberNames, java.util.List<?> template) Returns a compound type name> for this HDF5 file, compatible with template and memberNames.
HDF5CompoundType<java.util.List<?>>	getInferredType(java.lang.String name, java.util.List<java.lang.String> memberNames, java.util.List<?> template, HDF5CompoundMappingHints hints) Returns a compound type name> for this HDF5 file, compatible with template and memberNames.
HDF5CompoundType<java.util.List<?>>	getInferredType(java.lang.String name, java.util.List<java.lang.String> memberNames, java.util.List<?> template, HDF5CompoundMappingHints hints, boolean requireTypesToBeEqual) Returns a compound type name> for this HDF5 file, compatible with template and memberNames.
HDF5CompoundType<java.lang.Object[]>	getInferredType(java.lang.String name, java.lang.String[] memberNames, java.lang.Object[] template) Returns a compound type name> for this HDF5 file, compatible with template and memberNames.
HDF5CompoundType<java.lang.Object[]>	getInferredType(java.lang.String name, java.lang.String[] memberNames, java.lang.Object[] template, HDF5CompoundMappingHints hints) Returns a compound type name> for this HDF5 file, compatible with template and memberNames.
HDF5CompoundType<java.lang.Object[]>	getInferredType(java.lang.String name, java.lang.String[] memberNames, java.lang.Object[] template, HDF5CompoundMappingHints hints, boolean requireTypesToBeEqual) Returns a compound type name> for this HDF5 file, compatible with template and memberNames.
<T> HDF5CompoundType<T>	getInferredType(java.lang.String name, T template) Returns a compound type name> for this HDF5 file, compatible with template.
<T> HDF5CompoundType<T>	getInferredType(java.lang.String name, T[] template) Returns a compound type name> for this HDF5 file, compatible with template.
<T> HDF5CompoundType<T>	getInferredType(java.lang.String name, T[] template, HDF5CompoundMappingHints hints) Returns a compound type name> for this HDF5 file, compatible with template.
<T> HDF5CompoundType<T>	getInferredType(java.lang.String name, T[] template, HDF5CompoundMappingHints hints, boolean requireTypesToBeEqual) Returns a compound type name> for this HDF5 file, compatible with template.
<T> HDF5CompoundType<T>	getInferredType(java.lang.String name, T template, HDF5CompoundMappingHints hints) Returns a compound type name> for this HDF5 file, compatible with template.
<T> HDF5CompoundType<T>	getInferredType(java.lang.String name, T template, HDF5CompoundMappingHints hints, boolean requireTypesToBeEqual) Returns a compound type name> for this HDF5 file, compatible with template.
<T> HDF5CompoundType<T>	getInferredType(T template) Returns a compound type for this HDF5 file, compatible with template.
<T> HDF5CompoundType<T>	getInferredType(T[] template) Returns a compound type for this HDF5 file, compatible with template.
<T> HDF5CompoundMemberInformation[]	getMemberInfo(java.lang.Class<T> compoundClass) Returns the member information for the committed compound data type compoundClass (using its "simple name") in the order that the members appear in the compound type.
HDF5CompoundMemberInformation[]	getMemberInfo(java.lang.String dataTypeName) Returns the member information for the committed compound data type dataTypeName in the order that the members appear in the compound type.
HDF5CompoundMemberInformation[]	getMemberInfo(java.lang.String dataTypeName, HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions) Returns the member information for the committed compound data type dataTypeName in the order that the members appear in the compound type.
<T> HDF5CompoundType<T>	getNamedType(java.lang.Class<T> pojoClass) Returns the named compound type with name dataTypeName from file, mapping it to pojoClass.
<T> HDF5CompoundType<T>	getNamedType(java.lang.String dataTypeName, java.lang.Class<T> pojoClass) Returns the named compound type with name dataTypeName from file, mapping it to pojoClass.
<T> HDF5CompoundType<T>	getNamedType(java.lang.String dataTypeName, java.lang.Class<T> pojoClass, HDF5CompoundMappingHints hints) Returns the named compound type with name dataTypeName from file, mapping it to pojoClass.
<T> HDF5CompoundType<T>	getNamedType(java.lang.String dataTypeName, java.lang.Class<T> pojoClass, HDF5CompoundMappingHints hints, HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions) Returns the named compound type with name dataTypeName from file, mapping it to pojoClass.
<T> HDF5CompoundType<T>	getNamedType(java.lang.String dataTypeName, java.lang.Class<T> pojoClass, HDF5CompoundMappingHints hints, HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions, boolean requireTypesToBeEqual) Returns the named compound type with name dataTypeName from file, mapping it to pojoClass.
<T> HDF5CompoundType<T>	getNamedType(java.lang.String dataTypeName, java.lang.Class<T> pojoClass, HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions) Returns the named compound type with name dataTypeName from file, mapping it to pojoClass.
<T> HDF5CompoundType<T>	getType(java.lang.Class<T> pojoClass, HDF5CompoundMemberMapping... members) Returns a compound type name> for this HDF5 file, compatible with pojoClass.
<T> HDF5CompoundType<T>	getType(java.lang.String name, java.lang.Class<T> pojoClass, boolean requireTypesToBeEqual, HDF5CompoundMemberMapping... members) Returns a compound type name> for this HDF5 file, compatible with pojoClass.
<T> HDF5CompoundType<T>	getType(java.lang.String name, java.lang.Class<T> pojoClass, HDF5CompoundMemberMapping... members) Returns the compound type name> for this HDF5 file.

Method Detail

getMemberInfo

<T> HDF5CompoundMemberInformation[] getMemberInfo(java.lang.Class<T> compoundClass)

Returns the member information for the committed compound data type compoundClass (using its "simple name") in the order that the members appear in the compound type. It is a failure condition if this compound data type does not exist.

getMemberInfo

HDF5CompoundMemberInformation[] getMemberInfo(java.lang.String dataTypeName)

Returns the member information for the committed compound data type dataTypeName in the order that the members appear in the compound type. It is a failure condition if this compound data type does not exist. If the dataTypeName starts with '/', it will be considered a data type path instead of a data type name.

Parameters:

dataTypeName - The name of the compound data type to get the member information for.

getMemberInfo

HDF5CompoundMemberInformation[] getMemberInfo(java.lang.String dataTypeName,
                                              HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions)

Returns the member information for the committed compound data type dataTypeName in the order that the members appear in the compound type. It is a failure condition if this compound data type does not exist. If the dataTypeName starts with '/', it will be considered a data type path instead of a data type name.

Parameters:

dataTypeName - The name of the compound data type to get the member information for.

dataTypeInfoOptions - The options on which information to get about the member data types.

getDataSetInfo

HDF5CompoundMemberInformation[] getDataSetInfo(java.lang.String dataSetPath)
                                        throws HDF5JavaException

Returns the compound member information for the data set dataSetPath in the order that the members appear in the compound type. It is a failure condition if this data set does not exist or is not of compound type.

Call Arrays.sort(compoundInformation) to sort the array in alphabetical order of names.

Throws:

HDF5JavaException - If the data set is not of type compound.

getDataSetInfo

HDF5CompoundMemberInformation[] getDataSetInfo(java.lang.String dataSetPath,
                                               HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions)
                                        throws HDF5JavaException

Returns the compound member information for the data set dataSetPath in the order that the members appear in the compound type. It is a failure condition if this data set does not exist or is not of compound type.

Call Arrays.sort(compoundInformation) to sort the array in alphabetical order of names.

Parameters:

dataSetPath - The name of the data set to get the member information for.

dataTypeInfoOptions - The options on which information to get about the member data types.

Throws:

HDF5JavaException - If the data set is not of type compound.

getType

<T> HDF5CompoundType<T> getType(java.lang.String name,
                                java.lang.Class<T> pojoClass,
                                boolean requireTypesToBeEqual,
                                HDF5CompoundMemberMapping... members)

Returns a compound type name> for this HDF5 file, compatible with pojoClass. The mapping is defined by members.

Parameters:

name - The name of the compound in the HDF5 file.

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

requireTypesToBeEqual - If true, this type is required to be equal to the type it tries to read, or else an HDF5JavaException will be thrown.

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

getType

<T> HDF5CompoundType<T> getType(java.lang.String name,
                                java.lang.Class<T> pojoClass,
                                HDF5CompoundMemberMapping... members)

Returns the compound type name> for this HDF5 file.

Parameters:

name - The name of the compound in the HDF5 file.

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

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

getType

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

Returns a compound type name> for this HDF5 file, compatible with pojoClass. The name of the compound data type is chosen to be the simple name of pojoClass. The mapping is defined by members.

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.

getInferredType

<T> HDF5CompoundType<T> getInferredType(java.lang.String name,
                                        java.lang.Class<T> pojoClass,
                                        HDF5CompoundMappingHints hints)

Returns a compound type name> for this HDF5 file, compatible with pojoClass. The mapping of the Java compound type to the HDF5 type is inferred by reflection from pojoClass following basic rules on how Java data types are mapped to HDF5 data types.

Parameters:

name - The name of the compound in the HDF5 file.

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

getInferredType

<T> HDF5CompoundType<T> getInferredType(java.lang.String name,
                                        java.lang.Class<T> pojoClass,
                                        HDF5CompoundMappingHints hints,
                                        boolean requireTypesToBeEqual)

Returns a compound type name> for this HDF5 file, compatible with pojoClass. The mapping of the Java compound type to the HDF5 type is inferred by reflection from pojoClass following basic rules on how Java data types are mapped to HDF5 data types.

Parameters:

name - The name of the compound in the HDF5 file.

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

hints - The hints to provide to the mapping procedure.

requireTypesToBeEqual - If true, this type is required to be equal to the type it tries to read, or else an HDF5JavaException will be thrown.

See Also:

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

getInferredType

<T> HDF5CompoundType<T> getInferredType(java.lang.String name,
                                        java.lang.Class<T> pojoClass)

Returns a compound type name> for this HDF5 file, compatible with pojoClass. The mapping of the Java compound type to the HDF5 type is inferred by reflection from pojoClass following basic rules on how Java data types are mapped to HDF5 data types.

Parameters:

name - The name of the compound in the HDF5 file.

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

See Also:

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

getInferredType

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

Returns a compound type for this HDF5 file, compatible with pojoClass. The mapping of the Java compound type to the HDF5 type is inferred by reflection from pojoClass following basic rules on how Java data types are mapped to HDF5 data types. As name of the HDF5 compound type, the simple name of pojoClass is chosen.

Parameters:

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

See Also:

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

getInferredType

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

Returns a compound type for this HDF5 file, compatible with pojoClass. The mapping of the Java compound type to the HDF5 type is inferred by reflection from pojoClass following basic rules on how Java data types are mapped to HDF5 data types. As name of the HDF5 compound type, the simple name of pojoClass is chosen.

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

getInferredType

<T> HDF5CompoundType<T> getInferredType(java.lang.String name,
                                        T template,
                                        HDF5CompoundMappingHints hints)

Returns a compound type name> for this HDF5 file, compatible with template. The mapping of the Java compound type to the HDF5 type is inferred by reflection from template following basic rules on how Java data types are mapped to HDF5 data types.

Parameters:

name - The name of the compound type in the HDF5 file.

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

getInferredType

<T> HDF5CompoundType<T> getInferredType(java.lang.String name,
                                        T template,
                                        HDF5CompoundMappingHints hints,
                                        boolean requireTypesToBeEqual)

Returns a compound type name> for this HDF5 file, compatible with template. The mapping of the Java compound type to the HDF5 type is inferred by reflection from template following basic rules on how Java data types are mapped to HDF5 data types.

Parameters:

name - The name of the compound type in the HDF5 file.

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

hints - The hints to provide to the mapping procedure.

requireTypesToBeEqual - If true, this type is required to be equal to the type it tries to read, or else an HDF5JavaException will be thrown.

See Also:

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

getInferredType

<T> HDF5CompoundType<T> getInferredType(java.lang.String name,
                                        T template)

Returns a compound type name> for this HDF5 file, compatible with template. The mapping of the Java compound type to the HDF5 type is inferred by reflection from template following basic rules on how Java data types are mapped to HDF5 data types.

Parameters:

name - The name of the compound type in the HDF5 file.

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

See Also:

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

getInferredType

<T> HDF5CompoundType<T> getInferredType(T template)

Returns a compound type for this HDF5 file, compatible with template. The mapping of the Java compound type to the HDF5 type is inferred by reflection from template following basic rules on how Java data types are mapped to HDF5 data types. As name of the HDF5 compound type, the simple name of the class of template is chosen.

Parameters:

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

See Also:

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

getInferredType

<T> HDF5CompoundType<T> getInferredType(java.lang.String name,
                                        T[] template)

Returns a compound type name> for this HDF5 file, compatible with template. The mapping of the Java compound type to the HDF5 type is inferred by reflection from template following basic rules on how Java data types are mapped to HDF5 data types.

Parameters:

name - The name of the compound type in the HDF5 file.

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

See Also:

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

getInferredType

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

Returns a compound type for this HDF5 file, compatible with template. The mapping of the Java compound type to the HDF5 type is inferred by reflection from template following basic rules on how Java data types are mapped to HDF5 data types. As name of the HDF5 compound type, the simple name of the class of template is chosen.

Parameters:

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

See Also:

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

getInferredType

<T> HDF5CompoundType<T> getInferredType(java.lang.String name,
                                        T[] template,
                                        HDF5CompoundMappingHints hints)

Returns a compound type name> for this HDF5 file, compatible with template. The mapping of the Java compound type to the HDF5 type is inferred by reflection from template following basic rules on how Java data types are mapped to HDF5 data types.

Parameters:

name - The name of the compound type in the HDF5 file.

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

getInferredType

<T> HDF5CompoundType<T> getInferredType(java.lang.String name,
                                        T[] template,
                                        HDF5CompoundMappingHints hints,
                                        boolean requireTypesToBeEqual)

Returns a compound type name> for this HDF5 file, compatible with template. The mapping of the Java compound type to the HDF5 type is inferred by reflection from template following basic rules on how Java data types are mapped to HDF5 data types.

Parameters:

name - The name of the compound type in the HDF5 file.

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

hints - The hints to provide to the mapping procedure.

requireTypesToBeEqual - If true, this type is required to be equal to the type it tries to read, or else an HDF5JavaException will be thrown.

See Also:

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

getInferredType

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

Returns a compound type name> for this HDF5 file, compatible with template and memberNames. The mapping of the Java compound type to the HDF5 type is inferred by reflection of the elements of template following basic rules on how Java data types are mapped to HDF5 data types. Each element of template is considered a member of the compound. The names are taken from memberNames in the same order as in template.

Parameters:

name - The name of the compound type in the HDF5 file.

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

getInferredType

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

Returns a compound type name> for this HDF5 file, compatible with template and memberNames. The mapping of the Java compound type to the HDF5 type is inferred by reflection of the elements of template following basic rules on how Java data types are mapped to HDF5 data types. Each element of template is considered a member of the compound. The names are taken from memberNames in the same order as in template.

Parameters:

name - The name of the compound type in the HDF5 file.

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

getInferredType

HDF5CompoundType<java.util.List<?>> getInferredType(java.lang.String name,
                                                    java.util.List<java.lang.String> memberNames,
                                                    java.util.List<?> template,
                                                    HDF5CompoundMappingHints hints,
                                                    boolean requireTypesToBeEqual)

Returns a compound type name> for this HDF5 file, compatible with template and memberNames. The mapping of the Java compound type to the HDF5 type is inferred by reflection of the elements of template following basic rules on how Java data types are mapped to HDF5 data types. Each element of template is considered a member of the compound. The names are taken from memberNames in the same order as in template.

Parameters:

name - The name of the compound type in the HDF5 file.

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.

requireTypesToBeEqual - If true, this type is required to be equal to the type it tries to read, or else an HDF5JavaException will be thrown.

See Also:

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

getInferredType

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

Returns a compound type name> for this HDF5 file, compatible with template and memberNames. The mapping of the Java compound type to the HDF5 type is inferred by reflection of the elements of template following basic rules on how Java data types are mapped to HDF5 data types. Each element of template is considered a member of the compound. The names are taken from memberNames in the same order as in template.

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

getInferredType

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

Returns a compound type name> for this HDF5 file, compatible with template and memberNames. The mapping of the Java compound type to the HDF5 type is inferred by reflection of the elements of template following basic rules on how Java data types are mapped to HDF5 data types. Each element of template is considered a member of the compound. The names are taken from memberNames in the same order as in template.

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

getInferredType

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

Returns a compound type name> for this HDF5 file, compatible with template and memberNames. The mapping of the Java compound type to the HDF5 type is inferred by reflection of the elements of template following basic rules on how Java data types are mapped to HDF5 data types. Each element of template is considered a member of the compound. The names are taken from memberNames in the same order as in template.

Parameters:

name - The name of the compound type in the HDF5 file.

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

getInferredType

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

Returns a compound type name> for this HDF5 file, compatible with template and memberNames. The mapping of the Java compound type to the HDF5 type is inferred by reflection of the elements of template following basic rules on how Java data types are mapped to HDF5 data types. Each element of template is considered a member of the compound. The names are taken from memberNames in the same order as in template.

Parameters:

name - The name of the compound type in the HDF5 file.

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

getInferredType

HDF5CompoundType<java.lang.Object[]> getInferredType(java.lang.String name,
                                                     java.lang.String[] memberNames,
                                                     java.lang.Object[] template,
                                                     HDF5CompoundMappingHints hints,
                                                     boolean requireTypesToBeEqual)

Returns a compound type name> for this HDF5 file, compatible with template and memberNames. The mapping of the Java compound type to the HDF5 type is inferred by reflection of the elements of template following basic rules on how Java data types are mapped to HDF5 data types. Each element of template is considered a member of the compound. The names are taken from memberNames in the same order as in template.

Parameters:

name - The name of the compound type in the HDF5 file.

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.

requireTypesToBeEqual - If true, this type is required to be equal to the type it tries to read, or else an HDF5JavaException will be thrown.

See Also:

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

getInferredType

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

Returns a compound type name> for this HDF5 file, compatible with template and memberNames. The mapping of the Java compound type to the HDF5 type is inferred by reflection of the elements of template following basic rules on how Java data types are mapped to HDF5 data types. Each element of template is considered a member of the compound. The names are taken from memberNames in the same order as in template.

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

getInferredType

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

Returns a compound type name> for this HDF5 file, compatible with template and memberNames. The mapping of the Java compound type to the HDF5 type is inferred by reflection of the elements of template following basic rules on how Java data types are mapped to HDF5 data types. Each element of template is considered a member of the compound. The names are taken from memberNames in the same order as in template.

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

getDataSetType

<T> HDF5CompoundType<T> getDataSetType(java.lang.String objectPath,
                                       java.lang.Class<T> pojoClass,
                                       boolean requireTypesToBeEqual,
                                       HDF5CompoundMemberMapping... members)

Returns the compound type for the given compound data set in objectPath, mapping it to pojoClass.

Parameters:

objectPath - The path of the compound dataset to get the type from.

pojoClass - The class to use for the mapping.

requireTypesToBeEqual - If true, this type is required to be equal to the type it tries to read, or else an HDF5JavaException will be thrown.

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

Returns:

The compound data type.

getDataSetType

<T> HDF5CompoundType<T> getDataSetType(java.lang.String objectPath,
                                       java.lang.Class<T> pojoClass,
                                       HDF5CompoundMemberMapping... members)

Returns the compound type for the given compound data set in objectPath, mapping it to pojoClass.

Parameters:

objectPath - The path of the compound dataset to get the type from.

pojoClass - The class to use for the mapping.

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

Returns:

The compound data type.

getDataSetType

<T> HDF5CompoundType<T> getDataSetType(java.lang.String objectPath,
                                       java.lang.Class<T> pojoClass,
                                       HDF5CompoundMappingHints hints)

Returns the compound type for the given compound data set in objectPath, mapping it to pojoClass.

Parameters:

objectPath - The path of the compound dataset to get the type from.

pojoClass - The class to use for the mapping.

hints - The hints to provide to the mapping procedure.

Returns:

The compound data type.

getDataSetType

<T> HDF5CompoundType<T> getDataSetType(java.lang.String objectPath,
                                       java.lang.Class<T> pojoClass,
                                       HDF5CompoundMappingHints hints,
                                       boolean requireTypesToBeEqual)

Returns the compound type for the given compound data set in objectPath, mapping it to pojoClass.

Parameters:

objectPath - The path of the compound dataset to get the type from.

pojoClass - The class to use for the mapping.

hints - The hints to provide to the mapping procedure.

requireTypesToBeEqual - If true, this type is required to be equal to the type it tries to read, or else an HDF5JavaException will be thrown.

Returns:

The compound data type.

getDataSetType

<T> HDF5CompoundType<T> getDataSetType(java.lang.String objectPath,
                                       java.lang.Class<T> pojoClass)

Returns the compound type for the given compound data set in objectPath, mapping it to pojoClass.

Parameters:

objectPath - The path of the compound dataset to get the type from.

pojoClass - The class to use for the mapping.

getAttributeType

<T> HDF5CompoundType<T> getAttributeType(java.lang.String objectPath,
                                         java.lang.String attributeName,
                                         java.lang.Class<T> pojoClass)

Returns the compound type for the given compound attribute in attributeName of objectPath, mapping it to pojoClass.

Parameters:

objectPath - The path of the compound dataset.

attributeName - The name of the attribute to get the type for.

pojoClass - The class to use for the mapping.

getAttributeType

<T> HDF5CompoundType<T> getAttributeType(java.lang.String objectPath,
                                         java.lang.String attributeName,
                                         java.lang.Class<T> pojoClass,
                                         HDF5CompoundMappingHints hints)

Returns the compound type for the given compound attribute in attributeName of objectPath, mapping it to pojoClass.

Parameters:

objectPath - The path of the compound dataset.

attributeName - The name of the attribute to get the type for.

pojoClass - The class to use for the mapping.

hints - The hints to provide to the mapping procedure.

getAttributeType

<T> HDF5CompoundType<T> getAttributeType(java.lang.String objectPath,
                                         java.lang.String attributeName,
                                         java.lang.Class<T> pojoClass,
                                         HDF5CompoundMappingHints hints,
                                         HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions)

Returns the compound type for the given compound attribute in attributeName of objectPath, mapping it to pojoClass.

Parameters:

objectPath - The path of the compound dataset.

attributeName - The name of the attribute to get the type for.

pojoClass - The class to use for the mapping.

hints - The hints to provide to the mapping procedure.

dataTypeInfoOptions - The options on which information to get about the member data types.

getAttributeType

<T> HDF5CompoundType<T> getAttributeType(java.lang.String objectPath,
                                         java.lang.String attributeName,
                                         java.lang.Class<T> pojoClass,
                                         HDF5CompoundMappingHints hints,
                                         HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions,
                                         boolean requireTypesToBeEqual)

Returns the compound type for the given compound attribute in attributeName of objectPath, mapping it to pojoClass.

Parameters:

objectPath - The path of the compound dataset.

attributeName - The name of the attribute to get the type for.

pojoClass - The class to use for the mapping.

hints - The hints to provide to the mapping procedure.

dataTypeInfoOptions - The options on which information to get about the member data types.

requireTypesToBeEqual - If true, this type is required to be equal to the type it tries to read, or else an HDF5JavaException will be thrown.

getNamedType

<T> HDF5CompoundType<T> getNamedType(java.lang.String dataTypeName,
                                     java.lang.Class<T> pojoClass)

Returns the named compound type with name dataTypeName from file, mapping it to pojoClass. If the dataTypeName starts with '/', it will be considered a data type path instead of a data type name.

Note: This method only works for compound data types 'committed' to the HDF5 file. For files written with JHDF5 this will always be true, however, files created with other libraries may not choose to commit compound data types.

Parameters:

dataTypeName - The path to a committed data type, if starting with '/', or a name of a committed data type otherwise.

pojoClass - The class to use for the mapping.

Returns:

The compound data type.

getNamedType

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

Returns the named compound type with name dataTypeName from file, mapping it to pojoClass. This method will use the default name for the compound data type as chosen by JHDF5 and thus will likely only work on files written with JHDF5. The default name is based on the simple name of compoundType.

Parameters:

pojoClass - The class to use for the mapping and to get the name of named data type from.

Returns:

The compound data type.

getNamedType

<T> HDF5CompoundType<T> getNamedType(java.lang.String dataTypeName,
                                     java.lang.Class<T> pojoClass,
                                     HDF5CompoundMappingHints hints)

Returns the named compound type with name dataTypeName from file, mapping it to pojoClass. If the dataTypeName starts with '/', it will be considered a data type path instead of a data type name.

Note: This method only works for compound data types 'committed' to the HDF5 file. For files written with JHDF5 this will always be true, however, files created with other libraries may not choose to commit compound data types.

Parameters:

dataTypeName - The path to a committed data type, if starting with '/', or a name of a committed data type otherwise.

pojoClass - The class to use for the mapping.

hints - The hints to provide to the mapping procedure.

Returns:

The compound data type.

getNamedType

<T> HDF5CompoundType<T> getNamedType(java.lang.String dataTypeName,
                                     java.lang.Class<T> pojoClass,
                                     HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions)

Returns the named compound type with name dataTypeName from file, mapping it to pojoClass. If the dataTypeName starts with '/', it will be considered a data type path instead of a data type name.

Note: This method only works for compound data types 'committed' to the HDF5 file. For files written with JHDF5 this will always be true, however, files created with other libraries may not choose to commit compound data types.

Parameters:

dataTypeName - The path to a committed data type, if starting with '/', or a name of a committed data type otherwise.

pojoClass - The class to use for the mapping.

dataTypeInfoOptions - The options on which information to get about the member data types.

Returns:

The compound data type.

getNamedType

<T> HDF5CompoundType<T> getNamedType(java.lang.String dataTypeName,
                                     java.lang.Class<T> pojoClass,
                                     HDF5CompoundMappingHints hints,
                                     HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions)

Returns the named compound type with name dataTypeName from file, mapping it to pojoClass. If the dataTypeName starts with '/', it will be considered a data type path instead of a data type name.

Note: This method only works for compound data types 'committed' to the HDF5 file. For files written with JHDF5 this will always be true, however, files created with other libraries may not choose to commit compound data types.

Parameters:

dataTypeName - The path to a committed data type, if starting with '/', or a name of a committed data type otherwise.

pojoClass - The class to use for the mapping.

hints - The hints to provide to the mapping procedure.

dataTypeInfoOptions - The options on which information to get about the member data types.

Returns:

The compound data type.

getNamedType

<T> HDF5CompoundType<T> getNamedType(java.lang.String dataTypeName,
                                     java.lang.Class<T> pojoClass,
                                     HDF5CompoundMappingHints hints,
                                     HDF5DataTypeInformation.DataTypeInfoOptions dataTypeInfoOptions,
                                     boolean requireTypesToBeEqual)

Returns the named compound type with name dataTypeName from file, mapping it to pojoClass. If the dataTypeName starts with '/', it will be considered a data type path instead of a data type name.

Note: This method only works for compound data types 'committed' to the HDF5 file. For files written with JHDF5 this will always be true, however, files created with other libraries may not choose to commit compound data types.

Parameters:

dataTypeName - The path to a committed data type, if starting with '/', or a name of a committed data type otherwise.

pojoClass - The class to use for the mapping.

hints - The hints to provide to the mapping procedure.

dataTypeInfoOptions - The options on which information to get about the member data types.

requireTypesToBeEqual - If true, this type is required to be equal to the type it tries to read, or else an HDF5JavaException will be thrown.

Returns:

The compound data type.