Package net.sf.ehcache.search.aggregator

Class Average

  • All Implemented Interfaces:
    AggregatorInstance<java.lang.Double>
    public class Average
extends java.lang.Object
implements AggregatorInstance<java.lang.Double>
    Compute the average (arithmetic mean) as a double
    Author:
    teck

    • Constructor Summary

      Constructors 
      Constructor Description
      Average​(Attribute<?> attribute)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void accept​(java.lang.Object input)
      Add the given value to the aggregator function
      java.lang.Number aggregateResult()
      Retrieve the final result
      Average 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

      • Average

        public Average​(Attribute<?> attribute)
        Parameters:
        attribute -

    • Method Detail

      • createClone

        public Average createClone()
        Create a clone of this aggregator, detaching from its result
        Specified by:
        createClone in interface AggregatorInstance<java.lang.Double>
        Returns:

      • accept

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

        NOTE: Null values are ignored and not included in the computation

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

      • aggregateResult

        public java.lang.Number aggregateResult()
        Retrieve the final result

        NOTE: null is returned if there was no input supplied to this function

        Specified by:
        aggregateResult in interface AggregatorInstance<java.lang.Double>
        Returns:
        aggregate result

      • getAttribute

        public Attribute getAttribute()
        Get the attribute to pass to aggregator
        Specified by:
        getAttribute in interface AggregatorInstance<java.lang.Double>
        Returns:
        attribute to aggregate (null if no attribute is applicable to function)