01: /*
02: * ============================================================================
03: * GNU Lesser General Public License
04: * ============================================================================
05: *
06: * JasperReports - Free Java report-generating library.
07: * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
08: *
09: * This library is free software; you can redistribute it and/or
10: * modify it under the terms of the GNU Lesser General Public
11: * License as published by the Free Software Foundation; either
12: * version 2.1 of the License, or (at your option) any later version.
13: *
14: * This library is distributed in the hope that it will be useful,
15: * but WITHOUT ANY WARRANTY; without even the implied warranty of
16: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17: * Lesser General Public License for more details.
18: *
19: * You should have received a copy of the GNU Lesser General Public
20: * License along with this library; if not, write to the Free Software
21: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22: *
23: * JasperSoft Corporation
24: * 303 Second Street, Suite 450 North
25: * San Francisco, CA 94107
26: * http://www.jaspersoft.com
27: */
28: package net.sf.jasperreports.engine;
29:
30: import java.util.Map;
31:
32: /**
33: * All document exporting in JasperReports is done through this interface. There is an implementation of
34: * this interface for every document format that JasperReports supports at the moment.
35: * <p>
36: * Export customization is realized by using export parameters. Each exporter is able to recognize and use
37: * its own parameters, but there is a subset of predefined parameters that are common to all exporters.
38: * Those are identified by constants in the {@link JRExporterParameter} base class. All parameters are documented
39: * inside the classes where they are defined.
40: * <p>
41: * An important aspect is the output type of each exporter. There are three types of exporters depending on
42: * the type of output they produce:
43: * <ul>
44: * <li>exporters that export to text or character based file formats (HTML, RTF, CSV, TXT, XML exporters);
45: * <li>exporters that export to binary file formats (PDF and XLS exporters)
46: * <li>exporters that export directly to graphic devices (Graphics2D and Java Print Service exporters)
47: * </ul>
48: *<p>
49: * All existing exporters fall into two categories depending on the way the content of the documents they
50: * produce could be structured:
51: * <ul>
52: * <li> there are the exporters which target document formats which support free-form page content. These
53: * are the Grapchis2D, PDF, RTF and XML exporters.
54: * <li> the second category of exporters groups those exporters that target document formats which only
55: * support relative positioning of elements on a page or a grid-based layout. In this category we have the
56: * HTML, XLS and CSV exporters.
57: * </ul>
58: *
59: * @author Teodor Danciu (teodord@users.sourceforge.net)
60: * @version $Id: JRExporter.java 1229 2006-04-19 10:27:35Z teodord $
61: */
62: public interface JRExporter {
63:
64: /**
65: * Sets an export parameter for advanced customization of the export process. Parameters can be either
66: * common parameters or specialized ones, depending on the exporter type.
67: * @param parameter the parameter, selected from the static parameters defined by JasperReports
68: * @param value the parameter value
69: * @see JRExporterParameter
70: */
71: public void setParameter(JRExporterParameter parameter, Object value);
72:
73: /**
74: * Gets an export parameter.
75: */
76: public Object getParameter(JRExporterParameter parameter);
77:
78: /**
79: * Sets export parameters from a specified map.
80: * @see JRExporter#setParameter(JRExporterParameter, Object)
81: */
82: public void setParameters(Map parameters);
83:
84: /**
85: * Gets a map containing all export parameters.
86: */
87: public Map getParameters();
88:
89: /**
90: * Actually starts the export process.
91: */
92: public void exportReport() throws JRException;
93:
94: }
|