org.pentaho.reporting.libraries.formula.function

Class AbstractFunctionDescription

public abstract class AbstractFunctionDescription extends Object implements FunctionDescription

Creation-Date: 04.11.2006, 18:30:33

Author: Thomas Morgner

Method Summary
StringgetCanonicalName()
ObjectgetDefaultValue(int position)
Returns the default value for an optional parameter.
StringgetDescription(Locale locale)
StringgetDisplayName(Locale locale)
StringgetParameterDescription(int position, Locale locale)
StringgetParameterDisplayName(int position, Locale locale)
booleanisInfiniteParameterCount()
booleanisVolatile()

Method Detail

getCanonicalName

public String getCanonicalName()

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: null.

getDescription

public String getDescription(Locale locale)

getDisplayName

public String getDisplayName(Locale locale)

getParameterDescription

public String getParameterDescription(int position, Locale locale)

getParameterDisplayName

public String getParameterDisplayName(int position, Locale locale)

isInfiniteParameterCount

public boolean isInfiniteParameterCount()

isVolatile

public boolean isVolatile()