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

Class XLSStreamOutputGenerator

java.lang.Object

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

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

All Implemented Interfaces:

TableOutputGenerator, ReportOutputGenerator

public class XLSStreamOutputGenerator
extends TableOutputGeneratorImpl

Constructor Summary

Constructors

Constructor and Description
XLSStreamOutputGenerator(XLSOutputGenerator basicXlsGenerator, StupidOracleService sos, LicenseService licenseService, ConfigService configService, <any> filterServiceProvider, <any> exporterHelperProvider)

Method Summary

Modifier and Type	Method and Description
void	addField(java.lang.Object field, Column.CellFormatter cellFormatter) Adds a new cell to the output.
void	addGroupRow(int[] subtotalIndices, java.lang.Object[] subtotals, int[] subtotalGroupFieldIndices, java.lang.Object[] subtotalGroupFieldValues, int rowSize, Column.CellFormatter[] cellFormatters) In case a report is exported using subtotals, this method is called whenever a group is finished and an aggregation row needs to be added.
void	close() Informs the generator that the data is completely processed.
void	createNewTab(TableDefinition table, TableReport report, Column.CellFormatter[] cellFormatters)
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 table, boolean withSubtotals, TableReport report, TableReport originalReport, Column.CellFormatter[] cellFormatters, ParameterSet parameters, User user, ReportExecutionConfig... configs) Initializes the generator before the first data point is provided.
boolean	isCatchAll() Returns true if this generator should be used if the format is not recognized.
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

preInitialize, supportsStreaming

Methods inherited from class java.lang.Object

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

Constructor Detail

XLSStreamOutputGenerator

public XLSStreamOutputGenerator(XLSOutputGenerator basicXlsGenerator,
                                StupidOracleService sos,
                                LicenseService licenseService,
                                ConfigService configService,
                                <any> filterServiceProvider,
                                <any> exporterHelperProvider)

Method Detail

getFormats

public java.lang.String[] getFormats()

Returns:

The generator's format

initialize

public void initialize(java.io.OutputStream os,
                       TableDefinition table,
                       boolean withSubtotals,
                       TableReport report,
                       TableReport originalReport,
                       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

createNewTab

public void createNewTab(TableDefinition table,
                         TableReport report,
                         Column.CellFormatter[] cellFormatters)
                  throws java.io.IOException

Throws:

java.io.IOException

addField

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

Description copied from interface: TableOutputGenerator

Adds a new cell to the output.

Throws:

java.io.IOException

addGroupRow

public void addGroupRow(int[] subtotalIndices,
                        java.lang.Object[] subtotals,
                        int[] subtotalGroupFieldIndices,
                        java.lang.Object[] subtotalGroupFieldValues,
                        int rowSize,
                        Column.CellFormatter[] cellFormatters)
                 throws java.io.IOException

Description copied from interface: TableOutputGenerator

In case a report is exported using subtotals, this method is called whenever a group is finished and an aggregation row needs to be added.

Specified by:

addGroupRow in interface TableOutputGenerator

Overrides:

addGroupRow in class TableOutputGeneratorImpl

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

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

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

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.

isCatchAll

public boolean isCatchAll()

Description copied from interface: ReportOutputGenerator

Returns true if this generator should be used if the format is not recognized.

Specified by:

isCatchAll in interface ReportOutputGenerator

Overrides:

isCatchAll in class TableOutputGeneratorImpl