org.pentaho.reporting.engine.classic.core.function
Interface Function

All Superinterfaces:

Cloneable, EventListener, Expression, ReportListener, Serializable

All Known Subinterfaces:

AggregationFunction, FieldAggregationFunction, LayoutProcessorFunction, OutputFunction, StructureFunction

All Known Implementing Classes:

AbstractElementFormatFunction, AbstractFunction, AttributeExpressionsEvaluator, CellFormatFunction, ConditionalItemSumFunction, CountDistinctFunction, CreateGroupAnchorsFunction, CreateHyperLinksFunction, CrosstabProcessorFunction, CSVWriter, DefaultOutputFunction, ElementColorFunction, ElementTrafficLightFunction, ElementVisibilityFunction, ElementVisibilitySwitchFunction, EventMonitorFunction, FormulaFunction, GroupCountFunction, HideElementByNameFunction, HideElementIfDataAvailableExpression, HideNullValuesFunction, HidePageBandForTableExportFunction, ItemAvgFunction, ItemCountFunction, ItemHideFunction, ItemMaxFunction, ItemMinFunction, ItemPercentageFunction, ItemSumFunction, MetaDataStyleEvaluator, NegativeNumberPaintChangeFunction, PageFunction, PageItemCountFunction, PageItemSumFunction, PageOfPagesFunction, PageTotalFunction, PaintComponentFunction, PaintDynamicComponentFunction, RowBandingFunction, SheetNameFunction, ShowElementByNameFunction, ShowElementIfDataAvailableExpression, SingleValueQueryFunction, StyleExpressionsEvaluator, TotalCalculationFunction, TotalGroupCountFunction, TotalGroupSumFunction, TotalGroupSumQuotientFunction, TotalGroupSumQuotientPercentFunction, TotalItemCountFunction, TotalItemMaxFunction, TotalItemMinFunction, TotalPageItemCountFunction, TriggerPageFooterFunction, WizardItemHideFunction, XMLWriter

public interface Function
extends ReportListener, Expression

The interface for report functions. A report function separates the business logic from presentation of the result. The function is called whenever JFreeReport changes its state while generating the report. The working model for the functions is based on cloning the state of the function on certain checkpoints to support the ReportState implementation of JFreeReport.

Although functions support the ReportListener interface, they are not directly added to a report. A report FunctionCollection is used to control the functions. Functions are required to be cloneable.

Author:

Thomas Morgner

Method Summary

Methods inherited from interface org.pentaho.reporting.engine.classic.core.event.ReportListener

groupFinished, groupStarted, itemsAdvanced, itemsFinished, itemsStarted, reportDone, reportFinished, reportInitialized, reportStarted

Methods inherited from interface org.pentaho.reporting.engine.classic.core.function.Expression

clone, getDataRow, getDependencyLevel, getInstance, getName, getReportConfiguration, getResourceBundleFactory, getRuntime, getValue, isActive, isDeepTraversing, isPreserve, setDependencyLevel, setName, setRuntime