com.hazelcast.query.impl

Class AbstractIndex

java.lang.Object

com.hazelcast.query.impl.AbstractIndex

All Implemented Interfaces:

Index, InternalIndex

Direct Known Subclasses:

IndexImpl

public abstract class AbstractIndex
extends Object
implements InternalIndex

Provides an abstract base for indexes.

Nested Class Summary

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

Index.OperationSource

Field Summary

Fields

Modifier and Type	Field and Description
protected IndexCopyBehavior	copyBehavior
protected Extractors	extractors
protected IndexStore	indexStore
static ComparableIdentifiedDataSerializable	NULL Represents a null-like value that is equal to itself and less than any other value except CompositeValue.NEGATIVE_INFINITY.
protected InternalSerializationService	ss

Constructor Summary

Constructors

Constructor and Description
AbstractIndex(IndexDefinition definition, InternalSerializationService ss, Extractors extractors, IndexCopyBehavior copyBehavior, PerIndexStats stats)

Method Summary

Modifier and Type	Method and Description
boolean	canEvaluate(Class<? extends Predicate> predicateClass)
Comparable	canonicalizeQueryArgumentScalar(Comparable value) Canonicalizes the given value for the purpose of a hash-based lookup.
void	clear() Clears out all entries from this index.
protected abstract IndexStore	createIndexStore(IndexDefinition definition, PerIndexStats stats)
void	destroy() Releases all resources hold by this index, e.g.
Set<QueryableEntry>	evaluate(Predicate predicate) Evaluates the given predicate using this index.
String[]	getComponents()
TypeConverter	getConverter()
String	getName()
PerIndexStats	getPerIndexStats() Returns the index stats associated with this index.
Set<QueryableEntry>	getRecords(Comparable value) Produces a result set containing entries whose attribute values are equal to the given value.
Set<QueryableEntry>	getRecords(Comparable[] values) Produces a result set containing entries whose attribute values are equal to at least one of the given values.
Set<QueryableEntry>	getRecords(Comparable from, boolean fromInclusive, Comparable to, boolean toInclusive) Produces a result set by performing a range query on this index with the range defined by the passed arguments.
Set<QueryableEntry>	getRecords(Comparison comparison, Comparable value) Produces a result set containing entries whose attribute values are satisfy the comparison of the given type with the given value.
String	getUniqueKey()
boolean	isEvaluateOnly()
boolean	isOrdered() Tells whether this index is ordered or not.
void	putEntry(QueryableEntry entry, Object oldValue, Index.OperationSource operationSource) Saves the given entry into this index.
void	removeEntry(Data key, Object value, Index.OperationSource operationSource) Removes the entry having the given key and the value from this index.

Methods inherited from class java.lang.Object

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

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

allPartitionsIndexed, hasPartitionIndexed, markPartitionAsIndexed, markPartitionAsUnindexed

Field Detail

NULL

public static final ComparableIdentifiedDataSerializable NULL

Represents a null-like value that is equal to itself and less than any other value except CompositeValue.NEGATIVE_INFINITY. The latter is needed to establish the ordering of keys for composite indexes.

ss

protected final InternalSerializationService ss

extractors

protected final Extractors extractors

indexStore

protected final IndexStore indexStore

copyBehavior

protected final IndexCopyBehavior copyBehavior

Constructor Detail

AbstractIndex

public AbstractIndex(IndexDefinition definition,
                     InternalSerializationService ss,
                     Extractors extractors,
                     IndexCopyBehavior copyBehavior,
                     PerIndexStats stats)

Method Detail

createIndexStore

protected abstract IndexStore createIndexStore(IndexDefinition definition,
                                               PerIndexStats stats)

getName

public String getName()

Specified by:

getName in interface Index

Returns:

the canonical name of this index: for single-attribute non-composite indexes, it's an attribute name itself stripping an unnecessary "this." qualifier and replacing "#" qualifier with ".", if any; for composite indexes, it's a comma-separated list of canonicalized index component attribute names with a single space character going after every comma.

See Also:

PredicateUtils.canonicalizeAttribute(java.lang.String), PredicateUtils.constructCanonicalCompositeIndexName(java.lang.String[])

getComponents

public String[] getComponents()

Specified by:

getComponents in interface Index

Returns:

the components of this index.

isOrdered

public boolean isOrdered()

Description copied from interface: Index

Tells whether this index is ordered or not.

Ordered indexes support the fast evaluation of range queries. Unordered indexes are still capable to execute range queries, but the performance would be about the same as the full scan performance.

Specified by:

isOrdered in interface Index

Returns:

true if this index is ordered, false otherwise.

See Also:

Index.getRecords(Comparison, Comparable), Index.getRecords(Comparable, boolean, Comparable, boolean)

getUniqueKey

public String getUniqueKey()

Specified by:

getUniqueKey in interface Index

Returns:

the unique key attribute for bitmap indexes, null if this index is not a bitmap one.

getConverter

public TypeConverter getConverter()

Specified by:

getConverter in interface Index

Returns:

the converter associated with this index; or null if the converter is not known because there were no saves to this index and the attribute type is not inferred yet.

putEntry

public void putEntry(QueryableEntry entry,
                     Object oldValue,
                     Index.OperationSource operationSource)

Description copied from interface: Index

Saves the given entry into this index.

Specified by:

putEntry in interface Index

Parameters:

entry - the entry to save.

oldValue - the previous old value associated with the entry or null if the entry is new.

operationSource - the operation source.

removeEntry

public void removeEntry(Data key,
                        Object value,
                        Index.OperationSource operationSource)

Description copied from interface: Index

Removes the entry having the given key and the value from this index.

Specified by:

removeEntry in interface Index

Parameters:

key - the key of the entry to remove.

value - the value of the entry to remove.

operationSource - the operation source.

isEvaluateOnly

public boolean isEvaluateOnly()

Specified by:

isEvaluateOnly in interface Index

Returns:

true if this index supports querying only with Index.evaluate(com.hazelcast.query.Predicate) method, false otherwise.

canEvaluate

public boolean canEvaluate(Class<? extends Predicate> predicateClass)

Specified by:

canEvaluate in interface Index

Returns:

true if this index can evaluate a predicate of the given predicate class, false otherwise.

evaluate

public Set<QueryableEntry> evaluate(Predicate predicate)

Description copied from interface: Index

Evaluates the given predicate using this index.

Specified by:

evaluate in interface Index

Parameters:

predicate - the predicate to evaluate. The predicate is guaranteed to be evaluable by this index (canEvaluate returned true for its class).

Returns:

a set containing entries matching the given predicate.

getRecords

public Set<QueryableEntry> getRecords(Comparable value)

Description copied from interface: Index

Produces a result set containing entries whose attribute values are equal to the given value.

Specified by:

getRecords in interface Index

Parameters:

value - the value to compare against.

Returns:

the produced result set.

getRecords

public Set<QueryableEntry> getRecords(Comparable[] values)

Description copied from interface: Index

Produces a result set containing entries whose attribute values are equal to at least one of the given values.

Specified by:

getRecords in interface Index

Parameters:

values - the values to compare against.

Returns:

the produced result set.

getRecords

public Set<QueryableEntry> getRecords(Comparable from,
                                      boolean fromInclusive,
                                      Comparable to,
                                      boolean toInclusive)

Description copied from interface: Index

Produces a result set by performing a range query on this index with the range defined by the passed arguments.

Specified by:

getRecords in interface Index

Parameters:

from - the beginning of the range.

fromInclusive - true if the beginning of the range is inclusive, false otherwise.

to - the end of the range.

toInclusive - true if the end of the range is inclusive, false otherwise.

Returns:

the produced result set.

getRecords

public Set<QueryableEntry> getRecords(Comparison comparison,
                                      Comparable value)

Description copied from interface: Index

Produces a result set containing entries whose attribute values are satisfy the comparison of the given type with the given value.

Specified by:

getRecords in interface Index

Parameters:

comparison - the type of the comparison to perform.

value - the value to compare against.

Returns:

the produced result set.

clear

public void clear()

Description copied from interface: Index

Clears out all entries from this index.

Specified by:

clear in interface Index

destroy

public void destroy()

Description copied from interface: Index

Releases all resources hold by this index, e.g. the allocated native memory for the HD index.

Specified by:

destroy in interface Index

canonicalizeQueryArgumentScalar

public final Comparable canonicalizeQueryArgumentScalar(Comparable value)

Description copied from interface: InternalIndex

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.

Specified by:

canonicalizeQueryArgumentScalar in interface InternalIndex

Parameters:

value - the value to canonicalize.

Returns:

the canonicalized value.

getPerIndexStats

public PerIndexStats getPerIndexStats()

Description copied from interface: InternalIndex

Returns the index stats associated with this index.

Specified by:

getPerIndexStats in interface InternalIndex