GigaSpaces XAP 10.0.1 API

com.gigaspaces.annotation.pojo
Annotation Type SpaceIndex


@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface SpaceIndex

 Defines a space index. 
 Can be defined on the property getter or as part of @SpaceIndexes when multiple indexes are used.
 
 Indexes on nested object properties are defined on the nested object getter.
 
 For example:
 
 
  To index the 'socialSecurity' property using extended indexing:
  1. @SpaceIndex(type = IndexType.EXTENDED)
     public long getSocialSecurity() {
         return socialSecurity;
       }

    To index 'personalInfo.name': 
  2. @SpaceIndex(path = "name")
     public Info getPersonalInfo() {
         return personalInfo;
      }


 

Since:
7.1
Author:
Anna Pavtulov

Optional Element Summary
 String path
          Defines the index property path.
 SpaceIndexType type
          The type of the index - default is BASIC index
 boolean unique
          Indicates if unique constraint is applied for this index.
 

path

public abstract String path
Defines the index property path. The path specifies which property path is indexed. If none is defined - the property itself is indexed.

Default:
""

type

public abstract SpaceIndexType type
The type of the index - default is BASIC index

Default:
com.gigaspaces.metadata.index.SpaceIndexType.BASIC

unique

public abstract boolean unique
Indicates if unique constraint is applied for this index. The constraint is per partition. default is false

Default:
false

GigaSpaces XAP 10.0.1 API

Copyright © GigaSpaces.