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

   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: TodayFunction.java,v 1.4 2007/05/21 18:57:59 mimil Exp $
  28:  * ------------
  29:  * (C) Copyright 2006-2007, by Pentaho Corporation.
  30:  */
  31: 
  32: package org.jfree.formula.function.datetime;
  33: 
  34: import java.util.Date;
  35: 
  36: import org.jfree.formula.EvaluationException;
  37: import org.jfree.formula.FormulaContext;
  38: import org.jfree.formula.LocalizationContext;
  39: import org.jfree.formula.function.Function;
  40: import org.jfree.formula.function.ParameterCallback;
  41: import org.jfree.formula.lvalues.TypeValuePair;
  42: import org.jfree.formula.typing.coretypes.DateTimeType;
  43: import org.jfree.formula.util.DateUtil;
  44: 
  45: /**
  46:  * Todo: Document me!
  47:  *
  48:  * @author Thomas Morgner
  49:  * @since 23.03.2007
  50:  */
  51: public class TodayFunction implements Function
  52: {
  53:   public TodayFunction()
  54:   {
  55:   }
  56: 
  57:   public String getCanonicalName()
  58:   {
  59:     return "TODAY";
  60:   }
  61: 
  62:   public TypeValuePair evaluate(final FormulaContext context,
  63:                                 final ParameterCallback parameters)
  64:       throws EvaluationException
  65:   {
  66:     final LocalizationContext localizationContext = context.getLocalizationContext();
  67:     final Date now = DateUtil.now(localizationContext);
  68: 
  69:     final Date date = DateUtil.normalizeDate(now, DateTimeType.DATE_TYPE);
  70:     return new TypeValuePair(DateTimeType.DATE_TYPE, date);
  71:   }
  72: }