ehcache

net.sf.ehcache.search.aggregator
Class Sum

java.lang.Object
  extended by net.sf.ehcache.search.aggregator.Sum
All Implemented Interfaces:
AggregatorInstance<Long>

public class Sum
extends Object
implements AggregatorInstance<Long>

Sums the results

Sum can be used with most numeric types

Author:
Greg Luck

Constructor Summary
Sum(Attribute<?> attribute)
           
 
Method Summary
 void accept(Object input)
          Add the given value to the aggregator function
 Number aggregateResult()
          Retrieve the final result
 Sum createClone()
          Create a clone of this aggregator, detaching from its result
 Attribute getAttribute()
          Get the attribute to pass to aggregator
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Sum

public Sum(Attribute<?> attribute)
Parameters:
attribute -
Method Detail

createClone

public Sum createClone()
Create a clone of this aggregator, detaching from its result

Specified by:
createClone in interface AggregatorInstance<Long>
Returns:

accept

public void accept(Object input)
            throws AggregatorException
Add the given value to the aggregator function

NOTE: null inputs are ignored

Specified by:
accept in interface AggregatorInstance<Long>
Parameters:
input - a single input value
Throws:
AggregatorException - if the function cannot be computed, possibly due to unsupported types

aggregateResult

public Number aggregateResult()
Retrieve the final result

NOTE: May return null if no input supplied

Specified by:
aggregateResult in interface AggregatorInstance<Long>
Returns:
aggregate result

getAttribute

public Attribute getAttribute()
Get the attribute to pass to aggregator

Specified by:
getAttribute in interface AggregatorInstance<Long>
Returns:
attribute to aggregate (null if no attribute is applicable to function)

ehcache

Copyright 2001-2014, Terracotta, Inc.