org.pentaho.reporting.libraries.formula.function.information

Class IndexFunctionDescription

public class IndexFunctionDescription extends AbstractFunctionDescription

Todo: Document me!

Date: 02.07.2009 Time: 20:13:36

Author: Thomas Morgner.

Constructor Summary
IndexFunctionDescription()
Method Summary
FunctionCategorygetCategory()
intgetParameterCount()
TypegetParameterType(int position)
Returns the parameter type at the given position using the function metadata.
TypegetValueType()
booleanisParameterMandatory(int position)
Defines, whether the parameter at the given position is mandatory.

Constructor Detail

IndexFunctionDescription

public IndexFunctionDescription()

Method Detail

getCategory

public FunctionCategory getCategory()

getParameterCount

public int getParameterCount()

getParameterType

public Type getParameterType(int position)
Returns the parameter type at the given position using the function metadata. The first parameter is at the position 0;

Parameters: position The parameter index.

Returns: The parameter type.

getValueType

public Type getValueType()

isParameterMandatory

public boolean isParameterMandatory(int position)
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.

Returns: