Source for org.jfree.formula.function.logical.XorFunctionDescription

   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: XorFunctionDescription.java 3521 2007-10-16 10:55:14Z tmorgner $
  28:  * ------------
  29:  * (C) Copyright 2006-2007, by Pentaho Corporation.
  30:  */
  31: package org.jfree.formula.function.logical;
  32: 
  33: import org.jfree.formula.function.AbstractFunctionDescription;
  34: import org.jfree.formula.function.FunctionCategory;
  35: import org.jfree.formula.typing.Type;
  36: import org.jfree.formula.typing.coretypes.LogicalType;
  37: 
  38: /**
  39:  * Creation-Date: 04.11.2006, 18:28:55
  40:  *
  41:  * @author Thomas Morgner
  42:  */
  43: public class XorFunctionDescription extends AbstractFunctionDescription
  44: {
  45:   public XorFunctionDescription()
  46:   {
  47:     super("org.jfree.formula.function.logical.Xor-Function");
  48:   }
  49: 
  50:   public int getParameterCount()
  51:   {
  52:     return 1;
  53:   }
  54: 
  55:   public boolean isInfiniteParameterCount()
  56:   {
  57:     return true;
  58:   }
  59: 
  60:   public Type getParameterType(final int position)
  61:   {
  62:     return LogicalType.TYPE;
  63:   }
  64: 
  65:   public Type getValueType()
  66:   {
  67:     return LogicalType.TYPE;
  68:   }
  69: 
  70:   /**
  71:    * Defines, whether the parameter at the given position is mandatory. A
  72:    * mandatory parameter must be filled in, while optional parameters need not
  73:    * to be filled in.
  74:    *
  75:    * @return
  76:    */
  77:   public boolean isParameterMandatory(final int position)
  78:   {
  79:     return false;
  80:   }
  81: 
  82:   /**
  83:    * Returns the default value for an optional parameter. If the value returned
  84:    * here is null, then this either means, that the parameter is mandatory or
  85:    * that the default value is computed by the expression itself.
  86:    *
  87:    * @param position
  88:    * @return
  89:    */
  90:   public Object getDefaultValue(final int position)
  91:   {
  92:     return null;
  93:   }
  94: 
  95:   public FunctionCategory getCategory()
  96:   {
  97:     return LogicalFunctionCategory.CATEGORY;
  98:   }
  99: 
 100: }