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