Class FormulaFunction
java.lang.Object
org.pentaho.reporting.libraries.formula.lvalues.AbstractLValue
org.pentaho.reporting.libraries.formula.lvalues.FormulaFunction
- All Implemented Interfaces:
Serializable
,Cloneable
,LValue
A function. Formulas consist of functions, references or static values, which are connected by operators.
Functions always have a cannonical name, which must be unique and which identifies the function. Functions can have a
list of parameters. The number of parameters can vary, and not all parameters need to be filled.
Functions can have required and optional parameters. Mixing required and optional parameters is not allowed. Optional
parameters cannot be ommited, unless they are the last parameter in the list.
This class provides the necessary wrapper functionality to fill in the parameters.
- Author:
- Thomas Morgner
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionFormulaFunction
(String functionName, LValue[] parameters) FormulaFunction
(String functionName, LValue[] parameters, ParsePosition parsePosition) -
Method Summary
Modifier and TypeMethodDescriptionclone()
evaluate()
LValue[]
Returns any dependent lvalues (parameters and operands, mostly).Returns the initialized function.Returns the function's name.Returns the function's meta-data.void
initialize
(FormulaContext context) boolean
Checks whether the LValue is constant.toString()
Methods inherited from class org.pentaho.reporting.libraries.formula.lvalues.AbstractLValue
getContext, getParsePosition, getValueType, setParsePosition
-
Constructor Details
-
FormulaFunction
-
FormulaFunction
-
-
Method Details
-
initialize
- Specified by:
initialize
in interfaceLValue
- Overrides:
initialize
in classAbstractLValue
- Throws:
EvaluationException
-
getFunctionName
Returns the function's name. This is the normalized name and may not be suitable for the user. Query the function's metadata to retrieve a display-name.- Returns:
- the function's name.
-
getFunction
Returns the initialized function. Be aware that this method will return null if this LValue instance has not yet been initialized.- Returns:
- the function instance or null, if the FormulaFunction instance has not yet been initialized.
-
getMetaData
Returns the function's meta-data. Be aware that this method will return null if this LValue instance has not yet been initialized.- Returns:
- the function description instance or null, if the FormulaFunction instance has not yet been initialized.
-
clone
- Specified by:
clone
in interfaceLValue
- Overrides:
clone
in classAbstractLValue
- Throws:
CloneNotSupportedException
-
evaluate
- Throws:
EvaluationException
-
getChildValues
Returns any dependent lvalues (parameters and operands, mostly).- Specified by:
getChildValues
in interfaceLValue
- Overrides:
getChildValues
in classAbstractLValue
- Returns:
-
toString
-
isConstant
public boolean isConstant()Checks whether the LValue is constant. Constant lvalues always return the same value.- Returns:
- true, if the function will always return the same value.
-