net.datenwerke.rs.core.service.reportmanager.engine

Class ReportEngine<D,G extends ReportOutputGenerator,E extends ReportMetadataExporter>

java.lang.Object

net.datenwerke.rs.core.service.reportmanager.engine.ReportEngine<D,G,E>

Direct Known Subclasses:

BirtReportEngine, CrystalReportEngine, GridEditorReportEngine, JasperReportEngine, JxlsReportEngine, SaikuReportEngine, ScriptReportEngine, TableReportEngine

public abstract class ReportEngine<D,G extends ReportOutputGenerator,E extends ReportMetadataExporter>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ReportEngine(AbstractReportOutputGeneratorManager<G> outputGeneratorManager, AbstractReportMetadataExporterManager<E> metadataExporterManager, DatasourceTransformationService datasourceTransformationService)

Method Summary

Modifier and Type	Method and Description
abstract boolean	consumes(Report report) Defines the possible output formats
CompiledReport	execute(java.io.OutputStream os, Report report, ParameterSet parameterSet, User user, java.lang.String outputFormat, ReportExecutionConfig... configs) Executes a given report.
CompiledReport	executeDry(java.io.OutputStream os, Report report, ParameterSet parameterSet, User user, java.lang.String outputFormat, ReportExecutionConfig[] configs)
CompiledReportMetadata	exportMetadata(Report report, ParameterSet additionalParameters, User user, java.lang.String outputFormat)
<C extends ReportExecutionConfig> C	getConfig(java.lang.Class<C> type, ReportExecutionConfig... configs)
java.lang.String[]	getSupportedMetadataFormats()
java.lang.String[]	getSupportedOutputFormats() Defines which output formats are supported
boolean	hasCatchAllOutputGen()
boolean	hasConfig(java.lang.Class<? extends ReportExecutionConfig> type, ReportExecutionConfig... configs)
void	isExecutable(Report report, ParameterSet additionalParameters, User user, java.lang.String outputFormat, ReportExecutionConfig... configs)
void	setEventBus(EventBus eventBus)
void	setHookHandler(HookHandlerService hookHandler)
boolean	supportsStreaming(Report report, ParameterSet parameterSet, User user, java.lang.String outputFormat, ReportExecutionConfig... configs)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportEngine

public ReportEngine(AbstractReportOutputGeneratorManager<G> outputGeneratorManager,
                    AbstractReportMetadataExporterManager<E> metadataExporterManager,
                    DatasourceTransformationService datasourceTransformationService)

Method Detail

setEventBus

public void setEventBus(EventBus eventBus)

setHookHandler

public void setHookHandler(HookHandlerService hookHandler)

getSupportedOutputFormats

public java.lang.String[] getSupportedOutputFormats()

Defines which output formats are supported

hasCatchAllOutputGen

public boolean hasCatchAllOutputGen()

getSupportedMetadataFormats

public java.lang.String[] getSupportedMetadataFormats()

isExecutable

public void isExecutable(Report report,
                         ParameterSet additionalParameters,
                         User user,
                         java.lang.String outputFormat,
                         ReportExecutionConfig... configs)
                  throws ReportExecutorException

Throws:

ReportExecutorException

execute

public CompiledReport execute(java.io.OutputStream os,
                              Report report,
                              ParameterSet parameterSet,
                              User user,
                              java.lang.String outputFormat,
                              ReportExecutionConfig... configs)
                       throws ReportExecutorException,
                              ExpectedException

Executes a given report.

Throws:

ReportExecutorException

ExpectedException

executeDry

public CompiledReport executeDry(java.io.OutputStream os,
                                 Report report,
                                 ParameterSet parameterSet,
                                 User user,
                                 java.lang.String outputFormat,
                                 ReportExecutionConfig[] configs)
                          throws ReportExecutorException,
                                 ExpectedException

Throws:

ReportExecutorException

ExpectedException

supportsStreaming

public boolean supportsStreaming(Report report,
                                 ParameterSet parameterSet,
                                 User user,
                                 java.lang.String outputFormat,
                                 ReportExecutionConfig... configs)

consumes

public abstract boolean consumes(Report report)

Defines the possible output formats

hasConfig

public boolean hasConfig(java.lang.Class<? extends ReportExecutionConfig> type,
                         ReportExecutionConfig... configs)

getConfig

public <C extends ReportExecutionConfig> C getConfig(java.lang.Class<C> type,
                                                     ReportExecutionConfig... configs)

exportMetadata

public CompiledReportMetadata exportMetadata(Report report,
                                             ParameterSet additionalParameters,
                                             User user,
                                             java.lang.String outputFormat)
                                      throws ReportExecutorException

Throws:

ReportExecutorException