KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jasperreports > engine > export > JRXmlExporterParameter


1 /*
2  * ============================================================================
3  * GNU Lesser General Public License
4  * ============================================================================
5  *
6  * JasperReports - Free Java report-generating library.
7  * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
8  *
9  * 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.export;
29
30 import net.sf.jasperreports.engine.JRExporterParameter;
31 import net.sf.jasperreports.engine.JasperPrint;
32
33 /**
34  * Contains parameters useful for export in XML format. The generated XML has a custom structure whose DTD defintion can be
35  * found in the net.sf.jasperreports.engine.dtds package of the JasperReports library. Because of this custom format it's easy
36  * to import back the XML file to a {@link JasperPrint} object.
37  * <p>
38  * The report images can be either stored internally in the resulting XML document or as separate files on disk. The internally stored
39  * images are saved as BASE64 encoded byte arrays in CDATA sections.
40  *
41  * @author Teodor Danciu (teodord@users.sourceforge.net)
42  * @version $Id: JRXmlExporterParameter.java 1229 2006-04-19 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
43  */
44 public class JRXmlExporterParameter extends JRExporterParameter
45 {
46
47
48     /**
49      *
50      */
51     protected JRXmlExporterParameter(String JavaDoc name)
52     {
53         super(name);
54     }
55
56
57     /**
58      * A boolean value specifying whether images should be store internally or rather as files on disk.
59      */
60     public static final JRXmlExporterParameter IS_EMBEDDING_IMAGES = new JRXmlExporterParameter("Is Embedding Images Flag");
61
62
63     /**
64      * A utility parameter that allows users to specify an alternate location for the DTD file. This is useful for users
65      * who want to open the generated XML files in various editors that try to actually load the DTD for error checking.
66      */
67     public static final JRXmlExporterParameter DTD_LOCATION = new JRXmlExporterParameter("DTD Location");
68
69
70 }
71
Popular Tags