org.jfree.report.function: public interface: Expression

org.jfree.report.function
public interface: Expression [javadoc | source]

All Implemented Interfaces:
Cloneable

All Known Implementing Classes:
ConvertToDateExpression, PaintDynamicComponentFunction, PercentageExpression, ToUpperCaseStringExpression, IsEmptyExpression, HideArticleDetailsFunction, ColumnAverageExpression, AverageExpression, ItemSumFunction, ShowElementByNameFunction, AttributeExpressionsEvaluator, DateExpression, BSHExpression, CapitalizeStringExpression, ResourceMesssageFormatExpression, ComplexComponentExpression, ElementTrafficLightFunction, TriggerTypeFunction, HidePageBandForTableExportFunction, ItemMinFunction, CellFormatFunction, ElementColorFunction, DataSchemaFormatFunction, PageFunction, IsExportTypeExpression, PaintComponentFunction, CSVWriter, HideElementIfDataAvailableExpression, SubStringExpression, AbstractElementFormatFunction, AbstractCompareExpression, ColumnSumExpression, ItemMaxFunction, GetDataRowValueExpression, MetaDataStyleEvaluator, AndExpression, FlowPageLayouter, EventMonitorFunction, MapStringExpression, IsNullExpression, XMLWriter, SelectCardFunction, TotalGroupSumQuotientPercentFunction, StructureFunction, TriggerPageFooterFunction, GroupCountFunction, ItemColumnQuotientExpression, ColumnAggregationExpression, TotalPageItemCountFunction, ItemPercentageFunction, SurveyScaleExpression, TotalItemCountFunction, IsNegativeExpression, SimplePageLayouter, CompareNumberExpression, TriggerNestedGroupFunction, TriggerComplexPageFooterFunction, ColumnMaximumExpression, DateCutExpression, ConvertToNumberExpression, ColumnMinimumExpression, ShowElementIfDataAvailableExpression, TotalGroupCountFunction, FormulaFunction, ColumnMultiplyExpression, PageLayouter, TotalCalculationFunction, URLEncodeExpression, TotalGroupSumFunction, Function, TotalItemMaxFunction, TotalGroupSumQuotientFunction, IsPositiveExpression, FontChangeFunction, HideNullValuesFunction, MapIndirectExpression, CountDistinctFunction, HideElementByNameFunction, CompareFieldsExpression, LayoutProcessorFunction, ItemCountFunction, TotalItemMinFunction, TokenizeStringExpression, StyleExpressionsEvaluator, PageItemSumFunction, DefaultOutputFunction, NettoProfitFunction, SheetNameFunction, CompareStringExpression, VariableDateExpression, CompareDateExpression, ItemHideFunction, PageTotalFunction, ResourceBundleLookupExpression, OrExpression, ColumnDifferenceExpression, ElementVisibilitySwitchFunction, AbstractFunction, PageItemCountFunction, TableWriter, MessageFormatExpression, NegativeNumberPaintChangeFunction, ItemAvgFunction, ColumnDivisionExpression, CreateHyperLinksFunction, TextFormatExpression, FormulaExpression, ElementVisibilityFunction, SingleValueQueryFunction, ImageRenderFunction, CreateGroupAnchorsFunction, BSFExpression, PageOfPagesFunction, IsEmptyDataExpression, OutputFunction, AbstractExpression, ToLowerCaseStringExpression, DateSpanExpression, ConditionalItemSumFunction, RowBandingFunction

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

Method from org.jfree.report.function.Expression Summary:
clone, getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, getValue, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime

Method from org.jfree.report.function.Expression Detail:
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.
public DataRow getDataRow() 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.
public int getDependencyLevel() 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.
public Expression getInstance() 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.
public String getName() Returns the name of the expression. Every expression, function and column in the datamodel within a report is required to have a unique name.
public Configuration getReportConfiguration() Returns the report's current configuration.
public ResourceBundleFactory getResourceBundleFactory() 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.
public ExpressionRuntime getRuntime() Retrieves the runtime instance.
public Object getValue() Return the current expression value. The value depends (obviously) on the expression implementation.
public boolean isActive()Deprecated! `The` - Active-Flag is no longer evaluated. We always assume it to be true. Returns true if this expression contains autoactive content and should be called by the system, regardless whether this expression is referenced in the datarow.
public boolean isDeepTraversing() Checks whether this expression is a deep-traversing expression. Deep-traversing expressions receive events from all sub-reports.
public boolean isPreserve() Checks whether this expression's last value is preserved after the expression goes out of scope.
public void setDependencyLevel(int level) Sets the dependency level for the expression.
public void setName(String name) Sets the name of the expression. The name must not be null and must be unique within the expression group.
public void setRuntime(ExpressionRuntime runtime) 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.