org.jfree.report.expressions

Class FormulaFunction

Implemented Interfaces:
Cloneable, Expression, Function, Serializable

public class FormulaFunction
extends AbstractExpression
implements Function

Creation-Date: 04.11.2006, 19:24:04
Author:
Thomas Morgner

Constructor Summary

FormulaFunction()

Method Summary

Function
advance()
When the advance method is called, the function is asked to perform the next step of its computation.
Object
clone()
Clones the expression, expression should be reinitialized after the cloning.
Object
computeValue()
Return the current expression value.
Formula
getCompiledFormula()
Returns the compiled formula.
String
getFormula()
String
getFormulaExpression()
String
getFormulaNamespace()
String
getInitial()
String
getInitialExpression()
String
getInitialNamespace()
void
setFormula(String formula)
void
setInitial(String initial)

Methods inherited from class org.jfree.report.expressions.AbstractExpression

clone, getDataRow, getInstance, getName, getParentLocale, getReportConfiguration, getResourceBundleFactory, getRuntime, isDeepTraversing, isPrecompute, isPreserve, setDeepTraversing, setName, setPrecompute, setPreserve, setRuntime

Constructor Details

FormulaFunction

public FormulaFunction()

Method Details

advance

public Function advance()
            throws DataSourceException
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 interface Function
Returns:
a copy of the function containing the new state.

clone

public Object clone()
            throws CloneNotSupportedException
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 interface Expression
Overrides:
clone in interface AbstractExpression
Returns:
A clone of this expression.

computeValue

public Object computeValue()
            throws DataSourceException
Return the current expression value.

The value depends (obviously) on the expression implementation.

Specified by:
computeValue in interface Expression
Returns:
the value of the function.

getCompiledFormula

public Formula getCompiledFormula()
            throws ParseException
Returns the compiled formula. The formula is not connected to a formula context.
Returns:
the formula.

getFormula

public String getFormula()

getFormulaExpression

public String getFormulaExpression()

getFormulaNamespace

public String getFormulaNamespace()

getInitial

public String getInitial()

getInitialExpression

public String getInitialExpression()

getInitialNamespace

public String getInitialNamespace()

setFormula

public void setFormula(String formula)

setInitial

public void setInitial(String initial)