Class IndexFunctionDescription
- java.lang.Object
-
- org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription
-
- org.pentaho.reporting.libraries.formula.function.information.IndexFunctionDescription
-
- All Implemented Interfaces:
Serializable
,FunctionDescription
public class IndexFunctionDescription extends AbstractFunctionDescription
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description IndexFunctionDescription()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FunctionCategory
getCategory()
int
getParameterCount()
Type
getParameterType(int position)
Returns the parameter type at the given position using the function metadata.Type
getValueType()
boolean
isParameterMandatory(int position)
Defines, whether the parameter at the given position is mandatory.-
Methods inherited from class org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription
getBundle, getCanonicalName, getDefaultValue, getDescription, getDisplayName, getParameterDescription, getParameterDisplayName, isDeprecated, isExperimental, isInfiniteParameterCount, isVolatile
-
-
-
-
Method Detail
-
getValueType
public Type getValueType()
-
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.
-
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:
-
-