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

Class TableOutputGeneratorImpl

java.lang.Object

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

All Implemented Interfaces:

TableOutputGenerator, ReportOutputGenerator

Direct Known Subclasses:

CompactJSONOutputGenerator, CSVOutputGenerator, DataCountOutputGenerator, HTMLOutputGenerator, JSONOutputGenerator, LegacyTablePDFOutputGenerator, RSTableOutputGenerator, RSTableSimpleBeanOutputGenerator, StreamTableOutputGenerator, TableReportInformationOutputGenerator, XLSStreamOutputGenerator

public abstract class TableOutputGeneratorImpl
extends java.lang.Object
implements TableOutputGenerator

Constructor Summary

Constructors

Constructor and Description
TableOutputGeneratorImpl()

Method Summary

Modifier and Type	Method and Description
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	initialize(java.io.OutputStream os, TableDefinition td, 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	preInitialize() If something needs to be done before the #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

Methods inherited from interface net.datenwerke.rs.base.service.reportengines.table.output.generator.TableOutputGenerator

addField, close, getTableObject, nextRow

Methods inherited from interface net.datenwerke.rs.core.service.reportmanager.output.ReportOutputGenerator

getFormatInfo, getFormats

Constructor Detail

TableOutputGeneratorImpl

public TableOutputGeneratorImpl()

Method Detail

preInitialize

public void preInitialize()

Description copied from interface: TableOutputGenerator

If something needs to be done before the #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(java.io.OutputStream os,
                       TableDefinition td,
                       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

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

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

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

Throws:

java.io.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