com.hazelcast.query.impl

Interface InternalIndex

All Superinterfaces:

Index

All Known Implementing Classes:

AbstractIndex, IndexImpl

public interface InternalIndex
extends Index

Provides the private index API.

Nested Class Summary

Nested classes/interfaces inherited from interface com.hazelcast.query.impl.Index

Index.OperationSource

Method Summary

Modifier and Type	Method and Description
boolean	allPartitionsIndexed(int ownedPartitionCount) Returns true if all queryPartitions are indexed, false otherwise.
Comparable	canonicalizeQueryArgumentScalar(Comparable value) Canonicalizes the given value for the purpose of a hash-based lookup.
PerIndexStats	getPerIndexStats() Returns the index stats associated with this index.
boolean	hasPartitionIndexed(int partitionId) Returns true if the given partition is indexed by this index, false otherwise.
void	markPartitionAsIndexed(int partitionId) Marks the given partition as indexed by this index.
void	markPartitionAsUnindexed(int partitionId) Marks the given partition as unindexed by this index.

Methods inherited from interface com.hazelcast.query.impl.Index

canEvaluate, clear, destroy, evaluate, getComponents, getConverter, getName, getRecords, getRecords, getRecords, getRecords, getUniqueKey, isEvaluateOnly, isOrdered, putEntry, removeEntry

Method Detail

canonicalizeQueryArgumentScalar

Comparable canonicalizeQueryArgumentScalar(Comparable value)

Canonicalizes the given value for the purpose of a hash-based lookup.

The method is used while performing InPredicate queries to canonicalize the set of values in question, so additional duplicate-eliminating post-processing step can be avoided.

Parameters:

value - the value to canonicalize.

Returns:

the canonicalized value.

hasPartitionIndexed

boolean hasPartitionIndexed(int partitionId)

Returns true if the given partition is indexed by this index, false otherwise.

allPartitionsIndexed

boolean allPartitionsIndexed(int ownedPartitionCount)

Returns true if all queryPartitions are indexed, false otherwise.

The method is used to check whether a global index is still being constructed concurrently so that some partitions are not indexed and query may suffer from entry misses. If the index construction is still in progress, a query optimizer ignores the index.

The aforementioned race condition is not relevant to local off-heap indexes, since index construction is performed in partition-threads.

Parameters:

ownedPartitionCount - a count of owned partitions a query runs on. Negative value indicates that the value is not defined.

markPartitionAsIndexed

void markPartitionAsIndexed(int partitionId)

Marks the given partition as indexed by this index.

Parameters:

partitionId - the ID of the partition to mark as indexed.

markPartitionAsUnindexed

void markPartitionAsUnindexed(int partitionId)

Marks the given partition as unindexed by this index.

Parameters:

partitionId - the ID of the partition to mark as unindexed.

getPerIndexStats

PerIndexStats getPerIndexStats()

Returns the index stats associated with this index.