Package com.gigaspaces.metadata.index

Class CompoundIndex

java.lang.Object

com.gigaspaces.internal.serialization.AbstractExternalizable

com.gigaspaces.metadata.index.AbstractSpaceIndex

com.gigaspaces.metadata.index.CustomIndex

com.gigaspaces.metadata.index.CompoundIndex

All Implemented Interfaces:

ISwapExternalizable, ISpaceIndex, SpaceIndex, SmartExternalizable, Externalizable, Serializable

public class CompoundIndex
extends CustomIndex

definition of a compound index meta data

Since:

9.5

Author:

Yechiel

See Also:

• Serialized Form

Nested Class Summary

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

ISpaceIndex.FifoGroupsIndexTypes, ISpaceIndex.IndexOriginTypes, ISpaceIndex.MultiValuePerEntryIndexTypes

Field Summary

Fields inherited from class com.gigaspaces.metadata.index.CustomIndex

_indexValueGetter

Constructor Summary

Constructors

Constructor	Description
CompoundIndex()
CompoundIndex(String[] paths)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
ISpaceCompoundIndexSegment[]	getCompoundIndexSegments()
Object	getIndexValue(ServerEntry entry)
Object	getIndexValueForTemplate(ServerEntry entry)
int	getNumSegments()
boolean	isCompoundIndex()
boolean	isEquivalent(CompoundIndex other)
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.CustomIndex

getIndexOriginType

Methods inherited from class com.gigaspaces.metadata.index.AbstractSpaceIndex

getIndexType, getIndexValueFromCustomIndex, getMultiValueIndexType, getName, hashCode, 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 java.io.Externalizable

readExternal, writeExternal

Methods inherited from interface com.gigaspaces.serialization.SmartExternalizable

enabledSmartExternalizableWithReference

Constructor Details

CompoundIndex

public CompoundIndex()

CompoundIndex

public CompoundIndex(String[] paths)

Method Details

isCompoundIndex

public boolean isCompoundIndex()

Specified by:

isCompoundIndex in interface ISpaceIndex

Overrides:

isCompoundIndex in class AbstractSpaceIndex

Returns:

true if its a compound index

getCompoundIndexSegments

public ISpaceCompoundIndexSegment[] getCompoundIndexSegments()

Specified by:

getCompoundIndexSegments in interface ISpaceIndex

Overrides:

getCompoundIndexSegments in class AbstractSpaceIndex

Returns:

segments of compound index

getNumSegments

public int getNumSegments()

Overrides:

getNumSegments in class AbstractSpaceIndex

getIndexValueForTemplate

public Object getIndexValueForTemplate(ServerEntry entry)

Specified by:

getIndexValueForTemplate in interface ISpaceIndex

Overrides:

getIndexValueForTemplate in class CustomIndex

Returns:

the value that will be used for single template value indexing

getIndexValue

public Object getIndexValue(ServerEntry entry)

Specified by:

getIndexValue in interface ISpaceIndex

Overrides:

getIndexValue in class CustomIndex

Returns:

the value that will be used to index the data

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractSpaceIndex

isEquivalent

public boolean isEquivalent(CompoundIndex other)

readExternalImpl

protected void readExternalImpl(ObjectInput in)
                         throws IOException,
ClassNotFoundException

Overrides:

readExternalImpl in class CustomIndex

Throws:

IOException

ClassNotFoundException

readFromSwap

public void readFromSwap(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readFromSwap in interface ISwapExternalizable

Overrides:

readFromSwap in class CustomIndex

Throws:

IOException

ClassNotFoundException

writeExternalImpl

protected void writeExternalImpl(ObjectOutput out)
                          throws IOException

Overrides:

writeExternalImpl in class CustomIndex

Throws:

IOException

writeToSwap

public void writeToSwap(ObjectOutput out)
                 throws IOException

Specified by:

writeToSwap in interface ISwapExternalizable

Overrides:

writeToSwap in class CustomIndex

Throws:

IOException