org.pentaho.reporting.engine.classic.core.layout.output
Interface OutputProcessor

All Known Subinterfaces:

HtmlOutputProcessor, IterativeOutputProcessor, PageableOutputProcessor

All Known Implementing Classes:

AbstractOutputProcessor, AbstractPageableOutputProcessor, AbstractTableOutputProcessor, FlowCSVOutputProcessor, FlowExcelOutputProcessor, FlowHtmlOutputProcessor, FlowRTFOutputProcessor, GraphicsOutputProcessor, PageableCSVOutputProcessor, PageableExcelOutputProcessor, PageableHtmlOutputProcessor, PageableTextOutputProcessor, PdfOutputProcessor, StreamCSVOutputProcessor, StreamExcelOutputProcessor, StreamHtmlOutputProcessor, StreamRTFOutputProcessor, XmlPageOutputProcessor, XmlTableOutputProcessor

public interface OutputProcessor

The output-processor receives the layouted content and is responsible for translating the received content into the specific output format. The output processor also keeps track of the number of received pages and their physical layout.

Author:

Thomas Morgner

Method Summary

LogicalPageKey	getLogicalPage(int page)
int	getLogicalPageCount()
OutputProcessorMetaData	getMetaData()
int	getPageCursor()
int	getPhysicalPageCount()
boolean	isNeedAlignedPage()
boolean	isPaginationFinished() Checks whether the 'processingFinished' event had been received at least once.
void	processContent(LogicalPageBox pageBox) A call-back that passes a layouted pagebox to the output processor.
void	processingFinished() A call-back to indicate that the processing of the current process-run has been finished.
void	processRecomputedContent(LogicalPageBox pageBox)
void	setPageCursor(int pc)

Method Detail

getMetaData

OutputProcessorMetaData getMetaData()

processContent

void processContent(LogicalPageBox pageBox)
                    throws ContentProcessingException

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

Parameters:

pageBox -

Throws:

ContentProcessingException

processRecomputedContent

void processRecomputedContent(LogicalPageBox pageBox)
                              throws ContentProcessingException

Throws:

ContentProcessingException

processingFinished

void processingFinished()

A call-back to indicate that the processing of the current process-run has been finished.

getPageCursor

int getPageCursor()

setPageCursor

void setPageCursor(int pc)

getLogicalPageCount

int getLogicalPageCount()

getLogicalPage

LogicalPageKey getLogicalPage(int page)

isPaginationFinished

boolean isPaginationFinished()

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

Returns:

isNeedAlignedPage

boolean isNeedAlignedPage()

getPhysicalPageCount

int getPhysicalPageCount()