Class AbstractFunctionDescription
- java.lang.Object
-
- org.pentaho.reporting.libraries.formula.function.AbstractFunctionDescription
-
- All Implemented Interfaces:
Serializable
,FunctionDescription
- Direct Known Subclasses:
AbsFunctionDescription
,AcosFunctionDescription
,AcoshFunctionDescription
,AndFunctionDescription
,ArrayConcatenateFunctionDescription
,ArrayContainsFunctionDescription
,ArrayLeftFunctionDescription
,ArrayMidFunctionDescription
,ArrayRightFunctionDescription
,AscFunctionDescription
,AsinFunctionDescription
,Atan2FunctionDescription
,AtanFunctionDescription
,AverageAFunctionDescription
,AverageFunctionDescription
,BeginsWithFunctionDescription
,CharFunctionDescription
,ChooseFunctionDescription
,CleanFunctionDescription
,CodeFunctionDescription
,ConcatenateFunctionDescription
,ContainsFunctionDescription
,CosFunctionDescription
,CountAFunctionDescription
,CountBlankFunctionDescription
,CountFunctionDescription
,CsvArrayFunctionDescription
,CsvTextFunctionDescription
,DateDifFunctionDescription
,DateFunctionDescription
,DateTimeValueFunctionDescription
,DateValueFunctionDescription
,DayFunctionDescription
,DaysFunctionDescription
,DollarFunctionDescription
,EndsWithFunctionDescription
,EqualsFunctionDescription
,ErrorFunctionDescription
,EvenFunctionDescription
,ExactFunctionDescription
,ExpFunctionDescription
,FalseFunctionDescription
,FindFunctionDescription
,FixedFunctionDescription
,HasChangedFunctionDescription
,HourFunctionDescription
,IfFunctionDescription
,IfNaFunctionDescription
,IndexFunctionDescription
,InFunctionDescription
,IntFunctionDescription
,IsBlankFunctionDescription
,IsErrFunctionDescription
,IsErrorFunctionDescription
,IsEvenFunctionDescription
,IsLogicalFunctionDescription
,IsNaFunctionDescription
,IsNonTextFunctionDescription
,IsNumberFunctionDescription
,IsOddFunctionDescription
,IsRefFunctionDescription
,IsTextFunctionDescription
,LeftFunctionDescription
,LenFunctionDescription
,LikeFunctionDescription
,LnFunctionDescription
,Log10FunctionDescription
,LogFunctionDescription
,LookupFunctionDescription
,LowerFunctionDescription
,MaxAFunctionDescription
,MaxFunctionDescription
,MessageFunctionDescription
,MidFunctionDescription
,MinAFunctionDescription
,MinFunctionDescription
,MinuteFunctionDescription
,ModFunctionDescription
,MonthEndFunctionDescription
,MonthFunctionDescription
,NaFunctionDescription
,NFunctionDescription
,NormalizeArrayFunctionDescription
,NotFunctionDescription
,NowFunctionDescription
,NullFunctionDescription
,OddFunctionDescription
,OrFunctionDescription
,ParseDateFunctionDescription
,PiFunctionDescription
,PowerFunctionDescription
,PrevWeekdayFunctionDescription
,ProperFunctionDescription
,ReplaceFunctionDescription
,ReptFunctionDescription
,RightFunctionDescription
,SearchFunctionDescription
,SecondFunctionDescription
,SequenceQuoterFunctionDescription
,SinFunctionDescription
,SqrtFunctionDescription
,StringCountFunctionDescription
,SubstituteFunctionDescription
,SumAFunctionDescription
,SumFunctionDescription
,TextFunctionDescription
,TFunctionDescription
,TimeFunctionDescription
,TimeValueFunctionDescription
,TodayFunctionDescription
,TrimFunctionDescription
,TrueFunctionDescription
,UnicharFunctionDescription
,UnicodeFunctionDescription
,UpperFunctionDescription
,URLBuilderFunctionDescription
,URLEncodeFunctionDescription
,ValueFunctionDescription
,VarFunctionDescription
,WeekDayFunctionDescription
,XorFunctionDescription
,YearFunctionDescription
,YesterdayFunctionDescription
public abstract class AbstractFunctionDescription extends Object implements FunctionDescription
Creation-Date: 04.11.2006, 18:30:33- Author:
- Thomas Morgner
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractFunctionDescription(String cannonicalName, String bundleName)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
isDeprecated()
boolean
isExperimental()
boolean
isInfiniteParameterCount()
boolean
isVolatile()
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.pentaho.reporting.libraries.formula.function.FunctionDescription
getCategory, getParameterCount, getParameterType, getValueType, isParameterMandatory
-
-
-
-
Method Detail
-
getCanonicalName
public String getCanonicalName()
- Specified by:
getCanonicalName
in interfaceFunctionDescription
-
isVolatile
public boolean isVolatile()
- Specified by:
isVolatile
in interfaceFunctionDescription
-
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 interfaceFunctionDescription
- Parameters:
position
-- Returns:
- null.
-
isInfiniteParameterCount
public boolean isInfiniteParameterCount()
- Specified by:
isInfiniteParameterCount
in interfaceFunctionDescription
-
getBundle
protected ResourceBundle getBundle(Locale locale)
-
getDisplayName
public String getDisplayName(Locale locale)
- Specified by:
getDisplayName
in interfaceFunctionDescription
-
getDescription
public String getDescription(Locale locale)
- Specified by:
getDescription
in interfaceFunctionDescription
-
getParameterDisplayName
public String getParameterDisplayName(int position, Locale locale)
- Specified by:
getParameterDisplayName
in interfaceFunctionDescription
-
getParameterDescription
public String getParameterDescription(int position, Locale locale)
- Specified by:
getParameterDescription
in interfaceFunctionDescription
-
isDeprecated
public boolean isDeprecated()
- Specified by:
isDeprecated
in interfaceFunctionDescription
-
isExperimental
public boolean isExperimental()
- Specified by:
isExperimental
in interfaceFunctionDescription
-
-