|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pentaho.reporting.engine.classic.core.function.AbstractExpression
org.pentaho.reporting.engine.classic.core.function.AbstractFunction
org.pentaho.reporting.engine.classic.core.function.FormulaFunction
public final class FormulaFunction
The formula function is a stateful version of the FormulaExpression and is used to evaluate a LibFormula/OpenFormula expression. This function can be used if a stateful evaluation is needed or if the formula value should be initialized to a certain value before the real evaluation starts.
Constructor Summary | |
---|---|
FormulaFunction()
Default Constructor. |
Method Summary | |
---|---|
Object |
clone()
Clones the expression, expression should be reinitialized after the cloning. |
String |
getFormula()
Returns the formula (incuding the optional namespace) as defined by the OpenFormula standard. |
String |
getFormulaExpression()
Returns the formula expression. |
String |
getFormulaNamespace()
Returns the formula namespace. |
String |
getInitial()
Returns the initial formula (incuding the optional namespace) as defined by the OpenFormula standard. |
String |
getInitialExpression()
Returns the initial formula expression. |
String |
getInitialNamespace()
Returns the formula namespace if the initial formula. |
Object |
getValue()
Return the computed value of the formula. |
void |
reportInitialized(ReportEvent event)
Resets the function state. |
void |
setFormula(String formula)
Defines the formula (incuding the optional namespace) as defined by the OpenFormula standard. |
void |
setInitial(String initial)
Defines the initial formula (incuding the optional namespace) as defined by the OpenFormula standard. |
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractFunction |
---|
groupFinished, groupStarted, itemsAdvanced, itemsFinished, itemsStarted, reportDone, reportFinished, reportStarted |
Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractExpression |
---|
getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setActive, setDependencyLevel, setName, setPreserve, setRuntime |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.pentaho.reporting.engine.classic.core.function.Expression |
---|
getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime |
Constructor Detail |
---|
public FormulaFunction()
Method Detail |
---|
public String getInitial()
public String getInitialExpression()
public String getInitialNamespace()
public void setInitial(String initial)
initial
- the initial formula as text.public void reportInitialized(ReportEvent event)
reportInitialized
in interface ReportListener
reportInitialized
in class AbstractFunction
event
- the report event.public String getFormula()
public String getFormulaNamespace()
public String getFormulaExpression()
public void setFormula(String formula)
formula
- the formula as text.public Object getValue()
public Object clone() throws CloneNotSupportedException
Expression maintain no state, cloning is done at the beginning of the report processing to disconnect the used expression from any other object space.
clone
in interface Expression
clone
in class AbstractExpression
CloneNotSupportedException
- this should never happen.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |