org.apertereports.dashboard.html
Interface ReportDataProvider

All Known Implementing Classes:

ReportViewComponent

public interface ReportDataProvider

Marks a class a controller of report templates and the generator data.

Method Summary

org.apertereports.common.xml.config.ReportConfig	generateDrilldownReportConfig(Map<String,List<String>> parameters) Generates a temporary drilldown configuration for given parameters.
org.apertereports.common.wrappers.Pair<net.sf.jasperreports.engine.JasperPrint,byte[]>	provideReportData(org.apertereports.common.xml.config.ReportConfig config, org.apertereports.common.ARConstants.ReportType format, boolean cached) Provides a generated report out of a ReportConfig.
File	provideReportFileForHtmlExport(org.apertereports.common.xml.config.ReportConfig config, boolean cached) Provides a generated report out of a ReportConfig.
org.apertereports.model.ReportTemplate	provideReportTemplate(org.apertereports.common.xml.config.ReportConfig config) Provides a Jasper Reports template based on a given ReportConfig.

Method Detail

provideReportData

org.apertereports.common.wrappers.Pair<net.sf.jasperreports.engine.JasperPrint,byte[]> provideReportData(org.apertereports.common.xml.config.ReportConfig config,
                                                                                                         org.apertereports.common.ARConstants.ReportType format,
                                                                                                         boolean cached)

Provides a generated report out of a ReportConfig. The data is usually cached somewhere to boost the performance.

Parameters:

config - Input config

format - Output format

cached - Should the data be taken from a cache or generated directly

Returns:

A pair of JasperPrint and bytes of report data

provideReportFileForHtmlExport

File provideReportFileForHtmlExport(org.apertereports.common.xml.config.ReportConfig config,
                                    boolean cached)

Provides a generated report out of a ReportConfig. The data is usually cached somewhere to boost the performance. As result HTML or ZIP file is returned.

Parameters:

config - Input config

cached - Should the data be taken from a cache or generated directly

Returns:

A pair of JasperPrint and bytes of report data

provideReportTemplate

org.apertereports.model.ReportTemplate provideReportTemplate(org.apertereports.common.xml.config.ReportConfig config)

Provides a Jasper Reports template based on a given ReportConfig.

Parameters:

config - Input config

Returns:

A report template

generateDrilldownReportConfig

org.apertereports.common.xml.config.ReportConfig generateDrilldownReportConfig(Map<String,List<String>> parameters)

Generates a temporary drilldown configuration for given parameters.

Parameters:

parameters - Input parameters

Returns:

A report config