com.gigaspaces.internal.metadata

Class SpaceCollectionIndex

java.lang.Object

com.gigaspaces.internal.serialization.AbstractExternalizable

com.gigaspaces.metadata.index.AbstractSpaceIndex

com.gigaspaces.internal.metadata.SpaceCollectionIndex

All Implemented Interfaces:

ISwapExternalizable, ISpaceIndex, SpaceIndex, SmartExternalizable, Externalizable, Serializable

public class SpaceCollectionIndex
extends AbstractSpaceIndex

An index for a path containing a collection ("[*]").

Since:

8.0

Author:

idan

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

Modifier and Type	Field and Description
protected SpaceEntryCollectionValuesExtractor	_valuesExtractor
static String	COLLECTION_INDICATOR

Constructor Summary

Constructors

Constructor and Description
SpaceCollectionIndex()
SpaceCollectionIndex(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)
ISpaceIndex.MultiValuePerEntryIndexTypes	getMultiValueIndexType()
boolean	isMultiValuePerEntryIndex()
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, getName, getNumSegments, hashCode, isCompoundIndex, 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

Field Detail

COLLECTION_INDICATOR

public static final String COLLECTION_INDICATOR

See Also:

Constant Field Values

_valuesExtractor

protected SpaceEntryCollectionValuesExtractor _valuesExtractor

Constructor Detail

SpaceCollectionIndex

public SpaceCollectionIndex()

SpaceCollectionIndex

public SpaceCollectionIndex(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

getIndexValueForTemplate

public Object getIndexValueForTemplate(ServerEntry entry)

Returns:

the value that will be used for single template value indexing

isMultiValuePerEntryIndex

public boolean isMultiValuePerEntryIndex()

Specified by:

isMultiValuePerEntryIndex in interface ISpaceIndex

Overrides:

isMultiValuePerEntryIndex in class AbstractSpaceIndex

Returns:

true if the index is a multi-value index

getMultiValueIndexType

public ISpaceIndex.MultiValuePerEntryIndexTypes getMultiValueIndexType()

Specified by:

getMultiValueIndexType in interface ISpaceIndex

Overrides:

getMultiValueIndexType in class AbstractSpaceIndex

Returns:

the type of multi-value index

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