Source code: jbreport/data/PhysicalConnection.java
1 /*
2 * $Id: PhysicalConnection.java,v 1.1.1.1 2000/08/31 13:14:28 grantfin Exp $
3 *
4 * jbReport - A reporting library for Java
5 * Copyright (C) 2000 Grant Finnemore <grantfin@users.sourceforge.net>
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 */
21 package jbreport.data;
22
23 import java.sql.Connection;
24 import java.util.Map;
25
26 import jbreport.ReportException;
27
28 /**
29 * This interface defines the contract that is required for the class to be
30 * pluggable into a Datasource instance.
31 *
32 * <p> Any classes implementing this method should have a public no-args
33 * constructor which can be used by the datasource.
34 *
35 * @author Grant Finnemore
36 * @version $Revision: 1.1.1.1 $
37 */
38 public
39 interface PhysicalConnection {
40
41 /**
42 * This method is called once, just after the instance is created. It
43 * should use the parameters in the map to initialize itself as appropriate.
44 *
45 * @throws ReportException should the initialization fail.
46 */
47 public void initialize(String datasourceType, Map properties)
48 throws ReportException;
49
50 /**
51 * Returns the database connection to the caller
52 */
53 public Connection getConnection() throws ReportException;
54 }