org.jsimpledb.annotation

Annotation Type JCompositeIndex

@Retention(value=RUNTIME)
 @Target(value={})
 @Documented
public @interface JCompositeIndex

Java annotation defining a composite index on a JSimpleClass-annotated class.

A composite index is an index on two or more fields (to define a single-field index, just set JField.indexed() to true). All fields indexed in a composite index must be (a) simple and (b) not a sub-field of a complex field.

See Also:

JSimpleClass

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	fields The names of the indexed fields, in the desired order.
String	name The name of this composite index.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	storageId The storage ID for this composite index.

Element Detail

name

public abstract String name

The name of this composite index. Must be globally unique.

Returns:

the index name

fields

public abstract String[] fields

The names of the indexed fields, in the desired order. At least two fields must be specified.

Returns:

the names of the indexed fields

storageId

public abstract int storageId

The storage ID for this composite index. Value should be positive; if zero, the configured StorageIdGenerator will be consulted to auto-generate a value.

Returns:

the index storage ID

See Also:

StorageIdGenerator.generateCompositeIndexStorageId()

Default:

0