nl.qbusict.cupboard.annotation

Annotation Type Index

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

Annotation interface that allows one to create an index or composite index for a column/s by specifying index_names, unique_index or unique_index_names in an Annotation. This is only useful depending on the nature of your data and is only used for table creation / update. A generated name will be used in table create or update unless indexNames() or uniqueNames() are used. If the column is just annotated and no parameters are provided, a simple index with a generic name will be created.

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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
CompositeIndex[]	indexNames
boolean	unique
CompositeIndex[]	uniqueNames

Element Detail

indexNames

public abstract CompositeIndex[] indexNames

Returns:

names of indexes this field is going to be in. If another field shares the same indexName, a composite index is created based on both fields under that indexName. It can be also used for custom index naming.

Default:

{}

unique

public abstract boolean unique

Returns:

whether this field should be an unique index or not. A generated name will be used in table create or update; use uniqueNames() with one value if you want to use a custom name.

Default:

false

uniqueNames

public abstract CompositeIndex[] uniqueNames

Returns:

names of unique indexes this field is going to be in. If another field shares the same indexName, a composite index is created based on both fields under that indexName. It can be also used for custom unique index naming.

Default:

{}