com.hazelcast.query.impl.predicates

Class AbstractPredicate<K,V>

java.lang.Object

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

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable, Predicate<K,V>, Serializable

Direct Known Subclasses:

AbstractIndexAwarePredicate, LikePredicate, RegexPredicate

public abstract class AbstractPredicate<K,V>
extends Object
implements Predicate<K,V>, IdentifiedDataSerializable

Provides base features for predicates, such as extraction and conversion of the attribute's value. It also handles apply() on MultiResult.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPredicate()
protected	AbstractPredicate(String attributeName)

Method Summary

Modifier and Type	Method and Description
boolean	apply(Map.Entry<K,V> mapEntry) Applies this predicate to the given map entry.
protected abstract boolean	applyForSingleAttributeValue(Map.Entry mapEntry, Comparable attributeValue)
protected Comparable	convert(Map.Entry entry, Comparable entryAttributeValue, Comparable givenAttributeValue) Converts givenAttributeValue to the type of entryAttributeValue Good practice: do not invoke this method if entryAttributeValue == null
protected Object	convertEnumValue(Object attributeValue)
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
protected Object	readAttributeValue(Map.Entry entry)
void	readData(ObjectDataInput in) Reads fields from the input stream
void	writeData(ObjectDataOutput out) Writes object fields to output stream

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.nio.serialization.IdentifiedDataSerializable

getId

Constructor Detail

AbstractPredicate

protected AbstractPredicate()

AbstractPredicate

protected AbstractPredicate(String attributeName)

Method Detail

apply

public boolean apply(Map.Entry<K,V> mapEntry)

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<K,V>

Parameters:

mapEntry - the map entry to apply this predicate to.

Returns:

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

applyForSingleAttributeValue

protected abstract boolean applyForSingleAttributeValue(Map.Entry mapEntry,
                                                        Comparable attributeValue)

convert

protected Comparable convert(Map.Entry entry,
                             Comparable entryAttributeValue,
                             Comparable givenAttributeValue)

Converts givenAttributeValue to the type of entryAttributeValue Good practice: do not invoke this method if entryAttributeValue == null

Parameters:

entry - map entry on the basis of which the conversion will be executed

entryAttributeValue - attribute value extracted from the entry

givenAttributeValue - given attribute value to be converted

Returns:

converted givenAttributeValue

readAttributeValue

protected Object readAttributeValue(Map.Entry entry)

convertEnumValue

protected Object convertEnumValue(Object attributeValue)

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

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

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.

getFactoryId

public int getFactoryId()

Description copied from interface: IdentifiedDataSerializable

Returns DataSerializableFactory factory ID for this class.

Specified by:

getFactoryId in interface IdentifiedDataSerializable

Returns:

factory ID