org.eclipse.persistence.annotations

Annotation Type CacheIndex

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

Allow a cache index to be define. A cache index allow singleResult queries to obtain a cache hit when querying on the indexed fields. resultList queries cannot obtain cache hits, as it is unknown if all of the objects are in memory, (unless the cache usage query hint is used). The index should be unique, but if not unique, the first indexed object will be returned. Cache indexes are only relevant when caching is enabled. The @CacheIndex can be defined on a Entity class, or on an attribute. The column is defaulted when defined on a attribute.

Author:

James Sutherland

Since:

EclipseLink 2.4

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	columnNames Specify the set of columns to define the index on.
boolean	updateable Specify if the indexed field is updateable.

Element Detail

columnNames

public abstract java.lang.String[] columnNames

Specify the set of columns to define the index on. Not required when annotated on a field/method.

Default:

{}

updateable

public abstract boolean updateable

Specify if the indexed field is updateable. If updateable the object will be re-indexed on each update/refresh.

Default:

true