Package org.jfree.report.expressions
Class FormulaFunction
java.lang.Object
org.jfree.report.expressions.AbstractExpression
org.jfree.report.expressions.FormulaFunction
- All Implemented Interfaces:
Serializable
,Cloneable
,Expression
,Function
Creation-Date: 04.11.2006, 19:24:04
- Author:
- Thomas Morgner
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionadvance()
When the advance method is called, the function is asked to perform the next step of its computation.clone()
Clones the expression, expression should be reinitialized after the cloning.Return the current expression value.org.pentaho.reporting.libraries.formula.Formula
Returns the compiled formula.void
setFormula
(String formula) void
setInitial
(String initial) Methods inherited from class org.jfree.report.expressions.AbstractExpression
getDataRow, getInstance, getName, getParentLocale, getReportConfiguration, getResourceBundleFactory, getRuntime, isDeepTraversing, isPrecompute, isPreserve, setDeepTraversing, setName, setPrecompute, setPreserve, setRuntime
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.jfree.report.expressions.Expression
getInstance, getName, isDeepTraversing, isPrecompute, isPreserve, setDeepTraversing, setName, setPrecompute, setPreserve, setRuntime
-
Constructor Details
-
FormulaFunction
public FormulaFunction()
-
-
Method Details
-
getInitial
-
getInitialExpression
-
getInitialNamespace
-
setInitial
-
getFormula
-
getFormulaNamespace
-
getFormulaExpression
-
setFormula
-
advance
When the advance method is called, the function is asked to perform the next step of its computation. The original function must not be altered during that step (or more correctly, calling advance on the original expression again must not return a different result).- Specified by:
advance
in interfaceFunction
- Returns:
- a copy of the function containing the new state.
- Throws:
DataSourceException
-
computeValue
Return the current expression value.The value depends (obviously) on the expression implementation.
- Specified by:
computeValue
in interfaceExpression
- Returns:
- the value of the function.
- Throws:
DataSourceException
-
clone
Clones the expression, expression should be reinitialized after the cloning.Expression maintain no state, cloning is done at the beginning of the report processing to disconnect the used expression from any other object space.
- Specified by:
clone
in interfaceExpression
- Overrides:
clone
in classAbstractExpression
- Returns:
- A clone of this expression.
- Throws:
CloneNotSupportedException
- this should never happen.
-
getCompiledFormula
public org.pentaho.reporting.libraries.formula.Formula getCompiledFormula() throws org.pentaho.reporting.libraries.formula.parser.ParseExceptionReturns the compiled formula. The formula is not connected to a formula context.- Returns:
- the formula.
- Throws:
org.pentaho.reporting.libraries.formula.parser.ParseException
- if the formula contains syntax errors.
-