org.pentaho.reporting.libraries.formula.function.text

Class SubstituteFunctionDescription

java.lang.Object

org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription

org.pentaho.reporting.libraries.formula.function.text.SubstituteFunctionDescription

All Implemented Interfaces:

java.io.Serializable, FunctionDescription

public class SubstituteFunctionDescription
extends AbstractFunctionDescription

Describes SubstituteFunction function.

Author:

Cedric Pronzato

See Also:

SubstituteFunction, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SubstituteFunctionDescription()

Method Summary

Modifier and Type	Method and 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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SubstituteFunctionDescription

public SubstituteFunctionDescription()

Method Detail

getCategory

public FunctionCategory getCategory()

getParameterCount

public int getParameterCount()

getParameterType

public Type getParameterType(int position)

Description copied from interface: FunctionDescription

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)

Description copied from interface: FunctionDescription

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: