com.gigaspaces.internal.metadata.annotations

Annotation Type CustomSpaceIndex

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Repeatable(value=CustomSpaceIndexes.class)
public @interface CustomSpaceIndex

Defines an annotation for defining custom space indexes. Can be defined on the pojo class or as part of the @SpaceClass(customIndexes) For example: When only one custom index is needed:

Since:

7.1

Author:

Anna Pavtulov

Field Summary

Fields

Modifier and Type	Fields and Description
static String	EMPTY_VALUE

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<? extends ISpaceValueGetter<ServerEntry>>	indexValueGetter Reference to a class that implements ISpaceValueGetter .

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	name Defines index name.
SpaceIndexType	type Defines the index type.
boolean	unique Defines whether this index is unique or not

Field Detail

EMPTY_VALUE

public static final String EMPTY_VALUE

Element Detail

indexValueGetter

public abstract Class<? extends ISpaceValueGetter<ServerEntry>> indexValueGetter

 Reference to a class that implements ISpaceValueGetter .
 The implementation defines how the index value is extracted
 from the IServerEntry - the space internal object representation
 

name

public abstract String name

Defines index name. Used to find the right index duting query matching.

Default:

""

unique

public abstract boolean unique

Defines whether this index is unique or not

Default:

false

type

public abstract SpaceIndexType type

Defines the index type.

Default:

com.gigaspaces.metadata.index.SpaceIndexType.EQUAL