org.pentaho.reporting.libraries.formula.function
Interface FunctionDescription

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbsFunctionDescription, AbstractFunctionDescription, AcosFunctionDescription, AcoshFunctionDescription, AndFunctionDescription, ArrayConcatenateFunctionDescription, ArrayLeftFunctionDescription, ArrayMidFunctionDescription, ArrayRightFunctionDescription, AscFunctionDescription, AsinFunctionDescription, Atan2FunctionDescription, AtanFunctionDescription, AverageAFunctionDescription, AverageFunctionDescription, CharFunctionDescription, ChooseFunctionDescription, CleanFunctionDescription, CodeFunctionDescription, ConcatenateFunctionDescription, CosFunctionDescription, CountAFunctionDescription, CountBlankFunctionDescription, CountFunctionDescription, CsvArrayFunctionDescription, CsvTextFunctionDescription, DateDifFunctionDescription, DateFunctionDescription, DateTimeValueFunctionDescription, DateValueFunctionDescription, DayFunctionDescription, DaysFunctionDescription, DefaultFunctionDescription, DollarFunctionDescription, EvenFunctionDescription, ExactFunctionDescription, ExpFunctionDescription, FalseFunctionDescription, FindFunctionDescription, FixedFunctionDescription, HasChangedFunctionDescription, HourFunctionDescription, IfFunctionDescription, IfNaFunctionDescription, IndexFunctionDescription, IntFunctionDescription, IsBlankFunctionDescription, IsErrFunctionDescription, IsErrorFunctionDescription, IsEvenFunctionDescription, IsLogicalFunctionDescription, IsNaFunctionDescription, IsNonTextFunctionDescription, IsNumberFunctionDescription, IsOddFunctionDescription, IsRefFunctionDescription, IsTextFunctionDescription, LeftFunctionDescription, LenFunctionDescription, LnFunctionDescription, Log10FunctionDescription, LogFunctionDescription, LowerFunctionDescription, MaxAFunctionDescription, MaxFunctionDescription, MessageFunctionDescription, MidFunctionDescription, MinAFunctionDescription, MinFunctionDescription, MinuteFunctionDescription, ModFunctionDescription, MonthFunctionDescription, NaFunctionDescription, NFunctionDescription, NormalizeArrayFunctionDescription, NotFunctionDescription, NowFunctionDescription, NullFunctionDescription, OddFunctionDescription, OrFunctionDescription, ParseDateFunctionDescription, PiFunctionDescription, PowerFunctionDescription, PrevWeekdayFunctionDescription, ProperFunctionDescription, ReplaceFunctionDescription, ReptFunctionDescription, RightFunctionDescription, SearchFunctionDescription, SecondFunctionDescription, SequenceQuoterFunctionDescription, SinFunctionDescription, SqrtFunctionDescription, SubstituteFunctionDescription, SumAFunctionDescription, SumFunctionDescription, TextFunctionDescription, TFunctionDescription, TimeFunctionDescription, TimeValueFunctionDescription, TodayFunctionDescription, TrimFunctionDescription, TrueFunctionDescription, UnicharFunctionDescription, UnicodeFunctionDescription, UpperFunctionDescription, URLEncodeFunctionDescription, ValueFunctionDescription, VarFunctionDescription, WeekDayFunctionDescription, XorFunctionDescription, YearFunctionDescription, YesterdayFunctionDescription

public interface FunctionDescription
extends Serializable

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

Method Summary

String	getCanonicalName()
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	isDeprecated()
boolean	isExperimental()
boolean	isInfiniteParameterCount()
boolean	isParameterMandatory(int position) Defines, whether the parameter at the given position is mandatory.
boolean	isVolatile()

Method Detail

getCanonicalName

String getCanonicalName()

getDisplayName

String getDisplayName(Locale locale)

getDescription

String getDescription(Locale locale)

isVolatile

boolean isVolatile()

getValueType

Type getValueType()

getCategory

FunctionCategory getCategory()

isDeprecated

boolean isDeprecated()

isExperimental

boolean isExperimental()

getParameterCount

int getParameterCount()

isInfiniteParameterCount

boolean isInfiniteParameterCount()

getParameterType

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.

getParameterDisplayName

String getParameterDisplayName(int position,
                               Locale locale)

getParameterDescription

String getParameterDescription(int position,
                               Locale locale)

isParameterMandatory

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:

getDefaultValue

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: