/libformula-1.1.3/source/org/pentaho/reporting/libraries/formula/function/information/IsNumberFunction.java

 1/*
 2 * This program is free software; you can redistribute it and/or modify it under the
 3 * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
 4 * Foundation.
 5 *
 6 * You should have received a copy of the GNU Lesser General Public License along with this
 7 * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
 8 * or from the Free Software Foundation, Inc.,
 9 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
10 *
11 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
12 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 * See the GNU Lesser General Public License for more details.
14 *
15 * Copyright (c) 2006 - 2009 Pentaho Corporation and Contributors.  All rights reserved.
16 */
17
18package org.pentaho.reporting.libraries.formula.function.information;
19
20import org.pentaho.reporting.libraries.formula.EvaluationException;
21import org.pentaho.reporting.libraries.formula.FormulaContext;
22import org.pentaho.reporting.libraries.formula.LibFormulaErrorValue;
23import org.pentaho.reporting.libraries.formula.function.Function;
24import org.pentaho.reporting.libraries.formula.function.ParameterCallback;
25import org.pentaho.reporting.libraries.formula.lvalues.TypeValuePair;
26import org.pentaho.reporting.libraries.formula.typing.Type;
27import org.pentaho.reporting.libraries.formula.typing.coretypes.LogicalType;
28
29/**
30 * This function retruns true if the given value is of type Number.
31 *
32 * @author Cedric Pronzato
33 *
34 */
35public class IsNumberFunction implements Function
36{
37  private static final TypeValuePair RETURN_TRUE = new TypeValuePair(LogicalType.TYPE, Boolean.TRUE);
38  private static final TypeValuePair RETURN_FALSE = new TypeValuePair(LogicalType.TYPE, Boolean.FALSE);
39  private static final long serialVersionUID = 3298090211745552284L;
40
41  public IsNumberFunction()
42  {
43  }
44
45  public TypeValuePair evaluate(final FormulaContext context, final ParameterCallback parameters) throws EvaluationException
46  {
47    final int parameterCount = parameters.getParameterCount();
48    if (parameterCount < 1)
49    {
50      throw EvaluationException.getInstance(LibFormulaErrorValue.ERROR_ARGUMENTS_VALUE);
51    }
52
53    final Type type1 = parameters.getType(0);
54    if(type1.isFlagSet(Type.NUMERIC_TYPE))
55    {
56      return RETURN_TRUE;
57    }
58
59    return RETURN_FALSE;
60  }
61
62  public String getCanonicalName()
63  {
64    return "ISNUMBER";
65  }
66
67}