org.jfree.formula.function
Interface FunctionDescription
public
interface
FunctionDescription
A static definition of the function's parameters, return values etc.
This is a support class with emphasis on GUI tools.
However, the parameter declarations are also used when filling in the
parameter values.
Functions have a defined set of known parameters and can have a unlimited
number of optional parameters. If a function declares at least one parameter
and declares that its parameter list is infinite, then the last parameter
type is used on all remaining parameters.
Author: Thomas Morgner
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:
public String getDescription(Locale locale)
public String getDisplayName(Locale locale)
public int getParameterCount()
public String getParameterDescription(int position, Locale locale)
public String getParameterDisplayName(int position, Locale locale)
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.
public
Type getValueType()
public boolean isInfiniteParameterCount()
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:
public boolean isVolatile()