KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jasperreports > engine > JasperReport


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;
29
30 import java.io.Serializable JavaDoc;
31
32 import net.sf.jasperreports.engine.base.JRBaseReport;
33
34
35 /**
36  * The actual representation of a compiled report. The main difference between a report and a report design is that
37  * reports are already compiled and validated, so many characteristics are read only.
38  * @author Teodor Danciu (teodord@users.sourceforge.net)
39  * @version $Id: JasperReport.java 1229 2006-04-19 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
40  */
41 public class JasperReport extends JRBaseReport
42 {
43
44
45     /**
46      *
47      */
48     private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
49
50     /**
51      * The name of the compiler class used to compile this report.
52      * The compiler is used to instantiate expression evaluators.
53      */
54     private String JavaDoc compilerClass = null;
55
56     /**
57      * Unique string generated at compile time to distinguish between distinct compilations of reports having the same name.
58      */
59     private String JavaDoc compileNameSuffix;
60     
61     /**
62      * Expression evaluators compiled data.
63      */
64     private Serializable JavaDoc compileData = null;
65
66
67     /**
68      * Constructs a report by specifying the template report and compile information.
69      *
70      * @param report the report template
71      * @param compilerClass the name of the class used to compile the report
72      * @param compileData the report/main dataset compile data
73      * @param expressionCollector instance used to collect expressions from the report design
74      * @param compileNameSuffix unique string used to distinguish between distinct compilations of reports having the same name
75      * <p>
76      * The collector is used to fetch the generated expression IDs.
77      */
78     public JasperReport(
79         JRReport report,
80         String JavaDoc compilerClass,
81         Serializable JavaDoc compileData,
82         JRExpressionCollector expressionCollector,
83         String JavaDoc compileNameSuffix
84         )
85     {
86         super(report, expressionCollector);
87         
88         this.compilerClass = compilerClass;
89         this.compileData = compileData;
90         this.compileNameSuffix = compileNameSuffix;
91     }
92
93     /**
94      * Returns the name of the compiler class used to compile this report.
95      * <p>
96      * The compiler is used to instantiate expression evaluators.
97      *
98      * @return the name of the compiler class used to compile this report
99      */
100     public String JavaDoc getCompilerClass()
101     {
102         return this.compilerClass;
103     }
104
105
106     /**
107      * Returns data resulted from the expression evaluators compilation.
108      * <p>
109      * This data is used to create expression evaluators for report filling.
110      *
111      * @return expression evaluators compiled data
112      */
113     public Serializable JavaDoc getCompileData()
114     {
115         return this.compileData;
116     }
117
118     /**
119      * Returns the suffix of the class/unit names generated at report compilation.
120      * <p>
121      * This is used to distinguish between disctinct compilations of reports having the same name.
122      *
123      * @return the suffix of the class/unit names generated at report compilation
124      */
125     public String JavaDoc getCompileNameSuffix()
126     {
127         return compileNameSuffix;
128     }
129 }
130
Popular Tags