Package org.pentaho.reporting.engine.classic.core.function

Class AbstractFunction

java.lang.Object

org.pentaho.reporting.engine.classic.core.function.AbstractExpression

org.pentaho.reporting.engine.classic.core.function.AbstractFunction

All Implemented Interfaces:

Serializable, Cloneable, EventListener, ReportListener, Expression, Function

Direct Known Subclasses:

AbstractElementFormatFunction, CountDistinctFunction, CreateGroupAnchorsFunction, CrosstabColumnSequenceFunction, CrosstabProcessorFunction, CSVWriter, DefaultOutputFunction, ElementVisibilitySwitchFunction, EventMonitorFunction, FastExportOutputFunction, FormulaFunction, GroupCountFunction, HidePageBandForTableExportFunction, ItemAvgFunction, ItemCountFunction, ItemHideFunction, ItemMaxFunction, ItemMinFunction, ItemPercentageFunction, ItemSumFunction, PageFunction, PaintComponentFunction, PaintDynamicComponentFunction, RowBandingFunction, TotalCalculationFunction, TotalGroupSumFunction, TotalGroupSumQuotientFunction, TotalItemCountFunction, TotalItemMaxFunction, TotalItemMinFunction, TriggerPageFooterFunction, XMLWriter

public abstract class AbstractFunction
extends AbstractExpression
implements Function

Base class for implementing new report functions. Provides empty implementations of all the methods in the Function interface.

Author:

Thomas Morgner

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFunction()	Creates an unnamed function.
protected	AbstractFunction(String name)	Creates an named function.

Method Summary

Modifier and Type	Method	Description
void	groupFinished(ReportEvent event)	Receives notification that a group has finished.
void	groupStarted(ReportEvent event)	Receives notification that a group has started.
void	itemsAdvanced(ReportEvent event)	Receives notification that a row of data is being processed.
void	itemsFinished(ReportEvent event)	Receives notification that a group of item bands has been completed.
void	itemsStarted(ReportEvent event)	Receives notification that a group of item bands is about to be processed.
void	reportDone(ReportEvent event)	Receives notification that report generation has completed, the report footer was printed, no more output is done.
void	reportFinished(ReportEvent event)	Receives notification that the report has finished.
void	reportInitialized(ReportEvent event)	Receives notification that report generation initializes the current run.
void	reportStarted(ReportEvent event)	Receives notification that the report has started.
void	summaryRowSelection(ReportEvent event)	A crosstab specific event notifying crosstab-aware functions to select the result for the summary row cell that will be printed next.

Methods inherited from class org.pentaho.reporting.engine.classic.core.function.AbstractExpression

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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

AbstractFunction

protected AbstractFunction()

Creates an unnamed function. Make sure the name of the function is set using AbstractExpression.setName(java.lang.String) before the function is added to the report's function collection.

AbstractFunction

protected AbstractFunction(String name)

Creates an named function.

Parameters:

name - the name of the function.

Method Detail

reportInitialized

public void reportInitialized(ReportEvent event)

Receives notification that report generation initializes the current run.

The event carries a ReportState.Started state. Use this to initialize the report.

Specified by:

reportInitialized in interface ReportListener

Parameters:

event - The event.

reportStarted

public void reportStarted(ReportEvent event)

Receives notification that the report has started.

Specified by:

reportStarted in interface ReportListener

Parameters:

event - the event.

reportFinished

public void reportFinished(ReportEvent event)

Receives notification that the report has finished.

Specified by:

reportFinished in interface ReportListener

Parameters:

event - the event.

groupStarted

public void groupStarted(ReportEvent event)

Receives notification that a group has started.

Specified by:

groupStarted in interface ReportListener

Parameters:

event - the event.

groupFinished

public void groupFinished(ReportEvent event)

Receives notification that a group has finished.

Specified by:

groupFinished in interface ReportListener

Parameters:

event - the event.

itemsAdvanced

public void itemsAdvanced(ReportEvent event)

Receives notification that a row of data is being processed.

Specified by:

itemsAdvanced in interface ReportListener

Parameters:

event - the event.

itemsStarted

public void itemsStarted(ReportEvent event)

Receives notification that a group of item bands is about to be processed.

The next events will be itemsAdvanced events until the itemsFinished event is raised.

Specified by:

itemsStarted in interface ReportListener

Parameters:

event - The event.

itemsFinished

public void itemsFinished(ReportEvent event)

Receives notification that a group of item bands has been completed.

The itemBand is finished, the report starts to close open groups.

Specified by:

itemsFinished in interface ReportListener

Parameters:

event - The event.

reportDone

public void reportDone(ReportEvent event)

Receives notification that report generation has completed, the report footer was printed, no more output is done. This is a helper event to shut down the output service.

Specified by:

reportDone in interface ReportListener

Parameters:

event - The event.

summaryRowSelection

public void summaryRowSelection(ReportEvent event)

A crosstab specific event notifying crosstab-aware functions to select the result for the summary row cell that will be printed next.

Specified by:

summaryRowSelection in interface ReportListener

Parameters:

event - The report event.