ch.systemsx.cisd.hdf5

Annotation Type CompoundElement

@Retention(value=RUNTIME)
 @Target(value=FIELD)
public @interface CompoundElement

A marker annotation for fields intended to be mapped to an HDF5 compound data type member. This marker interface is optional for many fields as otherwise the fields properties are inferred. However, for arrays, Strings and BitSets the maximum length needs to be given in dimensions().

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int[]	dimensions The length / dimensions of the compound member.
java.lang.String	memberName The name of the member in the compound type.
boolean	reference If true, map this string field to an HDF5 reference type.
java.lang.String	typeName The name of the type (for Java enumeration types only).
HDF5DataTypeVariant	typeVariant The HDF5DataTypeVariant of this compound element, if any.
boolean	unsigned If true, map this integer field to an unsigned integer type.
boolean	variableLength If true, map this string field to a variable-length string type.

Element Detail

memberName

public abstract java.lang.String memberName

The name of the member in the compound type. Leave empty to use the field name as member name.

Default:

""

typeName

public abstract java.lang.String typeName

The name of the type (for Java enumeration types only). Leave empty to use the simple class name as the type name.

Default:

""

dimensions

public abstract int[] dimensions

The length / dimensions of the compound member. Is required for compound members that have a variable length, e.g. strings or primitive arrays. Ignored for compound members that have a fixed length, e.g. a float field.

Default:

0

unsigned

public abstract boolean unsigned

If true, map this integer field to an unsigned integer type.

Default:

false

variableLength

public abstract boolean variableLength

If true, map this string field to a variable-length string type.

Default:

false

reference

public abstract boolean reference

If true, map this string field to an HDF5 reference type.

Default:

false

typeVariant

public abstract HDF5DataTypeVariant typeVariant

The HDF5DataTypeVariant of this compound element, if any.

Default:

ch.systemsx.cisd.hdf5.HDF5DataTypeVariant.NONE