| java.lang.Object
 org.jfree.report.function.AbstractExpression
All known Subclasses: org.jfree.report.function.strings.MapStringExpression, org.pentaho.plugin.jfreereport.reportcharts.AbstractChartExpression, org.jfree.report.function.IsEmptyExpression, org.jfree.report.function.strings.CapitalizeStringExpression, org.jfree.report.function.strings.ResourceMesssageFormatExpression, org.jfree.report.modules.misc.beanshell.BSHExpression, org.jfree.report.function.PercentageExpression, org.jfree.report.function.strings.TokenizeStringExpression, org.jfree.report.function.FormulaExpression, org.jfree.report.function.AbstractCompareExpression, org.jfree.report.function.date.DateSpanExpression, org.jfree.report.function.sys.IsExportTypeExpression, org.jfree.report.function.DateCutExpression, org.jfree.report.function.strings.MapIndirectExpression, org.jfree.report.function.ColumnAggregationExpression, org.jfree.report.function.strings.ResourceBundleLookupExpression, org.jfree.report.function.IsNullExpression, org.jfree.report.function.numeric.IsPositiveExpression, org.jfree.report.function.strings.ToUpperCaseStringExpression, org.jfree.report.modules.misc.bsf.BSFExpression, org.jfree.report.function.ConvertToNumberExpression, org.jfree.report.function.strings.URLEncodeExpression, org.jfree.report.function.strings.ToLowerCaseStringExpression, org.jfree.report.function.TextFormatExpression, org.jfree.report.function.bool.IsEmptyDataExpression, org.jfree.report.function.numeric.IsNegativeExpression, org.jfree.report.function.AbstractFunction, org.jfree.report.function.strings.SubStringExpression, org.jfree.report.function.date.DateExpression, org.jfree.report.function.AverageExpression, org.jfree.report.function.ConvertToDateExpression, org.jfree.report.function.strings.MessageFormatExpression,
| AbstractExpression | | abstract public class AbstractExpression implements Expression,Serializable(Code) | | An abstract base class for implementing new report expressions.
Expressions are stateless functions which have access to the report's
DataRow . All expressions are named and
the defined names have to be unique within the report's expressions, functions and fields of the datasource.
Expressions are configured using properties.
author:
Thomas Morgner |
| Method Summary | |
| public Object | clone()
Clones the expression. | | public DataRow | getDataRow()
Returns the current
DataRow . | | public int | getDependencyLevel()
Returns the dependency level for the expression (controls evaluation order for expressions and functions). | | public Expression | getInstance()
Return a completly separated copy of this function. | | public String | getName()
Returns the name of the expression. | | public Configuration | getReportConfiguration()
| | public ResourceBundleFactory | getResourceBundleFactory()
| | public ExpressionRuntime | getRuntime()
Returns the ExpressionRune used in this expression. | | final public boolean | isActive()
Returns true if this expression contains "auto-active" content and should be called by the system
regardless of whether this expression is referenced in the
DataRow . | | public boolean | isDeepTraversing()
Checks, whether this expression is a deep-traversing expression. | | public boolean | isPreserve()
Checks, whether this expression's last value is preserved after the expression goes out of scope. | | final public void | setActive(boolean active)
Defines, whether the expression is an active expression. | | public void | setDependencyLevel(int level)
Sets the dependency level for the expression.
The dependency level controls the order of evaluation for expressions and functions. | | public void | setName(String name)
Sets the name of the expression. | | public void | setPreserve(boolean preserve)
Defines, whether this expression's last value is preserved after the expression goes out of scope. | | public void | setRuntime(ExpressionRuntime runtime)
Defines the ExpressionRune used in this expression. |
| AbstractExpression | | protected AbstractExpression()(Code) | | Creates an unnamed expression. Make sure the name of the expression is set using
AbstractExpression.setName before the
expression is added to the report's expression collection.
|
| clone | | public Object clone() throws CloneNotSupportedException(Code) | | Clones the expression. The expression should be reinitialized after the cloning. Expressions maintain no
state, cloning is done at the beginning of the report processing to disconnect the expression from any other object
space.
a clone of this expression.
throws:
CloneNotSupportedException - this should never happen. |
| getDependencyLevel | | public int getDependencyLevel()(Code) | | Returns the dependency level for the expression (controls evaluation order for expressions and functions).
the level. |
| getInstance | | public Expression getInstance()(Code) | | Return a completly separated copy of this function. The copy does no longer share any changeable objects with the
original function.
a copy of this function. |
| getName | | public String getName()(Code) | | Returns the name of the expression.
the name. |
| getReportConfiguration | | public Configuration getReportConfiguration()(Code) | | |
| getRuntime | | public ExpressionRuntime getRuntime()(Code) | | Returns the ExpressionRune used in this expression. The ExpressionRuntime is set before the expression
receives events or gets evaluated and is unset afterwards. Do not hold references on the runtime or you
will create memory-leaks.
the runtime information for the expression |
| isActive | | final public boolean isActive()(Code) | | Returns true if this expression contains "auto-active" content and should be called by the system
regardless of whether this expression is referenced in the
DataRow .
true as all expressions are always evaluated now. |
| isDeepTraversing | | public boolean isDeepTraversing()(Code) | | Checks, whether this expression is a deep-traversing expression. Deep-traversing expressions receive
events from all sub-reports. This returns false by default, as ordinary expressions have no need to be
deep-traversing.
false. |
| isPreserve | | public boolean isPreserve()(Code) | | Checks, whether this expression's last value is preserved after the expression goes out of scope.
true, if the expression's last value is preserved, false otherwise. |
| setActive | | final public void setActive(boolean active)(Code) | | Defines, whether the expression is an active expression. This method has no effect anymore.
Parameters:
active - a flag. |
| setDependencyLevel | | public void setDependencyLevel(int level)(Code) | | Sets the dependency level for the expression.
The dependency level controls the order of evaluation for expressions and functions. Higher level expressions are
evaluated before lower level expressions. Any level in the range 0 to Integer.MAX_VALUE is allowed. Negative
values are reserved for system functions (printing and layouting).
Parameters:
level - the level (must be greater than or equal to 0). |
| setName | | public void setName(String name)(Code) | | Sets the name of the expression. The name should be unique among: - the functions and expressions for
the report;
- the columns in the report's
TableModel; This allows the expression to be
referenced by name from any report element.
You should not change the name of an expression once it has been added to the report's expression collection.
Parameters:
name - the name (null not permitted). |
| setPreserve | | public void setPreserve(boolean preserve)(Code) | | Defines, whether this expression's last value is preserved after the expression goes out of scope.
Parameters:
preserve - true, if the expression's last value is preserved, false otherwise. |
| setRuntime | | public void setRuntime(ExpressionRuntime runtime)(Code) | | Defines the ExpressionRune used in this expression. The ExpressionRuntime is set before the expression
receives events or gets evaluated and is unset afterwards. Do not hold references on the runtime or you
will create memory-leaks.
Parameters:
runtime - the runtime information for the expression |
|
|