com.hazelcast.map.impl.query

Interface Result<T extends Result>

Type Parameters:

T - type of the result for the concrete implementations

All Superinterfaces:

DataSerializable, IdentifiedDataSerializable

All Known Implementing Classes:

AggregationResult, QueryResult

public interface Result<T extends Result>
extends IdentifiedDataSerializable

Result of a Query. Each query type implements its own Result.

Method Summary

Modifier and Type	Method and Description
void	add(QueryableEntry entry) Adds the given entry to this result.
void	combine(T result) Combines the given result with this result modifying this result.
void	completeConstruction(Collection<Integer> partitionIds) Completes the construction of this result.
T	createSubResult() Creates a new empty sub result of the same type as this result.
Collection<Integer>	getPartitionIds() Returns partition IDs associated with this result or null if this result is an empty/failure result.
void	onCombineFinished() Invoked when the result combining phase is finished.
void	orderAndLimit(PagingPredicate pagingPredicate, Map.Entry<Integer,Map.Entry> nearestAnchorEntry) Performs the order-and-limit operation on this result for the given paging predicate.
void	setPartitionIds(Collection<Integer> partitionIds) Sets the partition IDs of this result.

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

getFactoryId, getId

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

readData, writeData

Method Detail

getPartitionIds

Collection<Integer> getPartitionIds()

Returns partition IDs associated with this result or null if this result is an empty/failure result.

setPartitionIds

void setPartitionIds(Collection<Integer> partitionIds)

Sets the partition IDs of this result.

Parameters:

partitionIds - the partition IDs to set.

combine

void combine(T result)

Combines the given result with this result modifying this result.

Parameters:

result - the result to combine with.

See Also:

onCombineFinished()

onCombineFinished

void onCombineFinished()

Invoked when the result combining phase is finished.

Implementations may release intermediary resources associated with the combining. No further calls to combine(T) are expected after this method invocation.

See Also:

combine(Result)

add

void add(QueryableEntry entry)

Adds the given entry to this result.

Parameters:

entry - the entry to add.

createSubResult

T createSubResult()

Creates a new empty sub result of the same type as this result.

This method is used by the query execution engine while constructing the partial sub results. These sub results are combined with this result during the final stage of the result construction.

Returns:

the created sub result.

orderAndLimit

void orderAndLimit(PagingPredicate pagingPredicate,
                   Map.Entry<Integer,Map.Entry> nearestAnchorEntry)

Performs the order-and-limit operation on this result for the given paging predicate.

Parameters:

pagingPredicate - the paging predicate to perform the operation for.

nearestAnchorEntry - the anchor entry of the paging predicate.

completeConstruction

void completeConstruction(Collection<Integer> partitionIds)

Completes the construction of this result.

Implementations may release intermediary resources associated with the construction in this method. No further modifications of the result are expected after this method invocation except combining the result with other results.

Parameters:

partitionIds - the partition IDs to associate this result with.

See Also:

combine(Result)