org.pentaho.reporting.libraries.formula.function

Class DefaultFunctionDescription

public class DefaultFunctionDescription extends Object implements FunctionDescription

Creation-Date: 05.11.2006, 15:13:03

Author: Thomas Morgner

Constructor Summary
	DefaultFunctionDescription(String name)

Method Summary
String	getCanonicalName()
FunctionCategory	getCategory()
Object	getDefaultValue(int position) Returns the default value for an optional parameter.
String	getDescription(Locale locale)
String	getDisplayName(Locale locale)
int	getParameterCount()
String	getParameterDescription(int position, Locale locale)
String	getParameterDisplayName(int position, Locale locale)
Type	getParameterType(int position)
Type	getValueType()
boolean	isInfiniteParameterCount()
boolean	isParameterMandatory(int position) Defines, whether the parameter at the given position is mandatory.
boolean	isVolatile()

Constructor Detail

DefaultFunctionDescription

public DefaultFunctionDescription(String name)

Method Detail

getDefaultValue

public Object getDefaultValue(int position)

Returns the default value for an optional parameter. If the value returned here is null, then this either means, that the parameter is mandatory or that the default value is computed by the expression itself.

Parameters: position

Returns:

getDescription

public String getDescription(Locale locale)

getDisplayName

public String getDisplayName(Locale locale)

getParameterCount

public int getParameterCount()

getParameterDescription

public String getParameterDescription(int position, Locale locale)

getParameterDisplayName

public String getParameterDisplayName(int position, Locale locale)

getParameterType

public Type getParameterType(int position)

getValueType

public Type getValueType()

isInfiniteParameterCount

public boolean isInfiniteParameterCount()

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:

isVolatile

public boolean isVolatile()