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: AbstractFunctionDescription.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 import java.util.ResourceBundle;
035
036 /**
037 * Creation-Date: 04.11.2006, 18:30:33
038 *
039 * @author Thomas Morgner
040 */
041 public abstract class AbstractFunctionDescription implements FunctionDescription
042 {
043 private String bundleName;
044
045 protected AbstractFunctionDescription(final String bundleName)
046 {
047 this.bundleName = bundleName;
048 }
049
050 public boolean isVolatile()
051 {
052 return false;
053 }
054
055 /**
056 * Returns the default value for an optional parameter. If the value returned
057 * here is null, then this either means, that the parameter is mandatory or
058 * that the default value is computed by the expression itself.
059 *
060 * @param position
061 * @return null.
062 */
063 public Object getDefaultValue(final int position)
064 {
065 return null;
066 }
067
068 public boolean isInfiniteParameterCount()
069 {
070 return false;
071 }
072
073 protected ResourceBundle getBundle(final Locale locale)
074 {
075 return ResourceBundle.getBundle(bundleName, locale);
076 }
077
078 public String getDisplayName(final Locale locale)
079 {
080 return getBundle(locale).getString("display-name");
081 }
082
083 public String getDescription(final Locale locale)
084 {
085 return getBundle(locale).getString("description");
086 }
087
088 public String getParameterDisplayName(final int position, final Locale locale)
089 {
090 return getBundle(locale).getString("parameter." + position + ".display-name");
091 }
092
093 public String getParameterDescription(final int position, final Locale locale)
094 {
095 return getBundle(locale).getString("parameter." + position + ".description");
096 }
097
098
099 }