net.sf.jagg
Class SumAggregator

java.lang.Object
  net.sf.jagg.Aggregator
      net.sf.jagg.SumAggregator

public class SumAggregator
extends Aggregator

This class represents the "sum" aggregator over numeric values.

Since:

0.1.0

Author:

Randy Gettman

Field Summary

Fields inherited from class net.sf.jagg.Aggregator

PROP_SELF

Constructor Summary

SumAggregator(java.lang.String property)
Constructs an SumAggregator that operates on the specified property.

Method Summary

void	init() Initialize the sum to zero.
void	iterate(java.lang.Object value) Add the property value to the sum.
void	merge(Aggregator agg) Merge the given Aggregator into this one by adding the respective sums.
SumAggregator	replicate() Returns an uninitialized copy of this Aggregator object, with the same property(ies) to analyze.
java.lang.Double	terminate() Return the sum.
DoubleDouble	terminateDoubleDouble() Return the result as a DoubleDouble.

Methods inherited from class net.sf.jagg.Aggregator

equals, getAggregator, getAggregator, getProperty, getValueFromProperty, hashCode, isInUse, setInUse, setProperty, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SumAggregator

public SumAggregator(java.lang.String property)

Constructs an SumAggregator that operates on the specified property.

Parameters:

property - Add up all this property's values.

Method Detail

replicate

public SumAggregator replicate()

Returns an uninitialized copy of this Aggregator object, with the same property(ies) to analyze.

Specified by:

replicate in class Aggregator

Returns:

An uninitialized copy of this Aggregator object.

init

public void init()

Initialize the sum to zero.

Specified by:

init in class Aggregator

iterate

public void iterate(java.lang.Object value)

Add the property value to the sum.

Specified by:

iterate in class Aggregator

Parameters:

value - The value to aggregate.

See Also:

Aggregator.getValueFromProperty(java.lang.Object, java.lang.String)

merge

public void merge(Aggregator agg)

Merge the given Aggregator into this one by adding the respective sums.

Specified by:

merge in class Aggregator

Parameters:

agg - The Aggregator to merge into this one.

terminate

public java.lang.Double terminate()

Return the sum.

Specified by:

terminate in class Aggregator

Returns:

The sum as a Double, or 0 if no values have been accumulated.

terminateDoubleDouble

public DoubleDouble terminateDoubleDouble()

Return the result as a DoubleDouble. This is used mainly when other Aggregators that use this result must maintain a high precision.

Overrides:

terminateDoubleDouble in class Aggregator

Returns:

The sum as a DoubleDouble, or 0 if no values have been accumulated.

Since:

0.4.0

See Also:

DoubleDouble