Class CustomIndex

java.lang.Object

com.gigaspaces.internal.serialization.AbstractExternalizable

com.gigaspaces.metadata.index.AbstractSpaceIndex

com.gigaspaces.metadata.index.CustomIndex

All Implemented Interfaces:

ISwapExternalizable, ISpaceIndex, SpaceIndex, SmartExternalizable, Externalizable, Serializable

Direct Known Subclasses:

CompoundIndex

public class CustomIndex
extends AbstractSpaceIndex

Default implementation of the space custom index meta data

Since:

7.1

Author:

anna

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface ISpaceIndex

ISpaceIndex.FifoGroupsIndexTypes, ISpaceIndex.IndexOriginTypes, ISpaceIndex.MultiValuePerEntryIndexTypes

Field Summary

Fields

Modifier and Type	Field	Description
protected ISpaceValueGetter<ServerEntry>	_indexValueGetter

Constructor Summary

Constructors

Constructor	Description
CustomIndex()
CustomIndex(String indexName, ISpaceValueGetter<ServerEntry> indexValueGetter, boolean isUnique, SpaceIndexType indexType)

Method Summary

Modifier and Type	Method	Description
ISpaceIndex.IndexOriginTypes	getIndexOriginType()
Object	getIndexValue(ServerEntry entry)
Object	getIndexValueForTemplate(ServerEntry entry)
protected void	readExternalImpl(ObjectInput in)
void	readFromSwap(ObjectInput in)
protected void	writeExternalImpl(ObjectOutput out)
void	writeToSwap(ObjectOutput out)

Methods inherited from class AbstractSpaceIndex

equals, getCompoundIndexSegments, getIndexType, getIndexValueFromCustomIndex, getMultiValueIndexType, getName, getNumSegments, hashCode, isCompoundIndex, isMultiValuePerEntryIndex, isUnique, setUnique, toString

Methods inherited from class AbstractExternalizable

readExternal, writeExternal

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Externalizable

readExternal, writeExternal

Methods inherited from interface SmartExternalizable

enabledSmartExternalizableWithReference

Field Details

_indexValueGetter

protected ISpaceValueGetter<ServerEntry> _indexValueGetter

Constructor Details

CustomIndex

public CustomIndex()

CustomIndex

public CustomIndex(String indexName,
 ISpaceValueGetter<ServerEntry> indexValueGetter,
 boolean isUnique,
 SpaceIndexType indexType)

Method Details

getIndexValue

public Object getIndexValue(ServerEntry entry)

Returns:

the value that will be used to index the data

getIndexOriginType

public ISpaceIndex.IndexOriginTypes getIndexOriginType()

Returns:

the index origin

readExternalImpl

protected void readExternalImpl(ObjectInput in)
                         throws IOException,
ClassNotFoundException

Overrides:

readExternalImpl in class AbstractSpaceIndex

Throws:

IOException

ClassNotFoundException

readFromSwap

public void readFromSwap(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readFromSwap in interface ISwapExternalizable

Overrides:

readFromSwap in class AbstractSpaceIndex

Throws:

IOException

ClassNotFoundException

writeExternalImpl

protected void writeExternalImpl(ObjectOutput out)
                          throws IOException

Overrides:

writeExternalImpl in class AbstractSpaceIndex

Throws:

IOException

writeToSwap

public void writeToSwap(ObjectOutput out)
                 throws IOException

Specified by:

writeToSwap in interface ISwapExternalizable

Overrides:

writeToSwap in class AbstractSpaceIndex

Throws:

IOException

getIndexValueForTemplate

public Object getIndexValueForTemplate(ServerEntry entry)

Returns:

the value that will be used for single template value indexing