KickJava   Java API By Example, From Geeks To Geeks.

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


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
31 /**
32  * Represents a query used for generation of report data.
33  * <p/>
34  * Based on the query language, query executer implementations are used to retrieve the data and
35  * create a {@link net.sf.jasperreports.engine.JRDataSource JRDataSource} to be used by the filling process.
36  * <p/>
37  * When using the default SQL connection data source,
38  * an SQL query must also be provided for JasperReports to automatically retrieve the data.
39  * For SQL queries, a very important aspect is that column names in the result set obtained from the query must match the field names
40  * defined in the report template.
41  *
42  * @author Teodor Danciu (teodord@users.sourceforge.net)
43  * @version $Id: JRQuery.java 1229 2006-04-19 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
44  * @see net.sf.jasperreports.engine.query.JRQueryExecuterFactory
45  */
46 public interface JRQuery
47 {
48     
49     
50     /**
51      *
52      */
53     public JRQueryChunk[] getChunks();
54
55     /**
56      * Returns the query string.
57      */
58     public String JavaDoc getText();
59     
60
61     /**
62      * Returns the query language.
63      * <p/>
64      * Based on the query language, a corresponding
65      * {@link net.sf.jasperreports.engine.query.JRQueryExecuterFactory JRQueryExecuterFactory} is used to create
66      * a {@link net.sf.jasperreports.engine.query.JRQueryExecuter JRQueryExecuter} instance. The query executer
67      * is responsible for executing the query and creating a {@link JRDataSource JRDataSource} from the result.
68      *
69      * @return the query language
70      */
71     public String JavaDoc getLanguage();
72 }
73
Popular Tags