org.jfree.formula.function.userdefined

Class MappedFunctionDescription

Implemented Interfaces:
FunctionDescription

public class MappedFunctionDescription
extends java.lang.Object
implements FunctionDescription

Creation-Date: 05.11.2006, 14:01:22
Author:
Thomas Morgner

Constructor Summary

MappedFunctionDescription()

Method Summary

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)
Returns the parameter type at the given position using the function metadata.
Type
getValueType()
boolean
isInfiniteParameterCount()
boolean
isParameterMandatory(int position)
Defines, whether the parameter at the given position is mandatory.
boolean
isVolatile()

Constructor Details

MappedFunctionDescription

public MappedFunctionDescription()

Method Details

getCategory

public FunctionCategory getCategory()
Specified by:
getCategory in interface FunctionDescription

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.
Specified by:
getDefaultValue in interface FunctionDescription
Parameters:
position -
Returns:

getDescription

public String getDescription(Locale locale)
Specified by:
getDescription in interface FunctionDescription

getDisplayName

public String getDisplayName(Locale locale)
Specified by:
getDisplayName in interface FunctionDescription

getParameterCount

public int getParameterCount()
Specified by:
getParameterCount in interface FunctionDescription

getParameterDescription

public String getParameterDescription(int position,
                                      Locale locale)
Specified by:
getParameterDescription in interface FunctionDescription

getParameterDisplayName

public String getParameterDisplayName(int position,
                                      Locale locale)
Specified by:
getParameterDisplayName in interface FunctionDescription

getParameterType

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;
Specified by:
getParameterType in interface FunctionDescription
Parameters:
position - The parameter index.
Returns:
The parameter type.

getValueType

public Type getValueType()
Specified by:
getValueType in interface FunctionDescription

isInfiniteParameterCount

public boolean isInfiniteParameterCount()
Specified by:
isInfiniteParameterCount in interface FunctionDescription

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.
Specified by:
isParameterMandatory in interface FunctionDescription
Returns:

isVolatile

public boolean isVolatile()
Specified by:
isVolatile in interface FunctionDescription