Source for org.jfree.formula.function.math.AverageFunction

   1: /**
   2:  * =========================================
   3:  * LibFormula : a free Java formula library
   4:  * =========================================
   5:  *
   6:  * Project Info:  http://reporting.pentaho.org/libformula/
   7:  *
   8:  * (C) Copyright 2006-2007, by Pentaho Corporation and Contributors.
   9:  *
  10:  * This library is free software; you can redistribute it and/or modify it under the terms
  11:  * of the GNU Lesser General Public License as published by the Free Software Foundation;
  12:  * either version 2.1 of the License, or (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
  15:  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  16:  * See the GNU Lesser General Public License for more details.
  17:  *
  18:  * You should have received a copy of the GNU Lesser General Public License along with this
  19:  * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20:  * Boston, MA 02111-1307, USA.
  21:  *
  22:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
  23:  * in the United States and other countries.]
  24:  *
  25:  *
  26:  * ------------
  27:  * $Id: AverageFunction.java 3488 2007-10-10 09:48:59Z tmorgner $
  28:  * ------------
  29:  * (C) Copyright 2006-2007, by Pentaho Corporation.
  30:  */
  31: package org.jfree.formula.function.math;
  32: 
  33: import java.math.BigDecimal;
  34: 
  35: import org.jfree.formula.EvaluationException;
  36: import org.jfree.formula.FormulaContext;
  37: import org.jfree.formula.util.NumberUtil;
  38: import org.jfree.formula.function.Function;
  39: import org.jfree.formula.function.ParameterCallback;
  40: import org.jfree.formula.lvalues.TypeValuePair;
  41: import org.jfree.formula.typing.coretypes.NumberType;
  42: 
  43: /**
  44:  * This function returns the average of the number sequence.
  45:  *
  46:  * @author Cedric Pronzato
  47:  */
  48: public class AverageFunction implements Function
  49: {
  50: 
  51:   public AverageFunction()
  52:   {
  53:   }
  54: 
  55:   public String getCanonicalName()
  56:   {
  57:     return "AVERAGE";
  58:   }
  59: 
  60:   public TypeValuePair evaluate(final FormulaContext context,
  61:                                 final ParameterCallback parameters)
  62:       throws EvaluationException
  63:   {
  64:     final SumFunction sumFunction = new SumFunction();
  65:     final TypeValuePair sum = sumFunction.evaluate(context, parameters);
  66: 
  67:     final Number n = context.getTypeRegistry().convertToNumber(sum.getType(), sum.getValue());
  68:     final BigDecimal divident = NumberUtil.getAsBigDecimal(n);
  69:     final BigDecimal divisor = new BigDecimal(parameters.getParameterCount());
  70:     final BigDecimal avg = divident.divide(divisor, 40, BigDecimal.ROUND_HALF_UP);
  71: 
  72:     return new TypeValuePair(NumberType.GENERIC_NUMBER, avg);
  73:   }
  74: }