Package com.gigaspaces.metadata.index

Class AbstractSpaceIndex

java.lang.Object

com.gigaspaces.internal.serialization.AbstractExternalizable

com.gigaspaces.metadata.index.AbstractSpaceIndex

All Implemented Interfaces:

ISwapExternalizable, ISpaceIndex, SpaceIndex, SmartExternalizable, Externalizable, Serializable

Direct Known Subclasses:

CustomIndex, SpaceCollectionIndex, SpacePathIndex, SpacePropertyIndex

public abstract class AbstractSpaceIndex
extends AbstractExternalizable
implements ISpaceIndex

Since:

7.1

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

Modifier	Constructor	Description
	AbstractSpaceIndex()
protected	AbstractSpaceIndex(String indexName, SpaceIndexType indexType, boolean isUnique)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
ISpaceCompoundIndexSegment[]	getCompoundIndexSegments()
SpaceIndexType	getIndexType()	Gets the type of the index.
protected Object	getIndexValueFromCustomIndex(ServerEntry entry)	This method is used by custom indexes (custom, path & collection).
ISpaceIndex.MultiValuePerEntryIndexTypes	getMultiValueIndexType()
String	getName()	Gets the name of the index.
int	getNumSegments()
int	hashCode()
boolean	isCompoundIndex()
boolean	isMultiValuePerEntryIndex()
boolean	isUnique()	Returns true if this index has a unique constraint, false otherwise.
protected void	readExternalImpl(ObjectInput in)
void	readFromSwap(ObjectInput in)
void	setUnique(boolean val)	sets the unique indicator to the desired value.
String	toString()
protected void	writeExternalImpl(ObjectOutput out)
void	writeToSwap(ObjectOutput out)

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.metadata.index.ISpaceIndex

getIndexOriginType, getIndexValue, getIndexValueForTemplate

Methods inherited from interface com.gigaspaces.serialization.SmartExternalizable

enabledSmartExternalizableWithReference

Constructor Details

AbstractSpaceIndex

public AbstractSpaceIndex()

AbstractSpaceIndex

protected AbstractSpaceIndex(String indexName,
 SpaceIndexType indexType,
 boolean isUnique)

Method Details

getName

public String getName()

Description copied from interface: SpaceIndex

Gets the name of the index.

Specified by:

getName in interface SpaceIndex

getIndexType

public SpaceIndexType getIndexType()

Description copied from interface: SpaceIndex

Gets the type of the index.

Specified by:

getIndexType in interface SpaceIndex

isUnique

public boolean isUnique()

Description copied from interface: SpaceIndex

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

Specified by:

isUnique in interface SpaceIndex

Returns:

true if index is unique

setUnique

public void setUnique(boolean val)

Description copied from interface: ISpaceIndex

sets the unique indicator to the desired value.

Specified by:

setUnique in interface ISpaceIndex

isMultiValuePerEntryIndex

public boolean isMultiValuePerEntryIndex()

Specified by:

isMultiValuePerEntryIndex in interface ISpaceIndex

Returns:

true if the index is a multi-value index

getMultiValueIndexType

public ISpaceIndex.MultiValuePerEntryIndexTypes getMultiValueIndexType()

Specified by:

getMultiValueIndexType in interface ISpaceIndex

Returns:

the type of multi-value index

isCompoundIndex

public boolean isCompoundIndex()

Specified by:

isCompoundIndex in interface ISpaceIndex

Returns:

true if its a compound index

getCompoundIndexSegments

public ISpaceCompoundIndexSegment[] getCompoundIndexSegments()

Specified by:

getCompoundIndexSegments in interface ISpaceIndex

Returns:

segments of compound index

getNumSegments

public int getNumSegments()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

readExternalImpl

protected void readExternalImpl(ObjectInput in)
                         throws IOException,
ClassNotFoundException

Overrides:

readExternalImpl in class AbstractExternalizable

Throws:

IOException

ClassNotFoundException

readFromSwap

public void readFromSwap(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readFromSwap in interface ISwapExternalizable

Throws:

IOException

ClassNotFoundException

writeExternalImpl

protected void writeExternalImpl(ObjectOutput out)
                          throws IOException

Overrides:

writeExternalImpl in class AbstractExternalizable

Throws:

IOException

writeToSwap

public void writeToSwap(ObjectOutput out)
                 throws IOException

Specified by:

writeToSwap in interface ISwapExternalizable

Throws:

IOException

getIndexValueFromCustomIndex

protected Object getIndexValueFromCustomIndex(ServerEntry entry)

This method is used by custom indexes (custom, path & collection).

Returns:

The index value stored in the custom query's custom indexes.

toString

public String toString()

Overrides:

toString in class Object