com.hazelcast.query.impl.predicates

Class BetweenPredicate

java.lang.Object

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

com.hazelcast.query.impl.predicates.AbstractIndexAwarePredicate

com.hazelcast.query.impl.predicates.BetweenPredicate

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable, RangePredicate, IndexAwarePredicate, Predicate, VisitablePredicate, Serializable

public class BetweenPredicate
extends AbstractIndexAwarePredicate
implements VisitablePredicate, RangePredicate

Between Predicate

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BetweenPredicate()
BetweenPredicate(String attribute, Comparable from, Comparable to)

Method Summary

Modifier and Type	Method and Description
Predicate	accept(Visitor visitor, Indexes indexes) Accept visitor.
protected boolean	applyForSingleAttributeValue(Comparable attributeValue)
boolean	canEqual(Object other)
boolean	equals(Object o)
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()
int	hashCode()
boolean	isFromInclusive()
boolean	isToInclusive()
void	readData(ObjectDataInput in) Reads fields from the input stream
String	toString()
void	writeData(ObjectDataOutput out) Writes object fields to output stream

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

getIndex, isIndexed, matchIndex

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

apply, convert, getFactoryId

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

BetweenPredicate

public BetweenPredicate()

BetweenPredicate

public BetweenPredicate(String attribute,
                        Comparable from,
                        Comparable to)

Method Detail

applyForSingleAttributeValue

protected boolean applyForSingleAttributeValue(Comparable attributeValue)

Specified by:

applyForSingleAttributeValue in class AbstractPredicate

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.

writeData

public void writeData(ObjectDataOutput out)
               throws IOException

Description copied from interface: DataSerializable

Writes object fields to output stream

Specified by:

writeData in interface DataSerializable

Overrides:

writeData in class AbstractPredicate

Parameters:

out - output

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

readData

public void readData(ObjectDataInput in)
              throws IOException

Description copied from interface: DataSerializable

Reads fields from the input stream

Specified by:

readData in interface DataSerializable

Overrides:

readData in class AbstractPredicate

Parameters:

in - input

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the input stream has been closed.

toString

public String toString()

Overrides:

toString in class Object

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

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractPredicate

canEqual

public boolean canEqual(Object other)

Overrides:

canEqual in class AbstractPredicate

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPredicate

accept

public Predicate accept(Visitor visitor,
                        Indexes indexes)

Description copied from interface: VisitablePredicate

Accept visitor. Predicate can either return it's own instance if no modification was done as a result of the visit. In the case there is a change needed then the predicate has to return changed copy of itself. Predicates has to be treated as immutable for optimization purposes.

Specified by:

accept in interface VisitablePredicate

Parameters:

visitor - visitor to accept

indexes - indexes

Returns:

itself or its changed copy

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.