Save This Page
Home » pentaho-reporting-engine-classic-0.8.10 » org.jfree.report.modules.output.table » base » [javadoc | source]
org.jfree.report.modules.output.table.base
abstract public class: TableProcessor [javadoc | source]
java.lang.Object
   org.jfree.report.modules.output.table.base.TableProcessor

Direct Known Subclasses:
    ExcelProcessor, RTFProcessor, HtmlProcessor, CSVTableProcessor

The TableProcessor is the abstract base class for all table based output targets. It handles the initialisation of the report writer and starts and manages the report process.

Implementing classes should supply a table producer by implementing the createProducer method.

Like all other report processors, this implementation is not synchronized.

Field Summary
public static final  String STRICT_TABLE_LAYOUT    Enable stricter table layouting for all TableProcessors. 
public static final  String STRICT_TABLE_LAYOUT_DEFAULT    Disable strict layout by default. 
public static final  String STRICT_LAYOUT    The local property name for strict layout. 
Constructor:
 public TableProcessor(JFreeReport report) throws FunctionInitializeException, ReportProcessingException 
    Creates a new TableProcessor. The TableProcessor creates a private copy of the supplied report.
    Parameters:
    report - the report that should be processed.
    Throws:
    ReportProcessingException - if the report initialization failed
Method from org.jfree.report.modules.output.table.base.TableProcessor Summary:
addRepaginationListener,   checkInterrupted,   configure,   createDummyProducer,   createProducer,   fireStateUpdate,   getProperties,   getProperty,   getProperty,   getPropertyNames,   getReport,   getReportConfigurationPrefix,   getTableWriter,   isHandleInterruptedState,   isStrictLayout,   processReport,   removeRepaginationListener,   setHandleInterruptedState,   setProperty,   setStrictLayout
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.jfree.report.modules.output.table.base.TableProcessor Detail:
 public  void addRepaginationListener(RepaginationListener l) 
    Adds a repagination listener. This listener will be informed of pagination events.
 protected  void checkInterrupted() throws ReportInterruptedException 
    Checks, whether the current thread is interrupted.
 protected  void configure() 
    Copies all report configuration properties which match the configuration prefix of this table processor into the property set of this processor.
 abstract protected TableProducer createDummyProducer()
    Creates a dummy TableProducer. The TableProducer is responsible to compute the layout.
 abstract protected TableProducer createProducer(TableLayoutInfo gridLayoutBounds)
    Creates a TableProducer. The TableProducer is responsible to create the table.
 protected  void fireStateUpdate(RepaginationState state) 
    Sends a repagination update to all registered listeners.
 protected Properties getProperties() 
    Gets the internal properties storage.
 public Object getProperty(String property) 
    Queries the property named with property. If the property is not found, null is returned.
 public Object getProperty(String property,
    Object defaultValue) 
    Queries the property named with property. If the property is not found, the default value is returned.
 protected Iterator getPropertyNames() 
    Returns an enumeration of the property names.
 protected JFreeReport getReport() 
    Returns the private copy of the used report. The report is initialized for the report writing, so handle this instance with care.
 abstract protected String getReportConfigurationPrefix()
    Gets the report configuration prefix for that processor. This prefix defines how to map the property names into the global report configuration.
 protected TableWriter getTableWriter() 
    Returns the tablewriter function used in to create the report contents.
 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.
 public boolean isStrictLayout() 
    returns true, if the TableWriter should perform a stricter layout translation. When set to true, all element bounds are used to create the table. This could result in a complex layout, more suitable for printing. If set to false, only the starting bounds (the left and the upper border) are used to create the layout. This will result is lesser cells and rows, the layout will be better suitable for later processing.
 public  void processReport() throws ReportProcessingException 
    Processes the report. The generated output is written using the defined writer, the report is repaginated before the final writing.
 public  void removeRepaginationListener(RepaginationListener l) 
    Removes a repagination listener.
 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.
 public  void setProperty(String property,
    Object value) 
    Defines a property for this output target. Properties are the standard way of configuring an output target.
 public  void setStrictLayout(boolean strictLayout) 
    Defines whether strict layouting rules should be used for the TableLayouter.