KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jasperreports > engine > design > JRCompiler


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.design;
29
30 import net.sf.jasperreports.crosstabs.JRCrosstab;
31 import net.sf.jasperreports.engine.JRDataset;
32 import net.sf.jasperreports.engine.JRException;
33 import net.sf.jasperreports.engine.JasperReport;
34 import net.sf.jasperreports.engine.fill.JREvaluator;
35
36
37 /**
38  * @author Teodor Danciu (teodord@users.sourceforge.net)
39  * @version $Id: JRCompiler.java 1229 2006-04-19 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
40  */
41 public interface JRCompiler
42 {
43
44
45     /**
46      * Compiles a report design.
47      * <p>
48      * The compilation consists of verification of the design, generation of expression evaluators
49      * and construction of a serializable read-only version of the report.
50      * <p>
51      * A report compiler should usually extend {@link JRAbstractCompiler JRAbstractCompiler}.
52      *
53      *
54      * @param jasperDesign the report design
55      * @return the compiled report
56      * @throws JRException
57      */
58     public JasperReport compileReport(JasperDesign jasperDesign) throws JRException;
59
60
61     /**
62      * Loads the evaluator for a report's main dataset.
63      *
64      * @param jasperReport the report
65      * @return the evaluator for the report's main dataset
66      * @throws JRException
67      */
68     public JREvaluator loadEvaluator(JasperReport jasperReport) throws JRException;
69
70     
71     /**
72      * Loads a expression evaluator class for a dataset of a report.
73      *
74      * @param jasperReport the report
75      * @param dataset the dataset
76      * @return an instance of the dataset evaluator class
77      * @throws JRException
78      */
79     public JREvaluator loadEvaluator(JasperReport jasperReport, JRDataset dataset) throws JRException;
80
81     
82     /**
83      * Loads a expression evaluator class for a crosstab of a report.
84      *
85      * @param jasperReport the report
86      * @param crosstab the crosstab
87      * @return an instance of the dataset evaluator class
88      * @throws JRException
89      */
90     public JREvaluator loadEvaluator(JasperReport jasperReport, JRCrosstab crosstab) throws JRException;
91
92 }
93
Popular Tags