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: MappedFunctionDescription.java 3521 2007-10-16 10:55:14Z tmorgner $ 28: * ------------ 29: * (C) Copyright 2006-2007, by Pentaho Corporation. 30: */ 31: package org.jfree.formula.function.userdefined; 32: 33: import java.util.Locale; 34: 35: import org.jfree.formula.typing.Type; 36: import org.jfree.formula.function.FunctionDescription; 37: import org.jfree.formula.function.FunctionCategory; 38: 39: /** 40: * Creation-Date: 05.11.2006, 14:01:22 41: * 42: * @author Thomas Morgner 43: */ 44: public class MappedFunctionDescription implements FunctionDescription 45: { 46: public MappedFunctionDescription() 47: { 48: } 49: 50: public String getDisplayName(final Locale locale) 51: { 52: return null; 53: } 54: 55: public String getDescription(final Locale locale) 56: { 57: return null; 58: } 59: 60: public boolean isVolatile() 61: { 62: return false; 63: } 64: 65: public Type getValueType() 66: { 67: return null; 68: } 69: 70: public int getParameterCount() 71: { 72: return 0; 73: } 74: 75: public boolean isInfiniteParameterCount() 76: { 77: return false; 78: } 79: 80: public Type getParameterType(final int position) 81: { 82: return null; 83: } 84: 85: public String getParameterDisplayName(final int position, final Locale locale) 86: { 87: return null; 88: } 89: 90: public String getParameterDescription(final int position, final Locale locale) 91: { 92: return null; 93: } 94: 95: /** 96: * Defines, whether the parameter at the given position is mandatory. A 97: * mandatory parameter must be filled in, while optional parameters need not 98: * to be filled in. 99: * 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: }