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: IsLogicalFunction.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.information;
032
033 import org.jfree.formula.EvaluationException;
034 import org.jfree.formula.FormulaContext;
035 import org.jfree.formula.LibFormulaErrorValue;
036 import org.jfree.formula.function.Function;
037 import org.jfree.formula.function.ParameterCallback;
038 import org.jfree.formula.lvalues.TypeValuePair;
039 import org.jfree.formula.typing.Type;
040 import org.jfree.formula.typing.coretypes.LogicalType;
041
042 /**
043 * This function checks whatever the given value is of Logical type.
044 *
045 * @author Cedric Pronzato
046 *
047 */
048 public class IsLogicalFunction implements Function
049 {
050 private static final TypeValuePair RETURN_TRUE = new TypeValuePair(
051 LogicalType.TYPE, Boolean.TRUE);
052
053 private static final TypeValuePair RETURN_FALSE = new TypeValuePair(
054 LogicalType.TYPE, Boolean.FALSE);
055
056 public IsLogicalFunction()
057 {
058 }
059
060 public TypeValuePair evaluate(final FormulaContext context,
061 final ParameterCallback parameters) throws EvaluationException
062 {
063 final int parameterCount = parameters.getParameterCount();
064 if (parameterCount < 1)
065 {
066 throw new EvaluationException(LibFormulaErrorValue.ERROR_ARGUMENTS_VALUE);
067 }
068
069 final Type type1 = parameters.getType(0);
070 final Object value1 = parameters.getValue(0);
071 if(value1 instanceof Boolean || type1.isFlagSet(Type.LOGICAL_TYPE))
072 {
073 return RETURN_TRUE;
074 }
075
076 // we don't want the auto convertion of paramaters (paramerter.getValue) so
077 // we run the evaluate method ourself
078 // final TypeValuePair eval = parameters.getRaw(0).evaluate();
079 // if (eval.getType().isFlagSet(Type.LOGICAL_TYPE))
080 // {
081 // return RETURN_TRUE;
082 // }
083
084 return RETURN_FALSE;
085 }
086
087 public String getCanonicalName()
088 {
089 return "ISLOGICAL";
090 }
091
092 }