Package org.pentaho.reporting.engine.classic.core.layout.output

Class AbstractOutputProcessor

java.lang.Object

org.pentaho.reporting.engine.classic.core.layout.output.AbstractOutputProcessor

All Implemented Interfaces:

OutputProcessor

Direct Known Subclasses:

AbstractPageableOutputProcessor, AbstractTableOutputProcessor, TemplatingOutputProcessor

public abstract class AbstractOutputProcessor
extends Object
implements OutputProcessor

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	PROCESSING_CONTENT
protected static int	PROCESSING_PAGES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOutputProcessor()

Method Summary

Modifier and Type	Method	Description
protected LogicalPageKey	createLogicalPage(int width, int height)
LogicalPageKey	getLogicalPage(int page)
int	getLogicalPageCount()
int	getPageCursor()
int	getPhysicalPageCount()
protected long	getStartTime()
protected boolean	isContentGeneratable()	This flag indicates, whether the output processor has collected enough information to start the content generation.
boolean	isNeedAlignedPage()
boolean	isPaginationFinished()	Checks whether the 'processingFinished' event had been received at least once.
void	processContent(LogicalPageBox logicalPage)	A call-back that passes a layouted pagebox to the output processor.
protected void	processingContentFinished()
void	processingFinished()	Notifies the output processor, that the processing has been finished and that the input-feed received the last event.
protected void	processingPagesFinished()
void	processingStarted(ReportDefinition report, ProcessingContext processingContext)
protected abstract void	processPageContent(LogicalPageKey logicalPageKey, LogicalPageBox logicalPage)
protected void	processPaginationContent(LogicalPageKey logicalPageKey, LogicalPageBox logicalPage)
void	processRecomputedContent(LogicalPageBox pageBox)
void	setPageCursor(int pageCursor)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pentaho.reporting.engine.classic.core.layout.output.OutputProcessor

getMetaData

Field Detail

PROCESSING_PAGES

protected static final int PROCESSING_PAGES

See Also:

Constant Field Values

PROCESSING_CONTENT

protected static final int PROCESSING_CONTENT

See Also:

Constant Field Values

Constructor Detail

AbstractOutputProcessor

protected AbstractOutputProcessor()

Method Detail

processingStarted

public void processingStarted(ReportDefinition report,
                              ProcessingContext processingContext)

Specified by:

processingStarted in interface OutputProcessor

getStartTime

protected long getStartTime()

getLogicalPageCount

public final int getLogicalPageCount()

Specified by:

getLogicalPageCount in interface OutputProcessor

getLogicalPage

public final LogicalPageKey getLogicalPage(int page)

Specified by:

getLogicalPage in interface OutputProcessor

isPaginationFinished

public final boolean isPaginationFinished()

Checks whether the 'processingFinished' event had been received at least once.

Specified by:

isPaginationFinished in interface OutputProcessor

Returns:

processingFinished

public final void processingFinished()

Notifies the output processor, that the processing has been finished and that the input-feed received the last event.

Specified by:

processingFinished in interface OutputProcessor

processingContentFinished

protected void processingContentFinished()

processingPagesFinished

protected void processingPagesFinished()

createLogicalPage

protected LogicalPageKey createLogicalPage(int width,
                                           int height)

getPageCursor

public final int getPageCursor()

Specified by:

getPageCursor in interface OutputProcessor

setPageCursor

public final void setPageCursor(int pageCursor)

Specified by:

setPageCursor in interface OutputProcessor

isContentGeneratable

protected boolean isContentGeneratable()

This flag indicates, whether the output processor has collected enough information to start the content generation.

Returns:

processRecomputedContent

public void processRecomputedContent(LogicalPageBox pageBox)
                              throws ContentProcessingException

Specified by:

processRecomputedContent in interface OutputProcessor

Throws:

ContentProcessingException

processContent

public final void processContent(LogicalPageBox logicalPage)
                          throws ContentProcessingException

Description copied from interface: OutputProcessor

A call-back that passes a layouted pagebox to the output processor.

Specified by:

processContent in interface OutputProcessor

Throws:

ContentProcessingException

isNeedAlignedPage

public boolean isNeedAlignedPage()

Specified by:

isNeedAlignedPage in interface OutputProcessor

processPaginationContent

protected void processPaginationContent(LogicalPageKey logicalPageKey,
                                        LogicalPageBox logicalPage)
                                 throws ContentProcessingException

Throws:

ContentProcessingException

processPageContent

protected abstract void processPageContent(LogicalPageKey logicalPageKey,
                                           LogicalPageBox logicalPage)
                                    throws ContentProcessingException

Throws:

ContentProcessingException

getPhysicalPageCount

public int getPhysicalPageCount()

Specified by:

getPhysicalPageCount in interface OutputProcessor