com.hazelcast.query.impl.predicates

Class CompositeRangePredicate

java.lang.Object

com.hazelcast.query.impl.predicates.CompositeRangePredicate

All Implemented Interfaces:

IndexAwarePredicate, Predicate, Serializable

public class CompositeRangePredicate
extends Object
implements Predicate, IndexAwarePredicate

Does the same thing as GreaterLessPredicate, BetweenPredicate and BoundedRangePredicate but for composite indexes and values.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CompositeRangePredicate(InternalIndex index, CompositeValue from, boolean fromInclusive, CompositeValue to, boolean toInclusive, int prefixLength) Constructs a new composite range predicate on the given index.

Method Summary

Modifier and Type	Method and Description
boolean	apply(Map.Entry entry) Applies this predicate to the given map entry.
Set<QueryableEntry>	filter(QueryContext queryContext) Produces a filtered entry set by utilizing the indexes available while executing the query in the given query context.
boolean	isIndexed(QueryContext queryContext) Signals to the query engine that this predicate is able to utilize the indexes available while executing the query in the given query context.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeRangePredicate

public CompositeRangePredicate(InternalIndex index,
                               CompositeValue from,
                               boolean fromInclusive,
                               CompositeValue to,
                               boolean toInclusive,
                               int prefixLength)

Constructs a new composite range predicate on the given index.

Parameters:

index - the index to construct the predicate on.

from - the lower/left range bound.

fromInclusive - true if the range is left-closed, false otherwise.

to - the upper/right range bound.

toInclusive - true if the range is right-closed, false otherwise.

Method Detail

apply

public boolean apply(Map.Entry entry)

Description copied from interface: Predicate

Applies this predicate to the given map entry.

Implementations must be thread-safe, since this method may be called by multiple threads concurrently.

Specified by:

apply in interface Predicate

Parameters:

entry - the map entry to apply this predicate to.

Returns:

true if the given map entry matches this predicate, false otherwise.

filter

public Set<QueryableEntry> filter(QueryContext queryContext)

Description copied from interface: IndexAwarePredicate

Produces a filtered entry set by utilizing the indexes available while executing the query in the given query context.

The query engine assumes this method produces the result set faster than a simple evaluation of the predicate on every entry.

Specified by:

filter in interface IndexAwarePredicate

Parameters:

queryContext - the query context to access the indexes. The passed query context is valid only for a duration of a single call to the method.

Returns:

the produced filtered entry set.

isIndexed

public boolean isIndexed(QueryContext queryContext)

Description copied from interface: IndexAwarePredicate

Signals to the query engine that this predicate is able to utilize the indexes available while executing the query in the given query context.

Specified by:

isIndexed in interface IndexAwarePredicate

Parameters:

queryContext - the query context to consult for the available indexes.

Returns:

true if this predicate is able to use the indexes to speed up the processing, false otherwise.

toString

public String toString()

Overrides:

toString in class Object