org.pentaho.reporting.engine.classic.core.layout.output
Class AbstractReportProcessor

java.lang.Object
  extended by org.pentaho.reporting.engine.classic.core.layout.output.AbstractReportProcessor
All Implemented Interfaces:
ReportProcessor
Direct Known Subclasses:
CSVProcessor, FlowReportProcessor, PageableReportProcessor, StreamReportProcessor, XMLProcessor

public abstract class AbstractReportProcessor
extends Object
implements ReportProcessor

Creation-Date: 08.04.2007, 14:52:52

Author:
Thomas Morgner

Method Summary
 void addReportProgressListener(ReportProgressListener l)
          Adds a repagination listener.
 void close()
           
 org.pentaho.reporting.libraries.base.config.Configuration getConfiguration()
           
 int getLogicalPageCount()
           
 OutputProcessor getOutputProcessor()
           
 int getPhysicalPageCount()
           
 boolean isFullStreamingProcessor()
           
 boolean isHandleInterruptedState()
          Returns whether the processor should check the threads interrupted state.
 boolean isPaginated()
           
 boolean paginate()
           
 PageState processPage(PageState pageState, boolean performOutput)
           
 void processReport()
           
 void removeReportProgressListener(ReportProgressListener l)
          Removes a repagination listener.
 void setFullStreamingProcessor(boolean fullStreamingProcessor)
           
 void setHandleInterruptedState(boolean handleInterruptedState)
          Defines, whether the processor should check the threads interrupted state.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getOutputProcessor

public OutputProcessor getOutputProcessor()

addReportProgressListener

public void addReportProgressListener(ReportProgressListener l)
Adds a repagination listener. This listener will be informed of pagination events.

Specified by:
addReportProgressListener in interface ReportProcessor
Parameters:
l - the listener.

removeReportProgressListener

public void removeReportProgressListener(ReportProgressListener l)
Removes a repagination listener.

Specified by:
removeReportProgressListener in interface ReportProcessor
Parameters:
l - the listener.

isHandleInterruptedState

public boolean isHandleInterruptedState()
Returns whether the processor should check the threads interrupted state. If this is set to true and the thread was interrupted, then the report processing is aborted.

Specified by:
isHandleInterruptedState in interface ReportProcessor
Returns:
true, if the processor should check the current thread state, false otherwise.

setHandleInterruptedState

public void setHandleInterruptedState(boolean handleInterruptedState)
Defines, whether the processor should check the threads interrupted state. If this is set to true and the thread was interrupted, then the report processing is aborted.

Specified by:
setHandleInterruptedState in interface ReportProcessor
Parameters:
handleInterruptedState - true, if the processor should check the current thread state, false otherwise.

close

public void close()
Specified by:
close in interface ReportProcessor

getConfiguration

public org.pentaho.reporting.libraries.base.config.Configuration getConfiguration()
Specified by:
getConfiguration in interface ReportProcessor

setFullStreamingProcessor

public void setFullStreamingProcessor(boolean fullStreamingProcessor)

isFullStreamingProcessor

public boolean isFullStreamingProcessor()

isPaginated

public boolean isPaginated()

processPage

public PageState processPage(PageState pageState,
                             boolean performOutput)
                      throws ReportProcessingException
Specified by:
processPage in interface ReportProcessor
Throws:
ReportProcessingException

paginate

public boolean paginate()
                 throws ReportProcessingException
Throws:
ReportProcessingException

processReport

public void processReport()
                   throws ReportProcessingException
Specified by:
processReport in interface ReportProcessor
Throws:
ReportProcessingException

getLogicalPageCount

public int getLogicalPageCount()

getPhysicalPageCount

public int getPhysicalPageCount()