com.gigaspaces.internal.query

Interface IQueryIndexScanner

All Superinterfaces:

Externalizable, Serializable

All Known Implementing Classes:

AbstractCompoundIndexScanner, AbstractQueryIndex, CompoundAndIndexScanner, CompoundOrIndexScanner, ExactValueIndexScanner, ExacValueCompoundIndexScanner, InValueIndexScanner, NotRegexIndexScanner, NullValueIndexScanner, RangeCompoundIndexScanner, RangeIndexScanner, RegexIndexScanner, RelationIndexScanner, UidsIndexScanner

public interface IQueryIndexScanner
extends Externalizable

Represents an index that can be provided in a ICustomQuery and optimize the query run time.

Since:

7.1

Author:

anna

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IQueryIndexScanner.ResultIndicator

Field Summary

Fields

Modifier and Type	Field and Description
static IQueryIndexScanner.ResultIndicator	RESULT_IGNORE_INDEX
static IQueryIndexScanner.ResultIndicator	RESULT_NO_MATCH

Method Summary

Modifier and Type	Method and Description
IObjectsList	getIndexedEntriesByType(Context context, TypeData typeData, ITemplateHolder template, int latestIndexToConsider)
String	getIndexName() The name of the index - index is stored in the space by this name
default LongCounter	getIndexUsageCounter(TypeData typeData)
Object	getIndexValue() The value of the index - objects are indexed and stored according to specific index value.
boolean	isExtendsAbstractQueryIndex()
boolean	isUidsScanner()
boolean	requiresOrderedIndex() Returns true if this index scanner requires an ordered index
boolean	supportsFifoOrder() returns true if this index scanner preserves the fifo order
boolean	supportsTemplateIndex() Returns true if this index scanner supports template indexing

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Field Detail

RESULT_NO_MATCH

static final IQueryIndexScanner.ResultIndicator RESULT_NO_MATCH

RESULT_IGNORE_INDEX

static final IQueryIndexScanner.ResultIndicator RESULT_IGNORE_INDEX

Method Detail

getIndexName

String getIndexName()

The name of the index - index is stored in the space by this name

getIndexValue

Object getIndexValue()

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

boolean requiresOrderedIndex()

Returns true if this index scanner requires an ordered index

supportsFifoOrder

boolean supportsFifoOrder()

returns true if this index scanner preserves the fifo order

supportsTemplateIndex

boolean supportsTemplateIndex()

Returns true if this index scanner supports template indexing

isUidsScanner

boolean isUidsScanner()

getIndexedEntriesByType

IObjectsList getIndexedEntriesByType(Context context,
                                     TypeData typeData,
                                     ITemplateHolder template,
                                     int latestIndexToConsider)

isExtendsAbstractQueryIndex

boolean isExtendsAbstractQueryIndex()

getIndexUsageCounter

default LongCounter getIndexUsageCounter(TypeData typeData)