com.hazelcast.query.impl

Class OrderedIndexStore

java.lang.Object

com.hazelcast.query.impl.BaseIndexStore

com.hazelcast.query.impl.BaseSingleValueIndexStore

com.hazelcast.query.impl.OrderedIndexStore

All Implemented Interfaces:

IndexStore

public class OrderedIndexStore
extends BaseSingleValueIndexStore

Store indexes rankly.

Constructor Summary

Constructors

Constructor and Description
OrderedIndexStore(IndexCopyBehavior copyOn)

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.
Comparable	canonicalizeScalarForStorage(Comparable value) Canonicalizes the given value for storing it in this index store.
void	clear() Clears the contents of this index by purging all its entries.
Set<QueryableEntry>	evaluate(Predicate predicate, TypeConverter converter) Evaluates the given predicate using this index store.
Set<QueryableEntry>	getRecords(Comparable value) Obtains entries that have indexed attribute value equal to the given value.
Set<QueryableEntry>	getRecords(Comparable from, boolean fromInclusive, Comparable to, boolean toInclusive) Obtains entries that have indexed attribute value belonging to the given range.
Set<QueryableEntry>	getRecords(Comparison comparison, Comparable searchedValue) Obtains entries that have indexed attribute value satisfying the given comparison with the given value.
Set<QueryableEntry>	getRecords(Set<Comparable> values) Obtains entries that have indexed attribute value equal to one of the given set of values.
boolean	isEvaluateOnly()

Methods inherited from class com.hazelcast.query.impl.BaseSingleValueIndexStore

destroy, insert, remove, update

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderedIndexStore

public OrderedIndexStore(IndexCopyBehavior copyOn)

Method Detail

canonicalizeQueryArgumentScalar

public Comparable canonicalizeQueryArgumentScalar(Comparable value)

Description copied from interface: IndexStore

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.

The main difference comparing to BaseIndexStore.canonicalizeScalarForStorage(java.lang.Comparable) is that this method is specifically designed to support the canonicalization of transient non-persistent values (think of query arguments), so a more efficient representation may chosen.

Parameters:

value - the value to canonicalize.

Returns:

the canonicalized value.

canonicalizeScalarForStorage

public Comparable canonicalizeScalarForStorage(Comparable value)

Description copied from class: BaseIndexStore

Canonicalizes the given value for storing it in this index store.

The method is used by hash indexes to achieve the canonical representation of mixed-type numeric values, so equals and hashCode logic can work properly.

The main difference comparing to IndexStore.canonicalizeQueryArgumentScalar(java.lang.Comparable) is that this method is specifically designed to support the canonicalization of persistent index values (think of map entry attribute values), so a more suitable value representation may chosen.

Parameters:

value - the value to canonicalize.

Returns:

the canonicalized value.

clear

public void clear()

Description copied from interface: IndexStore

Clears the contents of this index by purging all its entries.

isEvaluateOnly

public boolean isEvaluateOnly()

Returns:

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

canEvaluate

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

Returns:

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

evaluate

public Set<QueryableEntry> evaluate(Predicate predicate,
                                    TypeConverter converter)

Description copied from interface: IndexStore

Evaluates the given predicate using this index store.

Parameters:

predicate - the predicate to evaluate. The predicate is guaranteed to be evaluable by this index store (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: IndexStore

Obtains entries that have indexed attribute value equal to the given value.

Parameters:

value - the value to obtains the entries for.

Returns:

the obtained entries.

See Also:

Index.getRecords(Comparable)

getRecords

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

Description copied from interface: IndexStore

Obtains entries that have indexed attribute value equal to one of the given set of values.

Parameters:

values - the values to obtains the entries for.

Returns:

the obtained entries.

See Also:

Index.getRecords(Comparable[])

getRecords

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

Description copied from interface: IndexStore

Obtains entries that have indexed attribute value satisfying the given comparison with the given value.

Parameters:

comparison - the comparison to perform.

searchedValue - the value to perform the comparison with.

Returns:

the obtained entries.

See Also:

Index.getRecords(Comparison, Comparable)

getRecords

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

Description copied from interface: IndexStore

Obtains entries that have indexed attribute value belonging to the given range.

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 obtained entries.

See Also:

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