Package com.gigaspaces.internal.query

Class RangeCompoundIndexScanner

java.lang.Object

com.gigaspaces.internal.query.AbstractQueryIndex

com.gigaspaces.internal.query.RangeCompoundIndexScanner

All Implemented Interfaces:

IQueryIndexScanner, SmartExternalizable, Externalizable, Serializable

public class RangeCompoundIndexScanner
extends AbstractQueryIndex

Scans only the entries in the defined range via compound index

Since:

9.5

Author:

Yechiel

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.gigaspaces.internal.query.IQueryIndexScanner

IQueryIndexScanner.ResultIndicator

Field Summary

Fields inherited from interface com.gigaspaces.internal.query.IQueryIndexScanner

RESULT_IGNORE_INDEX, RESULT_NO_MATCH

Constructor Summary

Constructors

Constructor	Description
RangeCompoundIndexScanner()
RangeCompoundIndexScanner(String indexName, Comparable<?>[] min, boolean includeMin, boolean includeMinFirstSegment, Comparable<?>[] max, boolean includeMax, boolean includeMaxFirstSegment)

Method Summary

Modifier and Type	Method	Description
static RangeCompoundIndexScanner	build(String name, List<Range> possibleSegments, boolean isFirstSegmentIndexed)
protected IObjectsList	getEntriesByIndex(Context context, TypeData typeData, TypeDataIndex<Object> index, boolean fifoGroupsScan)
Object	getIndexValue()	The value of the index - objects are indexed and stored according to specific index value.
protected boolean	hasIndexValue()
void	readExternal(ObjectInput in)
boolean	requiresOrderedIndex()	Returns true if this index scanner requires an ordered index
boolean	supportsTemplateIndex()	Returns true if this index scanner supports template indexing
void	writeExternal(ObjectOutput out)

Methods inherited from class com.gigaspaces.internal.query.AbstractQueryIndex

getIndexedEntriesByType, getIndexName, isExtendsAbstractQueryIndex, isUidsScanner, requiresValueForIndexSearch, supportsFifoOrder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.gigaspaces.internal.query.IQueryIndexScanner

getIndexUsageCounter

Methods inherited from interface com.gigaspaces.serialization.SmartExternalizable

enabledSmartExternalizableWithReference

Constructor Details

RangeCompoundIndexScanner

public RangeCompoundIndexScanner()

RangeCompoundIndexScanner

public RangeCompoundIndexScanner(String indexName,
 Comparable<?>[] min,
 boolean includeMin,
 boolean includeMinFirstSegment,
 Comparable<?>[] max,
 boolean includeMax,
 boolean includeMaxFirstSegment)

Method Details

getEntriesByIndex

protected IObjectsList getEntriesByIndex(Context context,
 TypeData typeData,
 TypeDataIndex<Object> index,
 boolean fifoGroupsScan)

Specified by:

getEntriesByIndex in class AbstractQueryIndex

hasIndexValue

protected boolean hasIndexValue()

Specified by:

hasIndexValue in class AbstractQueryIndex

getIndexValue

public Object getIndexValue()

Description copied from interface: IQueryIndexScanner

The value of the index - objects are indexed and stored according to specific index value. This value will be used to search the index structure for entries that match this value .

requiresOrderedIndex

public boolean requiresOrderedIndex()

Description copied from interface: IQueryIndexScanner

Returns true if this index scanner requires an ordered index

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class AbstractQueryIndex

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class AbstractQueryIndex

Throws:

IOException

supportsTemplateIndex

public boolean supportsTemplateIndex()

Description copied from interface: IQueryIndexScanner

Returns true if this index scanner supports template indexing

build

public static RangeCompoundIndexScanner build(String name,
 List<Range> possibleSegments,
 boolean isFirstSegmentIndexed)