1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package javax.jdo.annotations;
18
19 import java.lang.annotation.ElementType;
20 import java.lang.annotation.Retention;
21 import java.lang.annotation.RetentionPolicy;
22 import java.lang.annotation.Target;
23
24 /**
25 * Annotation for a database index. Used for database schema
26 * generation to create indexes.
27 * Corresponds to the xml element "index".
28 *
29 * @version 2.1
30 * @since 2.1
31 */
32 @Target({ElementType.TYPE, ElementType.FIELD, ElementType.METHOD})
33 @Retention(RetentionPolicy.RUNTIME)
34 public @interface Index
35 {
36 /** Name of the index
37 * @return the name of the index
38 */
39 String name() default "";
40
41 /** Table for the index. This is needed iff annotating a type where
42 * the index is not defined on the primary table for the type.
43 * @return the table on which the index is defined
44 */
45 String table() default "";
46
47 /** Whether this index is unique
48 * @return whether this index is unique
49 */
50 String unique() default "";
51
52 /** Member (field and property) names that compose this index.
53 * @return member names that compose this index
54 */
55 String[] members() default {};
56
57 /** Columns that compose this index.
58 * @return columns that compose this index
59 */
60 Column[] columns() default {};
61 }