source/mir/storage/DatabaseAdaptor.java

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