com.gigaspaces.metadata.index

Class SpacePathIndex

java.lang.Object

com.gigaspaces.internal.serialization.AbstractExternalizable

com.gigaspaces.metadata.index.AbstractSpaceIndex

com.gigaspaces.metadata.index.SpacePathIndex

All Implemented Interfaces:

ISwapExternalizable, ISpaceIndex, SpaceIndex, SmartExternalizable, Externalizable, Serializable

public class SpacePathIndex
extends AbstractSpaceIndex

This type is intended for internal usage and should not be used directly. Use SpaceIndexFactory to create space indexes.

Since:

8.0

Author:

Niv Ingberg

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.gigaspaces.metadata.index.ISpaceIndex

ISpaceIndex.FifoGroupsIndexTypes, ISpaceIndex.IndexOriginTypes, ISpaceIndex.MultiValuePerEntryIndexTypes

Constructor Summary

Constructors

Constructor and Description
SpacePathIndex()
SpacePathIndex(String path, SpaceIndexType indexType, boolean unique)

Method Summary

Modifier and Type	Method and 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 com.gigaspaces.metadata.index.AbstractSpaceIndex

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

Methods inherited from class com.gigaspaces.internal.serialization.AbstractExternalizable

readExternal, writeExternal

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gigaspaces.serialization.SmartExternalizable

enabledSmartExternalizableWithReference

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Constructor Detail

SpacePathIndex

public SpacePathIndex()

SpacePathIndex

public SpacePathIndex(String path,
                      SpaceIndexType indexType,
                      boolean unique)

Method Detail

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

getIndexValueForTemplate

public Object getIndexValueForTemplate(ServerEntry entry)

Returns:

the value that will be used for single template value indexing

readExternalImpl

protected void readExternalImpl(ObjectInput in)
                         throws IOException,
                                ClassNotFoundException

Overrides:

readExternalImpl 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

readFromSwap

public void readFromSwap(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readFromSwap in interface ISwapExternalizable

Overrides:

readFromSwap in class AbstractSpaceIndex

Throws:

IOException

ClassNotFoundException