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: URLEncodeFunctionDescription.java 3521 2007-10-16 10:55:14Z tmorgner $
028     * ------------
029     * (C) Copyright 2006-2007, by Pentaho Corporation.
030     */
031    
032    package org.jfree.formula.function.text;
033    
034    import org.jfree.formula.function.AbstractFunctionDescription;
035    import org.jfree.formula.function.FunctionCategory;
036    import org.jfree.formula.typing.Type;
037    import org.jfree.formula.typing.coretypes.TextType;
038    
039    /**
040     * Describes LowerFunction function.
041     * @see org.jfree.formula.function.text.LowerFunction
042     *
043     * @author Cedric Pronzato
044     *
045     */
046    public class URLEncodeFunctionDescription extends AbstractFunctionDescription
047    {
048      public URLEncodeFunctionDescription()
049      {
050        super("org.jfree.formula.function.text.URLEncode-Function");
051      }
052    
053      public FunctionCategory getCategory()
054      {
055        return TextFunctionCategory.CATEGORY;
056      }
057    
058      public int getParameterCount()
059      {
060        return 2;
061      }
062    
063      public Type getParameterType(final int position)
064      {
065        return TextType.TYPE;
066      }
067    
068      public Type getValueType()
069      {
070        return TextType.TYPE;
071      }
072    
073      public boolean isParameterMandatory(final int position)
074      {
075        if (position == 1)
076        {
077          return false;
078        }
079        return true;
080      }
081    
082    }