net.sf.jasperreports.engine.JRExporter Maven / Gradle / Ivy
/*
* ============================================================================
* GNU Lesser General Public License
* ============================================================================
*
* JasperReports - Free Java report-generating library.
* Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
*
* JasperSoft Corporation
* 303 Second Street, Suite 450 North
* San Francisco, CA 94107
* http://www.jaspersoft.com
*/
package net.sf.jasperreports.engine;
import java.util.Map;
/**
* 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 {@link 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.
*
*
* @author Teodor Danciu ([email protected])
* @version $Id: JRExporter.java 1229 2006-04-19 10:27:35Z teodord $
*/
public interface JRExporter
{
/**
* 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.
* @param parameter the parameter, selected from the static parameters defined by JasperReports
* @param value the parameter value
* @see JRExporterParameter
*/
public void setParameter(JRExporterParameter parameter, Object value);
/**
* Gets an export parameter.
*/
public Object getParameter(JRExporterParameter parameter);
/**
* Sets export parameters from a specified map.
* @see JRExporter#setParameter(JRExporterParameter, Object)
*/
public void setParameters(Map parameters);
/**
* Gets a map containing all export parameters.
*/
public Map getParameters();
/**
* Actually starts the export process.
*/
public void exportReport() throws JRException;
}