Package com.yahoo.searchlib.aggregation

Class SumAggregationResult

java.lang.Object

com.yahoo.vespa.objects.Selectable

com.yahoo.vespa.objects.Identifiable

com.yahoo.searchlib.expression.ExpressionNode

com.yahoo.searchlib.aggregation.AggregationResult

com.yahoo.searchlib.aggregation.SumAggregationResult

All Implemented Interfaces:

Serializable, Cloneable

public class SumAggregationResult
extends AggregationResult

This is an aggregated result holding the sum of the aggregating expression for all matching hits.

Author:

baldersheim, Simon Thoresen Hult

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	classId

Constructor Summary

Constructors

Constructor	Description
SumAggregationResult()	Constructs an empty result node.
SumAggregationResult(SingleResultNode sum)	Constructs an instance of this class with given sum.

Method Summary

Modifier and Type	Method	Description
SumAggregationResult	clone()
protected boolean	equalsAggregation(AggregationResult obj)
ResultNode	getRank()	Returns a value that can be used for ranking.
final SingleResultNode	getSum()	Returns the sum of all results in this.
protected void	onDeserialize(com.yahoo.vespa.objects.Deserializer buf)
protected int	onGetClassId()
protected void	onMerge(AggregationResult result)	Mmust be implemented by subclasses to support merge.
protected void	onSerialize(com.yahoo.vespa.objects.Serializer buf)
final SumAggregationResult	setSum(SingleResultNode sum)	Sets the sum of all results in this.
void	visitMembers(com.yahoo.vespa.objects.ObjectVisitor visitor)

Methods inherited from class com.yahoo.searchlib.aggregation.AggregationResult

equalsExpression, getExpression, getResult, getTag, merge, onExecute, onPrepare, postMerge, setExpression, setTag

Methods inherited from class com.yahoo.searchlib.expression.ExpressionNode

equals, execute, executeIterative, onArgument, prepare

Methods inherited from class com.yahoo.vespa.objects.Identifiable

create, createFromId, deserialize, deserializeOptional, deserializeWithId, equals, getClassId, getRawUtf8Bytes, getUtf8, hashCode, putUtf8, registerClass, serialize, serializeOptional, serializeWithId, toString

Methods inherited from class com.yahoo.vespa.objects.Selectable

select, select, selectMembers

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

classId

public static final int classId

Constructor Details

SumAggregationResult

public SumAggregationResult()

Constructs an empty result node. NOTE: This instance is broken until non-optional member data is set.

SumAggregationResult

public SumAggregationResult(SingleResultNode sum)

Constructs an instance of this class with given sum.

Parameters:

sum - The initial sum to set.

Method Details

getSum

public final SingleResultNode getSum()

Returns the sum of all results in this.

Returns:

The numeric sum.

setSum

public final SumAggregationResult setSum(SingleResultNode sum)

Sets the sum of all results in this.

Parameters:

sum - The sum to set.

Returns:

This, to allow chaining.

getRank

public ResultNode getRank()

Description copied from class: AggregationResult

Returns a value that can be used for ranking.

Specified by:

getRank in class AggregationResult

onGetClassId

protected int onGetClassId()

Overrides:

onGetClassId in class AggregationResult

onSerialize

protected void onSerialize(com.yahoo.vespa.objects.Serializer buf)

Overrides:

onSerialize in class AggregationResult

onDeserialize

protected void onDeserialize(com.yahoo.vespa.objects.Deserializer buf)

Overrides:

onDeserialize in class AggregationResult

onMerge

protected void onMerge(AggregationResult result)

Description copied from class: AggregationResult

Mmust be implemented by subclasses to support merge. It is called as the AggregationResult.merge(AggregationResult) method is invoked.

Specified by:

onMerge in class AggregationResult

Parameters:

result - the result to merge with

clone

public SumAggregationResult clone()

Overrides:

clone in class AggregationResult

equalsAggregation

protected boolean equalsAggregation(AggregationResult obj)

Specified by:

equalsAggregation in class AggregationResult

visitMembers

public void visitMembers(com.yahoo.vespa.objects.ObjectVisitor visitor)

Overrides:

visitMembers in class AggregationResult