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: TimeFunctionDescription.java 3522 2007-10-16 10:56:57Z tmorgner $
028 * ------------
029 * (C) Copyright 2006-2007, by Pentaho Corporation.
030 */
031 package org.jfree.formula.function.datetime;
032
033 import org.jfree.formula.function.AbstractFunctionDescription;
034 import org.jfree.formula.function.FunctionCategory;
035 import org.jfree.formula.typing.Type;
036 import org.jfree.formula.typing.coretypes.DateTimeType;
037 import org.jfree.formula.typing.coretypes.NumberType;
038
039 /**
040 * Describes the TimeFunction function
041 *
042 * @see TimeFunction
043 * @author Cedric Pronzato
044 */
045 public class TimeFunctionDescription extends AbstractFunctionDescription
046 {
047 public TimeFunctionDescription()
048 {
049 super("org.jfree.formula.function.datetime.Time-Function");
050 }
051
052 public Type getValueType()
053 {
054 return DateTimeType.TIME_TYPE;
055 }
056
057 public int getParameterCount()
058 {
059 return 3;
060 }
061
062 public Type getParameterType(final int position)
063 {
064 return NumberType.GENERIC_NUMBER;
065 }
066
067 /**
068 * Defines, whether the parameter at the given position is mandatory. A
069 * mandatory parameter must be filled in, while optional parameters need not
070 * to be filled in.
071 *
072 * @return
073 */
074 public boolean isParameterMandatory(final int position)
075 {
076 return true;
077 }
078
079 public FunctionCategory getCategory()
080 {
081 return DateTimeFunctionCategory.CATEGORY;
082 }
083 }