org.dizitart.no2.objects

Annotation Type Index

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

Specifies a field to be indexed.

Example of Index annotation

 @Index(value = "companyName")
 public class Company implements Serializable {

     @Id
     private long companyId;

     private String companyName;

 }

Since:

1.0

See Also:

PersistentCollection.createIndex(String, org.dizitart.no2.IndexOptions)

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	value The field name to be indexed.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
IndexType	type Type of the index.

Element Detail

value

public abstract java.lang.String value

The field name to be indexed.

Returns:

the field name

type

public abstract IndexType type

Type of the index.

Returns:

the index type

Default:

org.dizitart.no2.IndexType.Unique