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: TodayFunction.java 2847 2007-05-21 18:57:59Z mimil $
028 * ------------
029 * (C) Copyright 2006-2007, by Pentaho Corporation.
030 */
031
032 package org.jfree.formula.function.datetime;
033
034 import java.util.Date;
035
036 import org.jfree.formula.EvaluationException;
037 import org.jfree.formula.FormulaContext;
038 import org.jfree.formula.LocalizationContext;
039 import org.jfree.formula.function.Function;
040 import org.jfree.formula.function.ParameterCallback;
041 import org.jfree.formula.lvalues.TypeValuePair;
042 import org.jfree.formula.typing.coretypes.DateTimeType;
043 import org.jfree.formula.util.DateUtil;
044
045 /**
046 * Todo: Document me!
047 *
048 * @author Thomas Morgner
049 * @since 23.03.2007
050 */
051 public class TodayFunction implements Function
052 {
053 public TodayFunction()
054 {
055 }
056
057 public String getCanonicalName()
058 {
059 return "TODAY";
060 }
061
062 public TypeValuePair evaluate(final FormulaContext context,
063 final ParameterCallback parameters)
064 throws EvaluationException
065 {
066 final LocalizationContext localizationContext = context.getLocalizationContext();
067 final Date now = DateUtil.now(localizationContext);
068
069 final Date date = DateUtil.normalizeDate(now, DateTimeType.DATE_TYPE);
070 return new TypeValuePair(DateTimeType.DATE_TYPE, date);
071 }
072 }