/**
* =========================================
* LibFormula : a free Java formula library
* =========================================
*
* Project Info: http://reporting.pentaho.org/libformula/
*
* (C) Copyright 2006-2007, by Pentaho Corporation and Contributors.
*
* This library is free software; you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License as published by the Free Software Foundation;
* either version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307, USA.
*
* [Java is a trademark or registered trademark of Sun Microsystems, Inc.
* in the United States and other countries.]
*
*
* ------------
* $Id: TodayFunction.java,v 1.4 2007/05/21 18:57:59 mimil Exp $
* ------------
* (C) Copyright 2006-2007, by Pentaho Corporation.
*/
package org.jfree.formula.function.datetime;
import java.util.Date;
import org.jfree.formula.EvaluationException;
import org.jfree.formula.FormulaContext;
import org.jfree.formula.LocalizationContext;
import org.jfree.formula.function.Function;
import org.jfree.formula.function.ParameterCallback;
import org.jfree.formula.lvalues.TypeValuePair;
import org.jfree.formula.typing.coretypes.DateTimeType;
import org.jfree.formula.util.DateUtil;
/**
* Todo: Document me!
*
* @author Thomas Morgner
* @since 23.03.2007
*/
public class TodayFunction implements Function
{
public TodayFunction()
{
}
public String getCanonicalName()
{
return "TODAY";
}
public TypeValuePair evaluate(final FormulaContext context,
final ParameterCallback parameters)
throws EvaluationException
{
final LocalizationContext localizationContext = context.getLocalizationContext();
final Date now = DateUtil.now(localizationContext);
final Date date = DateUtil.normalizeDate(now, DateTimeType.DATE_TYPE);
return new TypeValuePair(DateTimeType.DATE_TYPE, date);
}
}