org.jfree.report.modules.output.table.csv: public class: CSVTableProcessor

org.jfree.report.modules.output.table.csv
public class: CSVTableProcessor [javadoc | source]

java.lang.Object
   org.jfree.report.modules.output.table.base.TableProcessor
      org.jfree.report.modules.output.table.csv.CSVTableProcessor

The CSVTableProcessor coordinates the output for the layouted CSV output. The bands are layouted and the layouted contents are printed into the csv-file.

For data oriented csv output try the org.jfree.report.targets.csv.CSVProcessor. The used writer is not closed after the processing, the caller is responsible to close the writer.

The CellSeparator can be used to alter the separator character, f.i. to create tab-separated files.

Also see:

CSVProcessor

author: Thomas - Morgner

Field Summary
public static final String	CONFIGURATION_PREFIX	the configuration prefix for the csv table producer.
public static final String	SEPARATOR_KEY	the key for the separator string.
public static final String	SEPARATOR_DEFAULT	The default value for the separator string (",").

Fields inherited from org.jfree.report.modules.output.table.base.TableProcessor:
STRICT_TABLE_LAYOUT, STRICT_TABLE_LAYOUT_DEFAULT, STRICT_LAYOUT

Constructor:

Constructor:
public CSVTableProcessor(JFreeReport report) throws FunctionInitializeException, ReportProcessingException { // query the report configuration for the new separator property // on fail: query for the old separator property // on fail: set "," this(report, report.getReportConfiguration().getConfigProperty( CONFIGURATION_PREFIX + SEPARATOR_KEY, report.getReportConfiguration().getConfigProperty( CSVProcessor.CSV_SEPARATOR, ","))); } Creates a new CSV table processor for the given report. The default separator is a comma (","), but this can be overridden in the report configuration (key: `org.jfree.report.targets.csv.separator`). Parameters: `report` - the report to process. Throws: `ReportProcessingException` - if the report initialization failed `FunctionInitializeException` - if the table writer initialization failed.
public CSVTableProcessor(JFreeReport report, String separator) throws FunctionInitializeException, ReportProcessingException { super(report); if (separator == null) { throw new NullPointerException("Separator is null"); } setSeparator(separator); } Creates a new CSV table processor for the given report and uses the given separator string. Parameters: `report` - the report to process. `separator` - the value separator (`null` not permitted). Throws: `ReportProcessingException` - if the report initialization failed `FunctionInitializeException` - if the table writer initialization failed. `NullPointerException` - if the given separator is `null`.

 public CSVTableProcessor(JFreeReport report) throws FunctionInitializeException, ReportProcessingException {
                                                        
    // query the report configuration for the new separator property
    // on fail: query for the old separator property
    // on fail: set ","
    this(report,
        report.getReportConfiguration().getConfigProperty(
            CONFIGURATION_PREFIX + SEPARATOR_KEY,
            report.getReportConfiguration().getConfigProperty(
                CSVProcessor.CSV_SEPARATOR, ",")));
}

The default separator is a comma (","), but this can be overridden in the report configuration (key: org.jfree.report.targets.csv.separator).

Parameters:

report - the report to process.

Throws:

ReportProcessingException - if the report initialization failed

FunctionInitializeException - if the table writer initialization failed.

 public CSVTableProcessor(JFreeReport report,
    String separator) throws FunctionInitializeException, ReportProcessingException {
    super(report);
    if (separator == null)
    {
      throw new NullPointerException("Separator is null");
    }
    setSeparator(separator);
}

Creates a new CSV table processor for the given report and uses the given separator string.

Parameters:

report - the report to process.

separator - the value separator (null not permitted).

Throws:

ReportProcessingException - if the report initialization failed

FunctionInitializeException - if the table writer initialization failed.

NullPointerException - if the given separator is null.

Method from org.jfree.report.modules.output.table.csv.CSVTableProcessor Summary:
createDummyProducer, createProducer, getReportConfigurationPrefix, getSeparator, getWriter, setSeparator, setWriter

Methods from org.jfree.report.modules.output.table.base.TableProcessor:
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.csv.CSVTableProcessor Detail:
protected TableProducer createDummyProducer() { // csv always uses the global layout. We dont support pages, so why introduce // artifical boundaries ... return new CSVTableProducer (new TableLayoutInfo(true, getReport().getDefaultPageFormat()), isStrictLayout()); } Creates a dummy TableProducer. The TableProducer is responsible to compute the layout.
protected TableProducer createProducer(TableLayoutInfo layoutBounds) { return new CSVTableProducer(layoutBounds, getWriter()); } Creates the CSVTableProducer. The TableProducer is responsible to create the table.
protected String getReportConfigurationPrefix() { return CONFIGURATION_PREFIX; } Gets the report configuration prefix for that processor. This prefix defines how to map the property names into the global report configuration.
public String getSeparator() { return String.valueOf(getProperty(SEPARATOR_KEY, ",")); } Gets the separator string for the generated output.
public Writer getWriter() { return writer; } Gets the writer, which should be used to output the generated content.
public void setSeparator(String separator) { if (separator == null) { throw new NullPointerException("Separator is null"); } setProperty(SEPARATOR_KEY, separator); } Defines the separator string for the generated output.
public void setWriter(Writer writer) { this.writer = writer; } Sets the writer, that should be used to write the generated content.

Method from org.jfree.report.modules.output.table.csv.CSVTableProcessor Detail:

 protected TableProducer createDummyProducer() {
    // csv always uses the global layout. We dont support pages, so why introduce
    // artifical boundaries ...
    return new CSVTableProducer
        (new TableLayoutInfo(true, getReport().getDefaultPageFormat()), isStrictLayout());
}

Creates a dummy TableProducer. The TableProducer is responsible to compute the layout.

 protected TableProducer createProducer(TableLayoutInfo layoutBounds) {
    return new CSVTableProducer(layoutBounds, getWriter());
}

Creates the CSVTableProducer. The TableProducer is responsible to create the table.

 protected String getReportConfigurationPrefix() {
    return CONFIGURATION_PREFIX;
}

Gets the report configuration prefix for that processor. This prefix defines how to map the property names into the global report configuration.

 public String getSeparator() {
    return String.valueOf(getProperty(SEPARATOR_KEY, ","));
}

Gets the separator string for the generated output.

 public Writer getWriter() {
    return writer;
}

Gets the writer, which should be used to output the generated content.

 public  void setSeparator(String separator) {
    if (separator == null)
    {
      throw new NullPointerException("Separator is null");
    }
    setProperty(SEPARATOR_KEY, separator);
}

Defines the separator string for the generated output.

 public  void setWriter(Writer writer) {
    this.writer = writer;
}

Sets the writer, that should be used to write the generated content.