com.hazelcast.query

Class PartitionPredicate<K,V>

java.lang.Object

com.hazelcast.query.PartitionPredicate<K,V>

Type Parameters:

K - type of the entry key

V - type of the entry value

All Implemented Interfaces:

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

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

A Predicate that restricts the execution of a Predicate to a single Partition. This can help to speed up query execution since only a single instead of all partitions needs to be queried. This predicate can only be used as an outer predicate.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PartitionPredicate()
PartitionPredicate(Object partitionKey, Predicate<K,V> target) Creates a new PartitionPredicate.

Method Summary

Modifier and Type	Method and Description
boolean	apply(Map.Entry<K,V> mapEntry) Applies this predicate to the given map entry.
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
int	getId() Returns type identifier for this class.
Object	getPartitionKey() Returns the partition key that determines the partition the target Predicate is going to execute on.
Predicate<K,V>	getTarget() Returns the target Predicate.
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 java.lang.Object

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

Constructor Detail

PartitionPredicate

public PartitionPredicate()

PartitionPredicate

public PartitionPredicate(Object partitionKey,
                          Predicate<K,V> target)

Creates a new PartitionPredicate.

Parameters:

partitionKey - the partition key

target - the target Predicate

Throws:

IllegalArgumentException - if partition ID smaller than zero

NullPointerException - if target Predicate is null

Method Detail

getPartitionKey

public Object getPartitionKey()

Returns the partition key that determines the partition the target Predicate is going to execute on.

Returns:

the partition ID

getTarget

public Predicate<K,V> getTarget()

Returns the target Predicate.

Returns:

the target Predicate.

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.

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

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

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.

toString

public String toString()

Overrides:

toString in class Object