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

Interface TableOutputGenerator

All Superinterfaces:

ReportOutputGenerator

All Known Subinterfaces:

SimpleJxlsTemplateOutputGenerator

All Known Implementing Classes:

CompactJSONOutputGenerator, CSVOutputGenerator, DataCountOutputGenerator, DummyJxlsTemplateOutputGenerator, HTMLOutputGenerator, JSONOutputGenerator, JxlsTemplateOutputGenerator, LegacyTablePDFOutputGenerator, MetaDataOutputGenerator, PdfTableOutputGenerator, RSTableOutputGenerator, RSTableSimpleBeanOutputGenerator, StreamTableOutputGenerator, TableOutputGeneratorImpl, TableReportInformationOutputGenerator, XLSOutputGenerator, XLSStreamOutputGenerator

public interface TableOutputGenerator
extends ReportOutputGenerator

An output generator for dynamic lists.

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.
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 originalReport, 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
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 interface net.datenwerke.rs.core.service.reportmanager.output.ReportOutputGenerator

getFormatInfo, getFormats, isCatchAll

Method Detail

preInitialize

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. something that has to be initialized before the TableDefinition is created, it can be done here.

initialize

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

Initializes the generator before the first data point is provided.

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

void nextRow()
      throws java.io.IOException

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

Throws:

java.io.IOException

addField

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

Adds a new cell to the output.

Parameters:

field -

cellFormatter -

Throws:

java.io.IOException

close

void close()
    throws java.io.IOException

Informs the generator that the data is completely processed.

Throws:

java.io.IOException

getTableObject

CompiledReport getTableObject()

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

addGroupRow

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

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.

Throws:

java.io.IOException

supportsStreaming

boolean supportsStreaming()

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