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

Constructor Summary
protected	AbstractFunctionDescription(String cannonicalName, String bundleName)

Method Summary
protected ResourceBundle	getBundle(Locale locale)
String	getCanonicalName()
Object	getDefaultValue(int position) Returns the default value for an optional parameter.
String	getDescription(Locale locale)
String	getDisplayName(Locale locale)
String	getParameterDescription(int position, Locale locale)
String	getParameterDisplayName(int position, Locale locale)
boolean	isInfiniteParameterCount()
boolean	isVolatile()

Constructor Detail

AbstractFunctionDescription

protected AbstractFunctionDescription(String cannonicalName, String bundleName)

Method Detail

getBundle

protected ResourceBundle getBundle(Locale locale)

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()