net.datenwerke.rs.base.service.reportengines.table.output.generator

Class CSVOutputGenerator

java.lang.Object

net.datenwerke.rs.base.service.reportengines.table.output.generator.TableOutputGeneratorImpl

net.datenwerke.rs.base.service.reportengines.table.output.generator.CSVOutputGenerator

All Implemented Interfaces:

TableOutputGenerator, ReportOutputGenerator

public class CSVOutputGenerator
extends TableOutputGeneratorImpl

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_FILE
static java.lang.String	CSV_LINE_SEPARATOR_PROPERTY
static java.lang.String	CSV_QUOTATION_PROPERTY
static java.lang.String	CSV_SEPARATOR_PROPERTY

Constructor Summary

Constructors

Constructor and Description
CSVOutputGenerator(ConfigService configService, ReportServerService reportServerService, <any> exporterHelperProvider)

Method Summary

Modifier and Type	Method and Description
void	addField(java.lang.Object field, Column.CellFormatter formatter) Adds a new cell to the output.
void	close() Informs the generator that the data is completely processed.
CompiledReport	getFormatInfo() Returns an empty CompiledReport object to specify the type of report that is generated by this generator.
java.lang.String[]	getFormats()
CompiledReport	getTableObject() Is called upon completion to get the final report object.
void	initialize(java.io.OutputStream os, TableDefinition td, boolean withSubtotals, TableReport report, TableReport orgReport, Column.CellFormatter[] cellFormatters, ParameterSet parameters, User user, ReportExecutionConfig... configs) Initializes the generator before the first data point is provided.
void	nextRow() Informs the generator that the current data row is finished and a new row is about to begin

Methods inherited from class net.datenwerke.rs.base.service.reportengines.table.output.generator.TableOutputGeneratorImpl

addGroupRow, isCatchAll, preInitialize, supportsStreaming

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_FILE

public static final java.lang.String CONFIG_FILE

See Also:

Constant Field Values

CSV_LINE_SEPARATOR_PROPERTY

public static final java.lang.String CSV_LINE_SEPARATOR_PROPERTY

See Also:

Constant Field Values

CSV_SEPARATOR_PROPERTY

public static final java.lang.String CSV_SEPARATOR_PROPERTY

See Also:

Constant Field Values

CSV_QUOTATION_PROPERTY

public static final java.lang.String CSV_QUOTATION_PROPERTY

See Also:

Constant Field Values

Constructor Detail

CSVOutputGenerator

public CSVOutputGenerator(ConfigService configService,
                          ReportServerService reportServerService,
                          <any> exporterHelperProvider)

Method Detail

addField

public void addField(java.lang.Object field,
                     Column.CellFormatter formatter)
              throws java.io.IOException

Description copied from interface: TableOutputGenerator

Adds a new cell to the output.

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Description copied from interface: TableOutputGenerator

Informs the generator that the data is completely processed.

Throws:

java.io.IOException

getFormats

public java.lang.String[] getFormats()

Returns:

The generator's format

getTableObject

public CompiledReport getTableObject()

Description copied from interface: TableOutputGenerator

Is called upon completion to get the final report object. In case an outputstream is used (see #initialize(OutputStream, TableDefinition, boolean, TableReport, TableReport, CellFormatter[], ParameterSet, User, ReportExecutionConfig...) the CompiledReport object should not contain actual report data.

Returns:

The finished report

initialize

public void initialize(java.io.OutputStream os,
                       TableDefinition td,
                       boolean withSubtotals,
                       TableReport report,
                       TableReport orgReport,
                       Column.CellFormatter[] cellFormatters,
                       ParameterSet parameters,
                       User user,
                       ReportExecutionConfig... configs)
                throws java.io.IOException

Description copied from interface: TableOutputGenerator

Initializes the generator before the first data point is provided.

Specified by:

initialize in interface TableOutputGenerator

Overrides:

initialize in class TableOutputGeneratorImpl

Parameters:

os - The output stream to be used. If no output stream is provided (the object is null), then the report should be generated in memory.

Throws:

java.io.IOException

nextRow

public void nextRow()
             throws java.io.IOException

Description copied from interface: TableOutputGenerator

Informs the generator that the current data row is finished and a new row is about to begin

Throws:

java.io.IOException

getFormatInfo

public CompiledReport getFormatInfo()

Description copied from interface: ReportOutputGenerator

Returns an empty CompiledReport object to specify the type of report that is generated by this generator.