some small changes delting unneeded imports. two new exceptions in mir.storage. usage...
[mir.git] / source / mir / storage / DatabaseAdaptor.java
1 /*\r
2  * Copyright (C) 2001, 2002  The Mir-coders group\r
3  *\r
4  * This file is part of Mir.\r
5  *\r
6  * Mir is free software; you can redistribute it and/or modify\r
7  * it under the terms of the GNU General Public License as published by\r
8  * the Free Software Foundation; either version 2 of the License, or\r
9  * (at your option) any later version.\r
10  *\r
11  * Mir is distributed in the hope that it will be useful,\r
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
14  * GNU General Public License for more details.\r
15  *\r
16  * You should have received a copy of the GNU General Public License\r
17  * along with Mir; if not, write to the Free Software\r
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
19  *\r
20  * In addition, as a special exception, The Mir-coders gives permission to link\r
21  * the code of this program with the com.oreilly.servlet library, any library\r
22  * licensed under the Apache Software License, The Sun (tm) Java Advanced\r
23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of\r
24  * the above that use the same license as the above), and distribute linked\r
25  * combinations including the two.  You must obey the GNU General Public\r
26  * License in all respects for all of the code used other than the above\r
27  * mentioned libraries.  If you modify this file, you may extend this exception\r
28  * to your version of the file, but you are not obligated to do so.  If you do\r
29  * not wish to do so, delete this exception statement from your version.\r
30  */\r
31 \r
32 package  mir.storage;\r
33 \r
34 import java.util.Properties;\r
35 \r
36 import mir.config.MirPropertiesConfiguration.PropertiesConfigExc;\r
37 \r
38 \r
39 /**\r
40  * Interfacedefinition f?r Datenbank-Adpatoren. Die Adaptoren legen\r
41  * jeweils das Verhalten und die Befehlsm?chtigkeit der Datenbank\r
42  * fest.\r
43  *\r
44  * @author <RK>\r
45  *\r
46  * @version $Id: DatabaseAdaptor.java,v 1.4 2003/01/25 17:45:19 idfx Exp $\r
47  */\r
48 \r
49 public interface  DatabaseAdaptor{\r
50 \r
51   /* Liefert den Namen der Adaptorklasse\r
52    * @return Adaptorklasse als String\r
53    */\r
54   public abstract String getDriver() throws PropertiesConfigExc;\r
55 \r
56   /**\r
57    * Liefert die URL f?r JDBC zur?ck, in den die Parameter user, pass und host\r
58    * eingef?gt werden. Die URL wird aus der Konfiguration geholt.\r
59    *\r
60    * @param user user als String\r
61    * @param pass passwort als String\r
62    * @param host host als String\r
63    * @return url als String\r
64    */\r
65   public abstract String getURL(String user, String pass, String host)\r
66         throws PropertiesConfigExc;\r
67 \r
68   /**\r
69    * Gibt zur?ck, ob das SQL der Datenbank den <code>limit</code>-Befehl beherrscht.\r
70    * @return true wenn ja, sonst false\r
71    */\r
72   public abstract boolean hasLimit();\r
73 \r
74   /**\r
75        * Liefert zur?ck, ob der <code>limit</code>-Befehl erst start und dann offset\r
76        * hat (true), oder umgekehrt. Nur Relevant, wenn hasLimit true zur?ckliefert.\r
77    *\r
78    * @return true wenn erstes, sonst false\r
79    */\r
80   public abstract boolean reverseLimit();\r
81 \r
82   /**\r
83    * Liefert ein Properties-Objekt zurueck mit user und password.\r
84    * @param user\r
85    * @param password\r
86    * @return Properties\r
87    */\r
88   public abstract Properties getProperties(String user, String password);\r
89 \r
90   /**\r
91    * Gibt SQL-Stringfragment zur?ck, mit dem nach einem insert-Befehl ermittelt\r
92    * werden kann, wie man den primary-Key des eingef?gten Datensatzes bekommt.\r
93    *\r
94    * @param theDB Database-Objekt, aus dem ggf. noetige Informationen geholt\r
95    * werden k?nnen, wie z.B. der Tabellenname\r
96    * @return SQL-Statement als String\r
97    */\r
98   public abstract String getLastInsertSQL(Database theDB);\r
99 }\r
100 \r