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