org.jfree.formula.function

Class AbstractFunctionDescription

Implemented Interfaces:
FunctionDescription
Known Direct Subclasses:
AbsFunctionDescription, AndFunctionDescription, AverageFunctionDescription, ChooseFunctionDescription, DateDifFunctionDescription, DateFunctionDescription, DateValueFunctionDescription, DayFunctionDescription, EvenFunctionDescription, ExactFunctionDescription, FalseFunctionDescription, FindFunctionDescription, HasChangedFunctionDescription, HourFunctionDescription, IfFunctionDescription, IntFunctionDescription, IsBlankFunctionDescription, IsErrFunctionDescription, IsErrorFunctionDescription, IsEvenFunctionDescription, IsLogicalFunctionDescription, IsNaFunctionDescription, IsNonTextFunctionDescription, IsNumberFunctionDescription, IsOddFunctionDescription, IsRefFunctionDescription, IsTextFunctionDescription, LeftFunctionDescription, LenFunctionDescription, LowerFunctionDescription, MaxFunctionDescription, MidFunctionDescription, MinFunctionDescription, ModFunctionDescription, MonthFunctionDescription, NaFunctionDescription, NotFunctionDescription, NowFunctionDescription, NullFunctionDescription, OddFunctionDescription, OrFunctionDescription, ReplaceFunctionDescription, ReptFunctionDescription, RightFunctionDescription, SubstituteFunctionDescription, SumFunctionDescription, TextFunctionDescription, TFunctionDescription, TimeFunctionDescription, TodayFunctionDescription, TrimFunctionDescription, TrueFunctionDescription, UpperFunctionDescription, URLEncodeFunctionDescription, WeekDayFunctionDescription, XorFunctionDescription, YearFunctionDescription

public abstract class AbstractFunctionDescription
extends java.lang.Object
implements FunctionDescription

Creation-Date: 04.11.2006, 18:30:33
Author:
Thomas Morgner

Constructor Summary

AbstractFunctionDescription(String bundleName)

Method Summary

protected ResourceBundle
getBundle(Locale locale)
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 Details

AbstractFunctionDescription

protected AbstractFunctionDescription(String bundleName)

Method Details

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

getDescription

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

getDisplayName

public String getDisplayName(Locale locale)
Specified by:
getDisplayName 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

isInfiniteParameterCount

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

isVolatile

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