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: DefaultFunctionDescription.java 3521 2007-10-16 10:55:14Z tmorgner $
028 * ------------
029 * (C) Copyright 2006-2007, by Pentaho Corporation.
030 */
031 package org.jfree.formula.function;
032
033 import java.util.Locale;
034
035 import org.jfree.formula.function.userdefined.UserDefinedFunctionCategory;
036 import org.jfree.formula.typing.Type;
037 import org.jfree.formula.typing.coretypes.AnyType;
038
039 /**
040 * Creation-Date: 05.11.2006, 15:13:03
041 *
042 * @author Thomas Morgner
043 */
044 public class DefaultFunctionDescription implements FunctionDescription
045 {
046 private String name;
047
048 public DefaultFunctionDescription(final String name)
049 {
050 this.name = name;
051 }
052
053 public Type getValueType()
054 {
055 return AnyType.TYPE;
056 }
057
058 public FunctionCategory getCategory()
059 {
060 return UserDefinedFunctionCategory.CATEGORY;
061 }
062
063 public int getParameterCount()
064 {
065 return 1;
066 }
067
068 public Type getParameterType(final int position)
069 {
070 return AnyType.TYPE;
071 }
072
073 /**
074 * Defines, whether the parameter at the given position is mandatory. A
075 * mandatory parameter must be filled in, while optional parameters need not
076 * to be filled in.
077 *
078 * @return
079 */
080 public boolean isParameterMandatory(final int position)
081 {
082 return false;
083 }
084
085 public String getDisplayName(final Locale locale)
086 {
087 return name;
088 }
089
090 public String getDescription(final Locale locale)
091 {
092 return "";
093 }
094
095 public boolean isVolatile()
096 {
097 // assume the worst ..
098 return true;
099 }
100
101 public boolean isInfiniteParameterCount()
102 {
103 return true;
104 }
105
106 public String getParameterDisplayName(final int position, final Locale locale)
107 {
108 // todo this is surely ugly ..
109 return "Parameter " + String.valueOf(position);
110 }
111
112 public String getParameterDescription(final int position, final Locale locale)
113 {
114 return "";
115 }
116
117 /**
118 * Returns the default value for an optional parameter. If the value returned
119 * here is null, then this either means, that the parameter is mandatory or
120 * that the default value is computed by the expression itself.
121 *
122 * @param position
123 * @return
124 */
125 public Object getDefaultValue(final int position)
126 {
127 return null;
128 }
129 }