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  any library licensed under the Apache Software License,
  22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
  23  * (or with modified versions of the above that use the same license as the above),
  24  * and distribute linked combinations including the two.  You must obey the
  25  * GNU General Public License in all respects for all of the code used other than
  26  * the above mentioned libraries.  If you modify this file, you may extend this
  27  * exception to your version of the file, but you are not obligated to do so.
  28  * If you do not wish to do so, delete this exception statement from your version.
  29  */
  30 package mir.storage;
  31
  32 import java.util.Properties;
  33
  34 import mir.config.MirPropertiesConfiguration.PropertiesConfigExc;
  35
  36
  37 /**
  38  * Interfacedefinition f?r Datenbank-Adpatoren. Die Adaptoren legen
  39  * jeweils das Verhalten und die Befehlsm?chtigkeit der Datenbank
  40  * fest.
  41  *
  42  * @author <RK>
  43  *
  44  * @version $Id: DatabaseAdaptor.java,v 1.7 2003/04/21 12:42:47 idfx Exp $
  45  */
  46 public interface DatabaseAdaptor {
  47   /* Liefert den Namen der Adaptorklasse
  48    * @return Adaptorklasse als String
  49    */
  50   public abstract String getDriver() throws PropertiesConfigExc;
  51
  52   /**
  53    * Liefert die URL f?r JDBC zur?ck, in den die Parameter user, pass und host
  54    * eingef?gt werden. Die URL wird aus der Konfiguration geholt.
  55    *
  56    * @param user user als String
  57    * @param pass passwort als String
  58    * @param host host als String
  59    * @return url als String
  60    */
  61   public abstract String getURL(String user, String pass, String host)
  62     throws PropertiesConfigExc;
  63
  64   /**
  65    * Gibt zur?ck, ob das SQL der Datenbank den <code>limit</code>-Befehl beherrscht.
  66    * @return true wenn ja, sonst false
  67    */
  68   public abstract boolean hasLimit();
  69
  70   /**
  71        * Liefert zur?ck, ob der <code>limit</code>-Befehl erst start und dann offset
  72        * hat (true), oder umgekehrt. Nur Relevant, wenn hasLimit true zur?ckliefert.
  73    *
  74    * @return true wenn erstes, sonst false
  75    */
  76   public abstract boolean reverseLimit();
  77
  78   /**
  79    * Liefert ein Properties-Objekt zurueck mit user und password.
  80    * @param user
  81    * @param password
  82    * @return Properties
  83    */
  84   public abstract Properties getProperties(String user, String password);
  85
  86   /**
  87    * Gibt SQL-Stringfragment zur?ck, mit dem nach einem insert-Befehl ermittelt
  88    * werden kann, wie man den primary-Key des eingef?gten Datensatzes bekommt.
  89    *
  90    * @param theDB Database-Objekt, aus dem ggf. noetige Informationen geholt
  91    * werden k?nnen, wie z.B. der Tabellenname
  92    * @return SQL-Statement als String
  93    */
  94   public abstract String getLastInsertSQL(Database theDB);
  95 }