nl.qbusict.cupboard.annotation

Annotation Type CompositeIndex

@Retention(value=RUNTIME)
public @interface CompositeIndex

Annotation interface that allows one to order columns for a composite index (if another column in the same table shares the same index name in Index) For more information see Why order matters?

Note that annotations are not processed by default. To enable processing of annotations construct an instance of Cupboard using CupboardBuilder and call CupboardBuilder.useAnnotations()

Field Summary

Fields

Modifier and Type	Fields and Description
static boolean	DEFAULT_ASCENDING
static java.lang.String	DEFAULT_INDEX_NAME
static int	DEFAULT_ORDER

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	indexName

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	ascending
int	order

Field Detail

DEFAULT_ASCENDING

public static final boolean DEFAULT_ASCENDING

DEFAULT_ORDER

public static final int DEFAULT_ORDER

DEFAULT_INDEX_NAME

public static final java.lang.String DEFAULT_INDEX_NAME

Element Detail

indexName

public abstract java.lang.String indexName

Returns:

name of the composite index if .

ascending

public abstract boolean ascending

Returns:

whether a ascending index should be created on this column. By default it is true.

Default:

true

order

public abstract int order

Returns:

order of the column in the composite index

Default:

0