com.gigaspaces.metadata.index
Interface ISpaceIndex

All Superinterfaces:

Externalizable, Serializable

public interface ISpaceIndex
extends Externalizable

Encapsulates information about an index in a space type. Index defines how the objects of this class are stored: Index can be:

basic - supports efficiently equality queries.

extended - supports range queries

Index also defines how the index value is extracted from the given entry.

Usage example:
@SpaceIndex(path="personalInfo.address")

Since:

7.1

Author:

Niv Ingberg

Method Summary

Object	getIndexValue(IServerEntry entry)
String	getName() Gets the name of the index.
SpaceIndexType	getType() Gets the type of the index.
boolean	isUnique() Returns true if this index has a unique constrint, false otherwise.

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Method Detail

getName

String getName()

Gets the name of the index.

Returns:

The index name.

getType

SpaceIndexType getType()

Gets the type of the index.

Returns:

The index type,

isUnique

boolean isUnique()

Returns true if this index has a unique constrint, false otherwise.

Returns:

true if index is unique

getIndexValue

Object getIndexValue(IServerEntry entry)

Parameters:

entry -

Returns:

the value that will be used to index the data