Package com.gigaspaces.internal.query

Class RelationIndexScanner

java.lang.Object

com.gigaspaces.internal.query.AbstractQueryIndex

com.gigaspaces.internal.query.RelationIndexScanner

All Implemented Interfaces:

IQueryIndexScanner, SmartExternalizable, Externalizable, Serializable

public class RelationIndexScanner
extends AbstractQueryIndex

Scans the index using an external index using one of the relation that the external index is know to handle.

Since:

11.0

Author:

barak

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
RelationIndexScanner()
RelationIndexScanner(String typeName, String path, String namespace, String relation, Object subject)

Method Summary

Modifier and Type	Method	Description
protected IObjectsList	getEntriesByIndex(Context context, TypeData typeData, TypeDataIndex<Object> index, boolean fifoGroupsScan)
IObjectsList	getIndexedEntriesByType(Context context, TypeData typeData, ITemplateHolder template, int latestIndexToConsider)
AtomicLong	getIndexUsageCounter(TypeData typeData)
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

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.serialization.SmartExternalizable

enabledSmartExternalizableWithReference

Constructor Details

RelationIndexScanner

public RelationIndexScanner()

RelationIndexScanner

public RelationIndexScanner(String typeName,
 String path,
 String namespace,
 String relation,
 Object subject)

Method Details

getIndexedEntriesByType

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

Specified by:

getIndexedEntriesByType in interface IQueryIndexScanner

Overrides:

getIndexedEntriesByType in class AbstractQueryIndex

getEntriesByIndex

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

Specified by:

getEntriesByIndex in class AbstractQueryIndex

requiresOrderedIndex

public boolean requiresOrderedIndex()

Description copied from interface: IQueryIndexScanner

Returns true if this index scanner requires an ordered index

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 .

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

getIndexUsageCounter

public AtomicLong getIndexUsageCounter(TypeData typeData)