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

Class AbstractRenderer

java.lang.Object

org.pentaho.reporting.engine.classic.core.layout.AbstractRenderer

All Implemented Interfaces:

Cloneable, Renderer

Direct Known Subclasses:

FlowRenderer, PageableRenderer, StreamingRenderer

public abstract class AbstractRenderer
extends Object
implements Renderer

The LayoutSystem is a simplified version of the LibLayout-rendering system.

Author:

Thomas Morgner

Nested Class Summary

Nested classes/interfaces inherited from interface org.pentaho.reporting.engine.classic.core.layout.Renderer

Renderer.LayoutResult, Renderer.SectionType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRenderer(OutputProcessor outputProcessor)

Method Summary

Modifier and Type	Method	Description
void	add(Band band, ExpressionRuntime runtime)
void	addEmptyRootLevelBand()
void	addPagebreak()
void	addProgressBox()
void	addToNormalFlow(Band band, ExpressionRuntime runtime)
void	applyAutoCommit()
void	applyRollbackInformation()
protected void	clearDirty()
boolean	clearPendingPageStart(LayoutPagebreakHandler layoutPagebreakHandler)
Object	clone()
protected void	close()
protected RenderComponentFactory	createComponentFactory()
protected ReportRenderModelBuilder	createRenderModelBuilder()
void	createRollbackInformation()
protected void	debugPrint(LogicalPageBox pageBox)	A hook to allow easier debugging.
Renderer	deriveForPagebreak()
Renderer	deriveForStorage()
void	endGroup()
void	endGroupBody()
void	endReport()
InlineSubreportMarker[]	endSection()
void	endSubReport()
ReportStateKey	getLastStateKey()
protected OutputProcessorMetaData	getMetaData()
LayoutModelBuilder	getNormalFlowLayoutModelBuilder()
OutputProcessor	getOutputProcessor()
protected LogicalPageBox	getPageBox()
int	getPagebreaks()
int	getPageCount()
protected org.pentaho.reporting.libraries.base.util.PerformanceLoggingStopWatch	getPaginateStopWatch()
protected PerformanceMonitorContext	getPerformanceMonitorContext()
protected RenderModelBuilder	getRenderModelBuilder()
protected org.pentaho.reporting.libraries.base.util.PerformanceLoggingStopWatch	getValidateStopWatch()
protected void	initialize()
protected void	initializeRendererOnStartReport(ProcessingContext processingContext)
boolean	isCurrentPageEmpty()
boolean	isDirty()
boolean	isOpen()
protected abstract boolean	isPageFinished()
boolean	isPageStartPending()
boolean	isPendingPageHack()
boolean	isSafeToStore()
boolean	isValid()
protected boolean	isWidowOrphanDefinitionsEncountered()
protected void	markDirty()
void	newPageStarted()
protected abstract boolean	performPagination(LayoutPagebreakHandler handler, boolean performOutput)
void	performParanoidModelCheck()
protected boolean	preparePagination(LogicalPageBox pageBox)
void	print()
void	printLayoutStateToFile(ProcessState state, boolean print, boolean rollback)	This is a debug helper function.
void	processIncrementalUpdate(boolean performOutput)
boolean	processPage(LayoutPagebreakHandler handler, Object commitMarker, boolean performOutput)
void	rollback()
protected void	setLastStateKey(ReportStateKey lastStateKey)
protected void	setPagebreaks(int pagebreaks)
void	setStateKey(ReportStateKey stateKey)
void	startGroup(Group group, Integer predictedStateCount)
void	startGroupBody(GroupBody groupBody, Integer predictedStateCount)
void	startReport(ReportDefinition report, ProcessingContext processingContext, PerformanceMonitorContext performanceMonitorContext)
void	startSection(Renderer.SectionType type)
void	startSubReport(ReportDefinition report, InstanceID insertationPoint)
void	validateAfterCommit()
Renderer.LayoutResult	validatePages()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRenderer

protected AbstractRenderer(OutputProcessor outputProcessor)

Method Detail

initialize

protected void initialize()

createRenderModelBuilder

protected ReportRenderModelBuilder createRenderModelBuilder()

createComponentFactory

protected RenderComponentFactory createComponentFactory()

getNormalFlowLayoutModelBuilder

public LayoutModelBuilder getNormalFlowLayoutModelBuilder()

Specified by:

getNormalFlowLayoutModelBuilder in interface Renderer

getPageCount

public int getPageCount()

Specified by:

getPageCount in interface Renderer

getRenderModelBuilder

protected RenderModelBuilder getRenderModelBuilder()

getPageBox

protected LogicalPageBox getPageBox()

isSafeToStore

public boolean isSafeToStore()

Specified by:

isSafeToStore in interface Renderer

getMetaData

protected OutputProcessorMetaData getMetaData()

setStateKey

public void setStateKey(ReportStateKey stateKey)

Specified by:

setStateKey in interface Renderer

getOutputProcessor

public OutputProcessor getOutputProcessor()

Specified by:

getOutputProcessor in interface Renderer

isWidowOrphanDefinitionsEncountered

protected boolean isWidowOrphanDefinitionsEncountered()

startReport

public void startReport(ReportDefinition report,
                        ProcessingContext processingContext,
                        PerformanceMonitorContext performanceMonitorContext)

Specified by:

startReport in interface Renderer

initializeRendererOnStartReport

protected void initializeRendererOnStartReport(ProcessingContext processingContext)

startSubReport

public void startSubReport(ReportDefinition report,
                           InstanceID insertationPoint)

Specified by:

startSubReport in interface Renderer

startGroup

public void startGroup(Group group,
                       Integer predictedStateCount)

Specified by:

startGroup in interface Renderer

startGroupBody

public void startGroupBody(GroupBody groupBody,
                           Integer predictedStateCount)

Specified by:

startGroupBody in interface Renderer

startSection

public void startSection(Renderer.SectionType type)

Specified by:

startSection in interface Renderer

endSection

public InlineSubreportMarker[] endSection()

Specified by:

endSection in interface Renderer

endGroupBody

public void endGroupBody()

Specified by:

endGroupBody in interface Renderer

endGroup

public void endGroup()

Specified by:

endGroup in interface Renderer

endSubReport

public void endSubReport()

Specified by:

endSubReport in interface Renderer

endReport

public void endReport()

Specified by:

endReport in interface Renderer

addEmptyRootLevelBand

public void addEmptyRootLevelBand()
                           throws ReportProcessingException

Specified by:

addEmptyRootLevelBand in interface Renderer

Throws:

ReportProcessingException

addProgressBox

public void addProgressBox()
                    throws ReportProcessingException

Specified by:

addProgressBox in interface Renderer

Throws:

ReportProcessingException

add

public void add(Band band,
                ExpressionRuntime runtime)
         throws ReportProcessingException

Specified by:

add in interface Renderer

Throws:

ReportProcessingException

addToNormalFlow

public void addToNormalFlow(Band band,
                            ExpressionRuntime runtime)
                     throws ReportProcessingException

Throws:

ReportProcessingException

validatePages

public Renderer.LayoutResult validatePages()
                                    throws ContentProcessingException

Specified by:

validatePages in interface Renderer

Throws:

ContentProcessingException

preparePagination

protected boolean preparePagination(LogicalPageBox pageBox)

clearDirty

protected void clearDirty()

isPageFinished

protected abstract boolean isPageFinished()

processIncrementalUpdate

public void processIncrementalUpdate(boolean performOutput)
                              throws ContentProcessingException

Specified by:

processIncrementalUpdate in interface Renderer

Throws:

ContentProcessingException

processPage

public boolean processPage(LayoutPagebreakHandler handler,
                           Object commitMarker,
                           boolean performOutput)
                    throws ContentProcessingException

Specified by:

processPage in interface Renderer

Throws:

ContentProcessingException

performPagination

protected abstract boolean performPagination(LayoutPagebreakHandler handler,
                                             boolean performOutput)
                                      throws ContentProcessingException

Throws:

ContentProcessingException

debugPrint

protected void debugPrint(LogicalPageBox pageBox)

A hook to allow easier debugging.

Parameters:

pageBox - the current page box.

getLastStateKey

public ReportStateKey getLastStateKey()

Specified by:

getLastStateKey in interface Renderer

setLastStateKey

protected void setLastStateKey(ReportStateKey lastStateKey)

setPagebreaks

protected void setPagebreaks(int pagebreaks)

getPagebreaks

public int getPagebreaks()

Specified by:

getPagebreaks in interface Renderer

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Renderer

isValid

public boolean isValid()

Specified by:

isValid in interface Renderer

deriveForStorage

public Renderer deriveForStorage()

Specified by:

deriveForStorage in interface Renderer

deriveForPagebreak

public Renderer deriveForPagebreak()

Specified by:

deriveForPagebreak in interface Renderer

performParanoidModelCheck

public void performParanoidModelCheck()

clone

public Object clone()
             throws CloneNotSupportedException

Specified by:

clone in interface Renderer

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

addPagebreak

public void addPagebreak()

Specified by:

addPagebreak in interface Renderer

clearPendingPageStart

public boolean clearPendingPageStart(LayoutPagebreakHandler layoutPagebreakHandler)

Specified by:

clearPendingPageStart in interface Renderer

isCurrentPageEmpty

public boolean isCurrentPageEmpty()

Specified by:

isCurrentPageEmpty in interface Renderer

isPageStartPending

public boolean isPageStartPending()

Specified by:

isPageStartPending in interface Renderer

isDirty

public boolean isDirty()

createRollbackInformation

public void createRollbackInformation()

Specified by:

createRollbackInformation in interface Renderer

applyRollbackInformation

public void applyRollbackInformation()

Specified by:

applyRollbackInformation in interface Renderer

validateAfterCommit

public void validateAfterCommit()

rollback

public void rollback()

Specified by:

rollback in interface Renderer

applyAutoCommit

public void applyAutoCommit()

Specified by:

applyAutoCommit in interface Renderer

isPendingPageHack

public boolean isPendingPageHack()

Specified by:

isPendingPageHack in interface Renderer

markDirty

protected void markDirty()

print

public void print()

Specified by:

print in interface Renderer

newPageStarted

public void newPageStarted()

Specified by:

newPageStarted in interface Renderer

printLayoutStateToFile

public void printLayoutStateToFile(ProcessState state,
                                   boolean print,
                                   boolean rollback)

This is a debug helper function. It is not used in normal report runs. It helps debug layouter states and the roll-back system by dumping all layouts into a directory on the file system for automated diffs.

Parameters:

state -

print -

rollback -

getValidateStopWatch

protected org.pentaho.reporting.libraries.base.util.PerformanceLoggingStopWatch getValidateStopWatch()

getPaginateStopWatch

protected org.pentaho.reporting.libraries.base.util.PerformanceLoggingStopWatch getPaginateStopWatch()

getPerformanceMonitorContext

protected PerformanceMonitorContext getPerformanceMonitorContext()

close

protected void close()