org.pentaho.reporting.libraries.formula.function.information
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

Todo: Document me!

Date: 02.07.2009 Time: 20:13:36

Author:

Thomas Morgner.

See Also:

Serialized Form

Constructor Summary

IndexFunctionDescription()

Method Summary

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

getCanonicalName, getDefaultValue, getDescription, getDisplayName, getParameterDescription, getParameterDisplayName, isDeprecated, isExperimental, isInfiniteParameterCount, isVolatile

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexFunctionDescription

public IndexFunctionDescription()

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: