com.hazelcast.query.impl.predicates

Class BoundedRangePredicate

java.lang.Object

com.hazelcast.query.impl.predicates.AbstractPredicate<K,V>

com.hazelcast.query.impl.predicates.AbstractIndexAwarePredicate

com.hazelcast.query.impl.predicates.BoundedRangePredicate

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable, RangePredicate, IndexAwarePredicate, Predicate, Serializable

public class BoundedRangePredicate
extends AbstractIndexAwarePredicate
implements RangePredicate

Range predicate that is bounded on both sides.

Instances of this class are never transferred between members, the serialization is disabled.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BoundedRangePredicate(String attribute, Comparable from, boolean fromInclusive, Comparable to, boolean toInclusive) Creates a new instance of bounded range predicate.

Method Summary

Modifier and Type	Method and Description
protected boolean	applyForSingleAttributeValue(Map.Entry entry, Comparable value)
Set<QueryableEntry>	filter(QueryContext queryContext) Produces a filtered entry set by utilizing the indexes available while executing the query in the given query context.
String	getAttribute()
Comparable	getFrom()
int	getId() Returns type identifier for this class.
Comparable	getTo()
boolean	isFromInclusive()
boolean	isToInclusive()
String	toString()

Methods inherited from class com.hazelcast.query.impl.predicates.AbstractIndexAwarePredicate

getIndex, isIndexed, matchIndex

Methods inherited from class com.hazelcast.query.impl.predicates.AbstractPredicate

apply, canEqual, convert, convertAndApplyForSingleAttributeValue, convertEnumValue, equals, getFactoryId, hashCode, readAttributeValue, readData, writeData

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hazelcast.query.Predicate

apply

Constructor Detail

BoundedRangePredicate

public BoundedRangePredicate(String attribute,
                             Comparable from,
                             boolean fromInclusive,
                             Comparable to,
                             boolean toInclusive)

Creates a new instance of bounded range predicate.

Parameters:

attribute - the attribute to act 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

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.

applyForSingleAttributeValue

protected boolean applyForSingleAttributeValue(Map.Entry entry,
                                               Comparable value)

Specified by:

applyForSingleAttributeValue in class AbstractPredicate

getId

public int getId()

Description copied from interface: IdentifiedDataSerializable

Returns type identifier for this class. It should be unique per DataSerializableFactory.

Specified by:

getId in interface IdentifiedDataSerializable

Returns:

type ID

getAttribute

public String getAttribute()

Specified by:

getAttribute in interface RangePredicate

Returns:

the attribute on which this range predicate acts.

getFrom

public Comparable getFrom()

Specified by:

getFrom in interface RangePredicate

Returns:

the lower/left bound of this range predicate or null if the predicate range is left-unbounded.

isFromInclusive

public boolean isFromInclusive()

Specified by:

isFromInclusive in interface RangePredicate

Returns:

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

Can't be true if the predicate range is left-unbounded.

getTo

public Comparable getTo()

Specified by:

getTo in interface RangePredicate

Returns:

the upper/right bound of this range predicate or null if the predicate range is right-unbounded.

isToInclusive

public boolean isToInclusive()

Specified by:

isToInclusive in interface RangePredicate

Returns:

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

Can't be true if the predicate range is right-unbounded.

toString

public String toString()

Overrides:

toString in class Object