Frames | No Frames |
1: /** 2: * ========================================= 3: * LibFormula : a free Java formula library 4: * ========================================= 5: * 6: * Project Info: http://reporting.pentaho.org/libformula/ 7: * 8: * (C) Copyright 2006-2007, by Pentaho Corporation and Contributors. 9: * 10: * This library is free software; you can redistribute it and/or modify it under the terms 11: * of the GNU Lesser General Public License as published by the Free Software Foundation; 12: * either version 2.1 of the License, or (at your option) any later version. 13: * 14: * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 15: * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 16: * See the GNU Lesser General Public License for more details. 17: * 18: * You should have received a copy of the GNU Lesser General Public License along with this 19: * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, 20: * Boston, MA 02111-1307, USA. 21: * 22: * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 23: * in the United States and other countries.] 24: * 25: * 26: * ------------ 27: * $Id: DefaultFunctionDescription.java,v 1.3 2007/04/01 13:51:52 taqua Exp $ 28: * ------------ 29: * (C) Copyright 2006-2007, by Pentaho Corporation. 30: */ 31: package org.jfree.formula.function; 32: 33: import java.util.Locale; 34: 35: import org.jfree.formula.function.userdefined.UserDefinedFunctionCategory; 36: import org.jfree.formula.typing.Type; 37: import org.jfree.formula.typing.coretypes.AnyType; 38: 39: /** 40: * Creation-Date: 05.11.2006, 15:13:03 41: * 42: * @author Thomas Morgner 43: */ 44: public class DefaultFunctionDescription implements FunctionDescription 45: { 46: private String name; 47: 48: public DefaultFunctionDescription(final String name) 49: { 50: this.name = name; 51: } 52: 53: public Type getValueType() 54: { 55: return AnyType.TYPE; 56: } 57: 58: public FunctionCategory getCategory() 59: { 60: return UserDefinedFunctionCategory.CATEGORY; 61: } 62: 63: public int getParameterCount() 64: { 65: return 1; 66: } 67: 68: public Type getParameterType(int position) 69: { 70: return AnyType.TYPE; 71: } 72: 73: /** 74: * Defines, whether the parameter at the given position is mandatory. A 75: * mandatory parameter must be filled in, while optional parameters need not 76: * to be filled in. 77: * 78: * @return 79: */ 80: public boolean isParameterMandatory(int position) 81: { 82: return false; 83: } 84: 85: public String getDisplayName(Locale locale) 86: { 87: return name; 88: } 89: 90: public String getDescription(Locale locale) 91: { 92: return ""; 93: } 94: 95: public boolean isVolatile() 96: { 97: // assume the worst .. 98: return true; 99: } 100: 101: public boolean isInfiniteParameterCount() 102: { 103: return true; 104: } 105: 106: public String getParameterDisplayName(int position, Locale locale) 107: { 108: // todo this is surely ugly .. 109: return "Parameter " + String.valueOf(position); 110: } 111: 112: public String getParameterDescription(int position, 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(int position) 126: { 127: return null; 128: } 129: }