/*!
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* Copyright (c) 2002-2013 Pentaho Corporation.. All rights reserved.
*/
package org.pentaho.reporting.engine.classic.core.function.formula;
import org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription;
import org.pentaho.reporting.libraries.formula.function.FunctionCategory;
import org.pentaho.reporting.libraries.formula.function.text.TextFunctionCategory;
import org.pentaho.reporting.libraries.formula.typing.Type;
import org.pentaho.reporting.libraries.formula.typing.coretypes.TextType;
public class QuoteTextFunctionDescription extends AbstractFunctionDescription {
public QuoteTextFunctionDescription() {
super( "QUOTETEXT", "org.pentaho.reporting.engine.classic.core.function.formula.QuoteText-Function" );
}
public Type getValueType() {
return TextType.TYPE;
}
public FunctionCategory getCategory() {
return TextFunctionCategory.CATEGORY;
}
public int getParameterCount() {
return 2;
}
/**
* Returns the parameter type at the given position using the function metadata. The first parameter is at the
* position 0;
*
* @param position
* The parameter index.
* @return The parameter type.
*/
public Type getParameterType( final int position ) {
return TextType.TYPE;
}
/**
* Defines, whether the parameter at the given position is mandatory. A mandatory parameter must be filled in, while
* optional parameters need not to be filled in.
*
* @return
*/
public boolean isParameterMandatory( final int position ) {
return position == 0;
}
}