KickJava   Java API By Example, From Geeks To Geeks.

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


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  * Interface of an sub dataset instantiation.
32  *
33  * @author Lucian Chirita (lucianc@users.sourceforge.net)
34  * @version $Id: JRDatasetRun.java 1229 2006-04-19 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
35  * @see net.sf.jasperreports.engine.JRDataset
36  * @see net.sf.jasperreports.engine.JRChartDataset#getDatasetRun()
37  */
38 public interface JRDatasetRun
39 {
40     /**
41      * Returns the sub dataset name.
42      *
43      * @return the sub dataset name
44      */
45     public String JavaDoc getDatasetName();
46     
47     
48     /**
49      * Returns the parameters map expression.
50      * <p>
51      * The result of this expression is used as the parameters map when instantiating the dataset.
52      *
53      * @return the parameters map expression
54      */
55     public JRExpression getParametersMapExpression();
56     
57     
58     /**
59      * Returns the list of parameter values.
60      *
61      * @return the list of parameter values
62      */
63     public JRDatasetParameter[] getParameters();
64
65     
66     /**
67      * Returns the DB connection expression.
68      * <p>
69      * The result of this expression is used as the DB connection when instantiating the dataset.
70      *
71      * @return the DB connection expression
72      */
73     public JRExpression getConnectionExpression();
74
75     
76     /**
77      * Returns the data source expression.
78      * <p>
79      * The result of this expression is used as the data source when instantiating the dataset.
80      *
81      * @return the data source expression
82      */
83     public JRExpression getDataSourceExpression();
84
85 }
86
Popular Tags