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

Class MetaDataOutputGenerator

java.lang.Object

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

All Implemented Interfaces:

TableOutputGenerator, ReportOutputGenerator

public class MetaDataOutputGenerator
extends java.lang.Object
implements TableOutputGenerator

Generates an RSTableModel from an report with only the metaInformation set.

Constructor Summary

Constructors

Constructor and Description
MetaDataOutputGenerator()

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	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	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.
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 #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 Detail

MetaDataOutputGenerator

public MetaDataOutputGenerator()

Method Detail

getFormats

public java.lang.String[] getFormats()

Specified by:

getFormats in interface ReportOutputGenerator

Returns:

The generator's format

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 orgReport,
                       Column.CellFormatter[] cellFormatters,
                       ParameterSet parameters,
                       User user,
                       ReportExecutionConfig... configs)

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.

nextRow

public void nextRow()

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

addField

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

Description copied from interface: TableOutputGenerator

Adds a new cell to the output.

Specified by:

addField in interface TableOutputGenerator

close

public void close()

Description copied from interface: TableOutputGenerator

Informs the generator that the data is completely processed.

Specified by:

close in interface TableOutputGenerator

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.

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

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)

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

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