001    /**
002     * =========================================
003     * LibFormula : a free Java formula library
004     * =========================================
005     *
006     * Project Info:  http://reporting.pentaho.org/libformula/
007     *
008     * (C) Copyright 2006-2007, by Pentaho Corporation and Contributors.
009     *
010     * This library is free software; you can redistribute it and/or modify it under the terms
011     * of the GNU Lesser General Public License as published by the Free Software Foundation;
012     * either version 2.1 of the License, or (at your option) any later version.
013     *
014     * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
015     * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
016     * See the GNU Lesser General Public License for more details.
017     *
018     * You should have received a copy of the GNU Lesser General Public License along with this
019     * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
020     * Boston, MA 02111-1307, USA.
021     *
022     * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
023     * in the United States and other countries.]
024     *
025     *
026     * ------------
027     * $Id: IntFunction.java 3521 2007-10-16 10:55:14Z tmorgner $
028     * ------------
029     * (C) Copyright 2006-2007, by Pentaho Corporation.
030     */
031    package org.jfree.formula.function.rounding;
032    
033    import java.math.BigDecimal;
034    
035    import org.jfree.formula.EvaluationException;
036    import org.jfree.formula.FormulaContext;
037    import org.jfree.formula.LibFormulaErrorValue;
038    import org.jfree.formula.function.Function;
039    import org.jfree.formula.function.ParameterCallback;
040    import org.jfree.formula.lvalues.TypeValuePair;
041    import org.jfree.formula.typing.Type;
042    import org.jfree.formula.typing.coretypes.NumberType;
043    import org.jfree.formula.util.NumberUtil;
044    
045    /**
046     * This function returns a number down to the nearest integer.
047     * 
048     * @author Cedric Pronzato
049     */
050    public class IntFunction implements Function
051    {
052    
053      public IntFunction()
054      {
055      }
056    
057      public String getCanonicalName()
058      {
059        return "INT";
060      }
061    
062      public TypeValuePair evaluate(final FormulaContext context,
063          final ParameterCallback parameters) throws EvaluationException
064      {
065        if (parameters.getParameterCount() != 1)
066        {
067          throw new EvaluationException(LibFormulaErrorValue.ERROR_ARGUMENTS_VALUE);
068        }
069    
070        final Type type1 = parameters.getType(0);
071        final Object value1 = parameters.getValue(0);
072        final Number result = context.getTypeRegistry().convertToNumber(type1,
073            value1);
074    
075        BigDecimal n;
076        if (result instanceof BigDecimal)
077        {
078          n = (BigDecimal) result;
079        }
080        else
081        {
082          n = new BigDecimal(result.toString());
083        }
084        final Integer ret = NumberUtil.performIntRounding(n);
085    
086        return new TypeValuePair(NumberType.GENERIC_NUMBER, ret);
087      }
088    
089    }