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
  32 package  mir.storage;
  33
  34 import java.util.*;
  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.1.1.1.6.1 2002/09/01 21:31:41 mh Exp $
  45  */
  46
  47 public interface  DatabaseAdaptor{
  48
  49          /* Liefert den Namen der Adaptorklasse
  50          * @return Adaptorklasse als String
  51          */
  52         public abstract String getDriver ();
  53
  54
  55         /**
  56          * Liefert die URL für JDBC zurück, in den die Parameter user, pass und host
  57          * eingefügt werden. Die URL wird aus der Konfiguration geholt.
  58          *
  59          * @param user user als String
  60          * @param pass passwort als String
  61          * @param host host als String
  62          * @return url als String
  63          */
  64         public abstract String getURL (String user, String pass, String host);
  65
  66
  67         /**
  68          * Gibt zurück, ob das SQL der Datenbank den <code>limit</code>-Befehl beherrscht.
  69          * @return true wenn ja, sonst false
  70          */
  71         public abstract boolean hasLimit ();
  72
  73
  74         /**
  75          * Liefert zurück, ob der <code>limit</code>-Befehl erst start und dann offset
  76          * hat (true), oder umgekehrt. Nur Relevant, wenn hasLimit true zurückliefert.
  77          *
  78          * @return true wenn erstes, sonst false
  79          */
  80         public abstract boolean reverseLimit ();
  81
  82
  83         /**
  84          * Liefert ein Properties-Objekt zurueck mit user und password.
  85          * @param user
  86          * @param password
  87          * @return Properties
  88          */
  89         public abstract Properties getProperties (String user, String password);
  90
  91
  92         /**
  93          * Gibt SQL-Stringfragment zurück, mit dem nach einem insert-Befehl ermittelt
  94          * werden kann, wie man den primary-Key des eingefügten Datensatzes bekommt.
  95          *
  96          * @param theDB Database-Objekt, aus dem ggf. noetige Informationen geholt
  97          * werden können, wie z.B. der Tabellenname
  98          * @return SQL-Statement als String
  99          */
 100         public abstract String getLastInsertSQL (Database theDB);
 101 }
 102
 103