javax.jdo.annotations
Annotation Type Index

@Target(value={TYPE,FIELD,METHOD})
@Retention(value=RUNTIME)
public @interface Index

Annotation for a database index. Used for database schema generation to create indexes. Corresponds to the xml element "index".

Since:

2.1

Version:

2.1

Optional Element Summary

Column[]	columns Columns that compose this index.
java.lang.String[]	members Member (field and property) names that compose this index.
java.lang.String	name Name of the index
java.lang.String	table Table for the index.
java.lang.String	unique Whether this index is unique

name

public abstract java.lang.String name

Name of the index

Returns:

the name of the index

Default:

""

table

public abstract java.lang.String table

Table for the index. This is needed iff annotating a type where the index is not defined on the primary table for the type.

Returns:

the table on which the index is defined

Default:

""

unique

public abstract java.lang.String unique

Whether this index is unique

Returns:

whether this index is unique

Default:

""

members

public abstract java.lang.String[] members

Member (field and property) names that compose this index.

Returns:

member names that compose this index

Default:

{}

columns

public abstract Column[] columns

Columns that compose this index.

Returns:

columns that compose this index

Default:

{}