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.*;\r
  35 \r
  36 \r
  37 /**\r
  38  * Interfacedefinition für Datenbank-Adpatoren. Die Adaptoren legen\r
  39  * jeweils das Verhalten und die Befehlsmächtigkeit der Datenbank\r
  40  * fest.\r
  41  *\r
  42  * @author <RK>\r
  43  *\r
  44  * @version $Id: DatabaseAdaptor.java,v 1.3 2002/12/14 01:37:43 zapata Exp $\r
  45  */\r
  46 \r
  47 public interface  DatabaseAdaptor{\r
  48 \r
  49   /* Liefert den Namen der Adaptorklasse\r
  50    * @return Adaptorklasse als String\r
  51    */\r
  52   public abstract String getDriver();\r
  53 \r
  54   /**\r
  55    * Liefert die URL für JDBC zurück, in den die Parameter user, pass und host\r
  56    * eingefügt werden. Die URL wird aus der Konfiguration geholt.\r
  57    *\r
  58    * @param user user als String\r
  59    * @param pass passwort als String\r
  60    * @param host host als String\r
  61    * @return url als String\r
  62    */\r
  63   public abstract String getURL(String user, String pass, String host);\r
  64 \r
  65   /**\r
  66    * Gibt zurück, ob das SQL der Datenbank den <code>limit</code>-Befehl beherrscht.\r
  67    * @return true wenn ja, sonst false\r
  68    */\r
  69   public abstract boolean hasLimit();\r
  70 \r
  71   /**\r
  72        * Liefert zurück, ob der <code>limit</code>-Befehl erst start und dann offset\r
  73        * hat (true), oder umgekehrt. Nur Relevant, wenn hasLimit true zurückliefert.\r
  74    *\r
  75    * @return true wenn erstes, sonst false\r
  76    */\r
  77   public abstract boolean reverseLimit();\r
  78 \r
  79   /**\r
  80    * Liefert ein Properties-Objekt zurueck mit user und password.\r
  81    * @param user\r
  82    * @param password\r
  83    * @return Properties\r
  84    */\r
  85   public abstract Properties getProperties(String user, String password);\r
  86 \r
  87   /**\r
  88    * Gibt SQL-Stringfragment zurück, mit dem nach einem insert-Befehl ermittelt\r
  89    * werden kann, wie man den primary-Key des eingefügten Datensatzes bekommt.\r
  90    *\r
  91    * @param theDB Database-Objekt, aus dem ggf. noetige Informationen geholt\r
  92    * werden können, wie z.B. der Tabellenname\r
  93    * @return SQL-Statement als String\r
  94    */\r
  95   public abstract String getLastInsertSQL(Database theDB);\r
  96 }\r
  97 \r