| org.jfree.report.function.Expression
All known Subclasses: org.jfree.report.function.AbstractExpression,
| Expression | | public interface Expression extends Cloneable(Code) | | An expression is a lightweight function that does not maintain a state. Expressions are used to calculate values
within a single row of a report. Expressions can use a dataRow to access other fields, expressions or functions
within the current row in the report.
author:
Thomas Morgner |
| clone | | public Object clone() throws CloneNotSupportedException(Code) | | 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.
A clone of this expression.
throws:
CloneNotSupportedException - this should never happen. |
| getDataRow | | public DataRow getDataRow()(Code) | | Returns the DataRow used in this expression. The dataRow is set when the report processing starts and can be used
to access the values of functions, expressions and the reports datasource.
the assigned DataRow for this report processing. |
| getDependencyLevel | | public int getDependencyLevel()(Code) | | The dependency level defines the level of execution for this function. Higher dependency functions are executed
before lower dependency functions. For ordinary functions and expressions, the range for dependencies is defined to
start from 0 (lowest dependency possible) to 2^31 (upper limit of int).
Levels below 0 are reserved for system-functionality (printing and layouting).
The level must not change during the report processing, or the result is invalid.
the level. |
| getInstance | | public Expression getInstance()(Code) | | Return a new instance of this expression. The copy is initialized and uses the same parameters as the original, but
does not share any objects.
a copy of this function. |
| getName | | public String getName()(Code) | | Returns the name of the expression.
Every expression, function and column in the datamodel within a report is required to have a unique name.
the function name. |
| getReportConfiguration | | public Configuration getReportConfiguration()(Code) | | Returns the report's current configuration.
the configuration of the report. |
| getResourceBundleFactory | | public ResourceBundleFactory getResourceBundleFactory()(Code) | | Returns the resource-bundle factory of the report. This factory encapsulates the Locale and allows to create a
resource-bundle in a implementation-independent way.
the resource-bundle factory. |
| getRuntime | | public ExpressionRuntime getRuntime()(Code) | | Retrieves the runtime instance.
the runtime, can be null, if the expression is abused outside of the report processing. |
| getValue | | public Object getValue()(Code) | | Return the current expression value.
The value depends (obviously) on the expression implementation.
the value of the function. |
| isActive | | public boolean isActive()(Code) | | Returns true if this expression contains autoactive content and should be called by the system, regardless whether
this expression is referenced in the datarow.
true, if the expression is activated automaticly, false otherwise. |
| isDeepTraversing | | public boolean isDeepTraversing()(Code) | | Checks, whether this expression is a deep-traversing expression. Deep-traversing expressions receive events from
all sub-reports.
the deep-traversing flag. |
| 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. |
| setDependencyLevel | | public void setDependencyLevel(int level)(Code) | | Sets the dependency level for the expression.
Parameters:
level - the level. |
| setName | | public void setName(String name)(Code) | | Sets the name of the expression.
The name must not be null and must be unique within the expression group.
Parameters:
name - the name. |
| setRuntime | | public void setRuntime(ExpressionRuntime runtime)(Code) | | Defines the DataRow used in this expression. The dataRow is set when the report processing starts and can be used
to access the values of functions, expressions and the reports datasource.
Parameters:
runtime - the runtime information for the expression |
|
|