Package org.pentaho.reporting.engine.classic.core.modules.output.fast

Class FastExportOutputFunction

java.lang.Object

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

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

org.pentaho.reporting.engine.classic.core.modules.output.fast.FastExportOutputFunction

All Implemented Interfaces:

Serializable, Cloneable, EventListener, ReportListener, Expression, Function, OutputFunction

public class FastExportOutputFunction
extends AbstractFunction
implements OutputFunction

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
FastExportOutputFunction(FastExportTemplate template)

Method Summary

Modifier and Type	Method	Description
void	clearInlineSubreports(SubReportProcessType processType)
FastExportOutputFunction	clone()	Clones the expression.
boolean	createRollbackInformation()
OutputFunction	deriveForPagebreak()	Creates a cheaper version of the deep-copy of the output function.
OutputFunction	deriveForStorage()	Creates a storage-copy of the output function.
InlineSubreportMarker[]	getInlineSubreports()
Object	getValue()	Return the current expression value.
void	groupBodyFinished(ReportEvent event)
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	restart(ReportState state)

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

summaryRowSelection

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

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

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

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

summaryRowSelection

Constructor Detail

FastExportOutputFunction

public FastExportOutputFunction(FastExportTemplate template)

Method Detail

reportInitialized

public void reportInitialized(ReportEvent event)

Description copied from class: AbstractFunction

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

Overrides:

reportInitialized in class AbstractFunction

Parameters:

event - The event.

reportStarted

public void reportStarted(ReportEvent event)

Description copied from class: AbstractFunction

Receives notification that the report has started.

Specified by:

reportStarted in interface ReportListener

Overrides:

reportStarted in class AbstractFunction

Parameters:

event - the event.

reportFinished

public void reportFinished(ReportEvent event)

Description copied from class: AbstractFunction

Receives notification that the report has finished.

Specified by:

reportFinished in interface ReportListener

Overrides:

reportFinished in class AbstractFunction

Parameters:

event - the event.

reportDone

public void reportDone(ReportEvent event)

Description copied from class: AbstractFunction

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

Overrides:

reportDone in class AbstractFunction

Parameters:

event - The event.

groupStarted

public void groupStarted(ReportEvent event)

Description copied from class: AbstractFunction

Receives notification that a group has started.

Specified by:

groupStarted in interface ReportListener

Overrides:

groupStarted in class AbstractFunction

Parameters:

event - the event.

groupFinished

public void groupFinished(ReportEvent event)

Description copied from class: AbstractFunction

Receives notification that a group has finished.

Specified by:

groupFinished in interface ReportListener

Overrides:

groupFinished in class AbstractFunction

Parameters:

event - the event.

itemsAdvanced

public void itemsAdvanced(ReportEvent event)

Description copied from class: AbstractFunction

Receives notification that a row of data is being processed.

Specified by:

itemsAdvanced in interface ReportListener

Overrides:

itemsAdvanced in class AbstractFunction

Parameters:

event - the event.

itemsStarted

public void itemsStarted(ReportEvent event)

Description copied from class: AbstractFunction

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

Overrides:

itemsStarted in class AbstractFunction

Parameters:

event - The event.

itemsFinished

public void itemsFinished(ReportEvent event)

Description copied from class: AbstractFunction

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

Overrides:

itemsFinished in class AbstractFunction

Parameters:

event - The event.

deriveForStorage

public OutputFunction deriveForStorage()

Description copied from interface: OutputFunction

Creates a storage-copy of the output function. A storage copy must create a deep clone of all referenced objects so that it is guaranteed that changes to either the original or the clone do not affect the other instance.

Any failure to implement this method correctly will be a great source of very subtle bugs.

Specified by:

deriveForStorage in interface OutputFunction

Returns:

the deep clone.

deriveForPagebreak

public OutputFunction deriveForPagebreak()

Description copied from interface: OutputFunction

Creates a cheaper version of the deep-copy of the output function. A pagebreak-derivate is created on every possible pagebreak position and must contain all undo/rollback information to restore the state of any shared object when a roll-back is requested.

Any failure to implement this method correctly will be a great source of very subtle bugs.

Specified by:

deriveForPagebreak in interface OutputFunction

Returns:

the deep clone.

clone

public FastExportOutputFunction clone()

Description copied from class: AbstractExpression

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.

Specified by:

clone in interface Expression

Overrides:

clone in class AbstractExpression

Returns:

a clone of this expression.

getInlineSubreports

public InlineSubreportMarker[] getInlineSubreports()

Specified by:

getInlineSubreports in interface OutputFunction

clearInlineSubreports

public void clearInlineSubreports(SubReportProcessType processType)

Specified by:

clearInlineSubreports in interface OutputFunction

restart

public void restart(ReportState state)
             throws ReportProcessingException

Specified by:

restart in interface OutputFunction

Throws:

ReportProcessingException

createRollbackInformation

public boolean createRollbackInformation()

Specified by:

createRollbackInformation in interface OutputFunction

groupBodyFinished

public void groupBodyFinished(ReportEvent event)

Specified by:

groupBodyFinished in interface OutputFunction

getValue

public Object getValue()

Description copied from interface: Expression

Return the current expression value.

The value depends (obviously) on the expression implementation.

Specified by:

getValue in interface Expression

Returns:

the value of the function.