01: /**
02: * ========================================
03: * JFreeReport : a free Java report library
04: * ========================================
05: *
06: * Project Info: http://reporting.pentaho.org/
07: *
08: * (C) Copyright 2000-2007, by Object Refinery Limited, Pentaho Corporation and Contributors.
09: *
10: * This library is free software; you can redistribute it and/or modify it under the terms
11: * of the GNU Lesser General Public License as published by the Free Software Foundation;
12: * either 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, but WITHOUT ANY WARRANTY;
15: * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16: * See the GNU Lesser General Public License for more details.
17: *
18: * You should have received a copy of the GNU Lesser General Public License along with this
19: * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20: * Boston, MA 02111-1307, USA.
21: *
22: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
23: * in the United States and other countries.]
24: *
25: * ------------
26: * $Id: ReportDataFactory.java 3048 2007-07-28 18:02:42Z tmorgner $
27: * ------------
28: * (C) Copyright 2000-2005, by Object Refinery Limited.
29: * (C) Copyright 2005-2007, by Pentaho Corporation.
30: */package org.jfree.report;
31:
32: /**
33: * The report data-factory is responsible for querying the data from arbitary
34: * datasources.
35: *
36: * @author Thomas Morgner
37: */
38: public interface ReportDataFactory {
39: public void open();
40:
41: /**
42: * Queries a datasource. The string 'query' defines the name of the query.
43: * The Parameterset given here may contain more data than actually needed.
44: *
45: * The dataset may change between two calls, do not assume anything!
46: *
47: * @param query
48: * @param parameters
49: * @return
50: */
51: public ReportData queryData(final String query,
52: final DataSet parameters) throws ReportDataFactoryException;
53:
54: /**
55: * Closes the report data factory and all report data instances that have
56: * been returned by this instance.
57: */
58: public void close();
59:
60: /**
61: * Derives a freshly initialized report data factory, which is independend
62: * of the original data factory. Opening or Closing one data factory must not
63: * affect the other factories.
64: *
65: * @return
66: */
67: public ReportDataFactory derive();
68: }
|