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