Source for org.jfree.formula.function.datetime.YearFunctionDescription

   1: /**
   2:  * =========================================
   3:  * LibFormula : a free Java formula library
   4:  * =========================================
   5:  *
   6:  * Project Info:  http://jfreereport.pentaho.org/libformula
   7:  *
   8:  * (C) Copyright 2006, 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: YearFunctionDescription.java,v 1.2 2007/05/21 18:57:59 mimil Exp $
  28:  * ------------
  29:  * (C) Copyright 2006, by Pentaho Corporation.
  30:  */
  31: package org.jfree.formula.function.datetime;
  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.DateTimeType;
  37: import org.jfree.formula.typing.coretypes.NumberType;
  38: 
  39: /**
  40:  * Describes YearFunction function.
  41:  * 
  42:  * @see YearFunction
  43:  * 
  44:  * @author Cedric Pronzato
  45:  */
  46: public class YearFunctionDescription extends AbstractFunctionDescription
  47: {
  48:   public YearFunctionDescription()
  49:   {
  50:     super("org.jfree.formula.function.datetime.Year-Function");
  51:   }
  52: 
  53:   public Type getValueType()
  54:   {
  55:     return NumberType.GENERIC_NUMBER;
  56:   }
  57: 
  58:   public int getParameterCount()
  59:   {
  60:     return 1;
  61:   }
  62: 
  63:   public Type getParameterType(int position)
  64:   {
  65:     return DateTimeType.DATE_TYPE;
  66:   }
  67: 
  68:   public boolean isParameterMandatory(int position)
  69:   {
  70:     return true;
  71:   }
  72: 
  73:   public FunctionCategory getCategory()
  74:   {
  75:     return DateTimeFunctionCategory.CATEGORY;
  76:   }
  77: }