com.sptci.prevayler.annotations
Annotation Type Index

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

Annotation used to indicate that a field in a prevalent object is to be indexed. Note that this annotation is meant for indexing fields that are not references to other prevalent object(s). Use ForeignKey for fields that are references to other prevalent objects.

© Copyright 2008 Sans Pareil Technologies, Inc.

Version:

$Id: Index.java 11 2008-06-30 21:33:41Z sptrakesh $

Author:

Rakesh Vidyadharan 2008-05-22

Optional Element Summary

String[]	members The name of the fields in the prevalent object to index.
boolean	unique An optional flag used to indicate that the index represents a unique index.

members

public abstract String[] members

The name of the fields in the prevalent object to index. This need only be specified when specified at the class level. Multiple fields may be specified to indicate a composite index. Defaults to NULL.

Returns:

The name of the fields.

Default:

""

unique

public abstract boolean unique

An optional flag used to indicate that the index represents a unique index. Defaults to false.

Returns:

The flag indicating whether the index is unique or not.

Default:

false