net.sf.jasperreports.engine

Interface JRExporter

All Known Implementing Classes:

JExcelApiExporter, JExcelApiMetadataExporter, JRAbstractCsvExporter, JRAbstractExporter, JRCsvExporter, JRCsvMetadataExporter, JRDocxExporter, JRGraphics2DExporter, JRHtmlExporter, JROdsExporter, JROdtExporter, JROpenDocumentExporter, JRPdfExporter, JRPptxExporter, JRPrintServiceExporter, JRRtfExporter, JRTextExporter, JRXhtmlExporter, JRXlsAbstractExporter, JRXlsAbstractMetadataExporter, JRXlsExporter, JRXlsxExporter, JRXml4SwfExporter, JRXmlExporter

public interface JRExporter

All document exporting in JasperReports is done through this interface. There is an implementation of this interface for every document format that JasperReports supports at the moment.

Export customization is realized by using export parameters. Each exporter is able to recognize and use its own parameters, but there is a subset of predefined parameters that are common to all exporters. Those are identified by constants in the JRExporterParameter base class. All parameters are documented inside the classes where they are defined.

An important aspect is the output type of each exporter. There are three types of exporters depending on the type of output they produce:

• exporters that export to text or character based file formats (HTML, RTF, CSV, TXT, XML exporters);
• exporters that export to binary file formats (PDF and XLS exporters)
• exporters that export directly to graphic devices (Graphics2D and Java Print Service exporters)

All existing exporters fall into two categories depending on the way the content of the documents they produce could be structured:

• there are the exporters which target document formats which support free-form page content. These are the Grapchis2D, PDF, RTF and XML exporters.
• the second category of exporters groups those exporters that target document formats which only support relative positioning of elements on a page or a grid-based layout. In this category we have the HTML, XLS and CSV exporters.

Version:

$Id: JRExporter.java 5180 2012-03-29 13:23:12Z teodord $

Author:

Teodor Danciu (teodord@users.sourceforge.net)

Method Summary

Methods

Modifier and Type	Method and Description
void	exportReport() Actually starts the export process.
Object	getParameter(JRExporterParameter parameter) Gets an export parameter.
Map<JRExporterParameter,Object>	getParameters() Gets a map containing all export parameters.
ReportContext	getReportContext()
void	setParameter(JRExporterParameter parameter, Object value) Sets an export parameter for advanced customization of the export process.
void	setParameters(Map<JRExporterParameter,Object> parameters) Sets export parameters from a specified map.
void	setReportContext(ReportContext reportContext)

Method Detail

setParameter

void setParameter(JRExporterParameter parameter,
                Object value)

Sets an export parameter for advanced customization of the export process. Parameters can be either common parameters or specialized ones, depending on the exporter type.

Parameters:

parameter - the parameter, selected from the static parameters defined by JasperReports

value - the parameter value

See Also:

JRExporterParameter

getParameter

Object getParameter(JRExporterParameter parameter)

Gets an export parameter.

setParameters

void setParameters(Map<JRExporterParameter,Object> parameters)

Sets export parameters from a specified map.

See Also:

setParameter(JRExporterParameter, Object)

getParameters

Map<JRExporterParameter,Object> getParameters()

Gets a map containing all export parameters.

setReportContext

void setReportContext(ReportContext reportContext)

getReportContext

ReportContext getReportContext()

exportReport

void exportReport()
                  throws JRException

Actually starts the export process.

Throws:

JRException