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

Class DummyJxlsTemplateOutputGenerator

java.lang.Object

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

All Implemented Interfaces:

SimpleJxlsTemplateOutputGenerator, TableOutputGenerator, ReportOutputGenerator

public class DummyJxlsTemplateOutputGenerator
extends Object
implements SimpleJxlsTemplateOutputGenerator

Constructor Summary

Constructors

Constructor	Description
DummyJxlsTemplateOutputGenerator()

Method Summary

Modifier and Type	Method	Description
void	addField(Object field, Column.CellFormatter cellFormatter)	Adds a new cell to the output.
void	addGroupRow(int[] subtotalIndices, Object[] subtotals, int[] subtotalGroupFieldIndices, 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.
CompiledReport	getFormatInfo()	Returns an empty CompiledReport object to specify the type of report that is generated by this generator.
String[]	getFormats()
CompiledReport	getTableObject()	Is called upon completion to get the final report object.
void	initialize(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.
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
void	preInitialize()	If something needs to be done before the TableOutputGenerator.initialize(OutputStream, TableDefinition, boolean, TableReport, TableReport, CellFormatter[], ParameterSet, User, ReportExecutionConfig...) method is called, e.g.
boolean	supportsStreaming()	Return true if the output generator is able to stream data.

Methods inherited from class java.lang.Object

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

Constructor Details

DummyJxlsTemplateOutputGenerator

public DummyJxlsTemplateOutputGenerator()

Method Details

preInitialize

public void preInitialize()

Description copied from interface: TableOutputGenerator

If something needs to be done before the TableOutputGenerator.initialize(OutputStream, TableDefinition, boolean, TableReport, TableReport, CellFormatter[], ParameterSet, User, ReportExecutionConfig...) method is called, e.g. something that has to be initialized before the TableDefinition is created, it can be done here.

Specified by:

preInitialize in interface TableOutputGenerator

initialize

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

Description copied from interface: TableOutputGenerator

Initializes the generator before the first data point is provided.

Specified by:

initialize in interface TableOutputGenerator

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:

IOException

getFormats

public String[] getFormats()

Specified by:

getFormats in interface ReportOutputGenerator

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 TableOutputGenerator.initialize(OutputStream, TableDefinition, boolean, TableReport, TableReport, CellFormatter[], ParameterSet, User, ReportExecutionConfig...) the CompiledReport object should not contain actual report data.

Specified by:

getTableObject in interface TableOutputGenerator

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.

Specified by:

getFormatInfo in interface ReportOutputGenerator

nextRow

public void nextRow()
             throws IOException

Description copied from interface: TableOutputGenerator

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

Specified by:

nextRow in interface TableOutputGenerator

Throws:

IOException

addField

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

Description copied from interface: TableOutputGenerator

Adds a new cell to the output.

Specified by:

addField in interface TableOutputGenerator

Parameters:

field -

cellFormatter -

Throws:

IOException

close

public void close()
           throws IOException

Description copied from interface: TableOutputGenerator

Informs the generator that the data is completely processed.

Specified by:

close in interface TableOutputGenerator

Throws:

IOException

addGroupRow

public void addGroupRow(int[] subtotalIndices,
 Object[] subtotals,
 int[] subtotalGroupFieldIndices,
 Object[] subtotalGroupFieldValues,
 int rowSize,
 Column.CellFormatter[] cellFormatters)
                 throws 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

Throws:

IOException

supportsStreaming

public boolean supportsStreaming()

Description copied from interface: TableOutputGenerator

Return true if the output generator is able to stream data.

Specified by:

supportsStreaming in interface TableOutputGenerator

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