com.hazelcast.map.impl.query

Class AggregationResult

java.lang.Object

com.hazelcast.map.impl.query.AggregationResult

All Implemented Interfaces:

Result<AggregationResult>, DataSerializable, IdentifiedDataSerializable

public class AggregationResult
extends Object
implements Result<AggregationResult>

Contains the result of the evaluation of an aggregation on a specific Partition or Node.

At the end of the aggregation execution path all AggregationResults are merged into one AggregationResult.

Constructor Summary

Constructors

Constructor and Description
AggregationResult()
AggregationResult(Aggregator aggregator, SerializationService serializationService)

Method Summary

Modifier and Type	Method and Description
void	add(QueryableEntry entry) Adds the given entry to this result.
void	combine(AggregationResult result) Combines the given result with this result modifying this result.
void	completeConstruction(Collection<Integer> partitionIds) Completes the construction of this result.
AggregationResult	createSubResult() Creates a new empty sub result of the same type as this result.
<R> Aggregator<?,R>	getAggregator()
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
int	getId() Returns type identifier for this class.
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	readData(ObjectDataInput in) Reads fields from the input stream
void	setPartitionIds(Collection<Integer> partitionIds) Sets the partition IDs of this result.
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

Constructor Detail

AggregationResult

public AggregationResult()

AggregationResult

public AggregationResult(Aggregator aggregator,
                         SerializationService serializationService)

Method Detail

getAggregator

public <R> Aggregator<?,R> getAggregator()

getPartitionIds

public Collection<Integer> getPartitionIds()

Description copied from interface: Result

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

Specified by:

getPartitionIds in interface Result<AggregationResult>

combine

public void combine(AggregationResult result)

Description copied from interface: Result

Combines the given result with this result modifying this result.

Specified by:

combine in interface Result<AggregationResult>

Parameters:

result - the result to combine with.

See Also:

Result.onCombineFinished()

onCombineFinished

public void onCombineFinished()

Description copied from interface: Result

Invoked when the result combining phase is finished.

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

Specified by:

onCombineFinished in interface Result<AggregationResult>

See Also:

Result.combine(Result)

add

public void add(QueryableEntry entry)

Description copied from interface: Result

Adds the given entry to this result.

Specified by:

add in interface Result<AggregationResult>

Parameters:

entry - the entry to add.

createSubResult

public AggregationResult createSubResult()

Description copied from interface: Result

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.

Specified by:

createSubResult in interface Result<AggregationResult>

Returns:

the created sub result.

orderAndLimit

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

Description copied from interface: Result

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

Specified by:

orderAndLimit in interface Result<AggregationResult>

Parameters:

pagingPredicate - the paging predicate to perform the operation for.

nearestAnchorEntry - the anchor entry of the paging predicate.

completeConstruction

public void completeConstruction(Collection<Integer> partitionIds)

Description copied from interface: Result

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.

Specified by:

completeConstruction in interface Result<AggregationResult>

Parameters:

partitionIds - the partition IDs to associate this result with.

See Also:

Result.combine(Result)

setPartitionIds

public void setPartitionIds(Collection<Integer> partitionIds)

Description copied from interface: Result

Sets the partition IDs of this result.

Specified by:

setPartitionIds in interface Result<AggregationResult>

Parameters:

partitionIds - the partition IDs to set.

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.