some codeformatting, license for the new classes
[mir.git] / source / mir / storage / DatabaseAdaptor.java
index cc8e4e9..c70030f 100755 (executable)
-/*\r
- * Copyright (C) 2001, 2002  The Mir-coders group\r
- *\r
- * This file is part of Mir.\r
- *\r
- * Mir is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * Mir is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License\r
- * along with Mir; if not, write to the Free Software\r
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
- *\r
- * In addition, as a special exception, The Mir-coders gives permission to link\r
- * the code of this program with the com.oreilly.servlet library, any library\r
- * licensed under the Apache Software License, The Sun (tm) Java Advanced\r
- * Imaging library (JAI), The Sun JIMI library (or with modified versions of\r
- * the above that use the same license as the above), and distribute linked\r
- * combinations including the two.  You must obey the GNU General Public\r
- * License in all respects for all of the code used other than the above\r
- * mentioned libraries.  If you modify this file, you may extend this exception\r
- * to your version of the file, but you are not obligated to do so.  If you do\r
- * not wish to do so, delete this exception statement from your version.\r
- */\r
-\r
-package  mir.storage;\r
-\r
-import java.util.Properties;\r
-\r
-import mir.config.MirPropertiesConfiguration.PropertiesConfigExc;\r
-\r
-\r
-/**\r
- * Interfacedefinition f?r Datenbank-Adpatoren. Die Adaptoren legen\r
- * jeweils das Verhalten und die Befehlsm?chtigkeit der Datenbank\r
- * fest.\r
- *\r
- * @author <RK>\r
- *\r
- * @version $Id: DatabaseAdaptor.java,v 1.4 2003/01/25 17:45:19 idfx Exp $\r
- */\r
-\r
-public interface  DatabaseAdaptor{\r
-\r
-  /* Liefert den Namen der Adaptorklasse\r
-   * @return Adaptorklasse als String\r
-   */\r
-  public abstract String getDriver() throws PropertiesConfigExc;\r
-\r
-  /**\r
-   * Liefert die URL f?r JDBC zur?ck, in den die Parameter user, pass und host\r
-   * eingef?gt werden. Die URL wird aus der Konfiguration geholt.\r
-   *\r
-   * @param user user als String\r
-   * @param pass passwort als String\r
-   * @param host host als String\r
-   * @return url als String\r
-   */\r
-  public abstract String getURL(String user, String pass, String host)\r
-       throws PropertiesConfigExc;\r
-\r
-  /**\r
-   * Gibt zur?ck, ob das SQL der Datenbank den <code>limit</code>-Befehl beherrscht.\r
-   * @return true wenn ja, sonst false\r
-   */\r
-  public abstract boolean hasLimit();\r
-\r
-  /**\r
-       * Liefert zur?ck, ob der <code>limit</code>-Befehl erst start und dann offset\r
-       * hat (true), oder umgekehrt. Nur Relevant, wenn hasLimit true zur?ckliefert.\r
-   *\r
-   * @return true wenn erstes, sonst false\r
-   */\r
-  public abstract boolean reverseLimit();\r
-\r
-  /**\r
-   * Liefert ein Properties-Objekt zurueck mit user und password.\r
-   * @param user\r
-   * @param password\r
-   * @return Properties\r
-   */\r
-  public abstract Properties getProperties(String user, String password);\r
-\r
-  /**\r
-   * Gibt SQL-Stringfragment zur?ck, mit dem nach einem insert-Befehl ermittelt\r
-   * werden kann, wie man den primary-Key des eingef?gten Datensatzes bekommt.\r
-   *\r
-   * @param theDB Database-Objekt, aus dem ggf. noetige Informationen geholt\r
-   * werden k?nnen, wie z.B. der Tabellenname\r
-   * @return SQL-Statement als String\r
-   */\r
-  public abstract String getLastInsertSQL(Database theDB);\r
-}\r
-\r
+/*
+ * Copyright (C) 2001, 2002  The Mir-coders group
+ *
+ * This file is part of Mir.
+ *
+ * Mir is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * Mir is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Mir; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ * In addition, as a special exception, The Mir-coders gives permission to link
+ * the code of this program with the com.oreilly.servlet library, any library
+ * licensed under the Apache Software License, The Sun (tm) Java Advanced
+ * Imaging library (JAI), The Sun JIMI library (or with modified versions of
+ * the above that use the same license as the above), and distribute linked
+ * combinations including the two.  You must obey the GNU General Public
+ * License in all respects for all of the code used other than the above
+ * mentioned libraries.  If you modify this file, you may extend this exception
+ * to your version of the file, but you are not obligated to do so.  If you do
+ * not wish to do so, delete this exception statement from your version.
+ */
+package mir.storage;
+
+import mir.config.MirPropertiesConfiguration.PropertiesConfigExc;
+
+import java.util.Properties;
+
+
+/**
+ * Interfacedefinition f?r Datenbank-Adpatoren. Die Adaptoren legen
+ * jeweils das Verhalten und die Befehlsm?chtigkeit der Datenbank
+ * fest.
+ *
+ * @author <RK>
+ *
+ * @version $Id: DatabaseAdaptor.java,v 1.5 2003/01/28 21:48:30 idfx Exp $
+ */
+public interface DatabaseAdaptor {
+  /* Liefert den Namen der Adaptorklasse
+   * @return Adaptorklasse als String
+   */
+  public abstract String getDriver() throws PropertiesConfigExc;
+
+  /**
+   * Liefert die URL f?r JDBC zur?ck, in den die Parameter user, pass und host
+   * eingef?gt werden. Die URL wird aus der Konfiguration geholt.
+   *
+   * @param user user als String
+   * @param pass passwort als String
+   * @param host host als String
+   * @return url als String
+   */
+  public abstract String getURL(String user, String pass, String host)
+    throws PropertiesConfigExc;
+
+  /**
+   * Gibt zur?ck, ob das SQL der Datenbank den <code>limit</code>-Befehl beherrscht.
+   * @return true wenn ja, sonst false
+   */
+  public abstract boolean hasLimit();
+
+  /**
+       * Liefert zur?ck, ob der <code>limit</code>-Befehl erst start und dann offset
+       * hat (true), oder umgekehrt. Nur Relevant, wenn hasLimit true zur?ckliefert.
+   *
+   * @return true wenn erstes, sonst false
+   */
+  public abstract boolean reverseLimit();
+
+  /**
+   * Liefert ein Properties-Objekt zurueck mit user und password.
+   * @param user
+   * @param password
+   * @return Properties
+   */
+  public abstract Properties getProperties(String user, String password);
+
+  /**
+   * Gibt SQL-Stringfragment zur?ck, mit dem nach einem insert-Befehl ermittelt
+   * werden kann, wie man den primary-Key des eingef?gten Datensatzes bekommt.
+   *
+   * @param theDB Database-Objekt, aus dem ggf. noetige Informationen geholt
+   * werden k?nnen, wie z.B. der Tabellenname
+   * @return SQL-Statement als String
+   */
+  public abstract String getLastInsertSQL(Database theDB);
+}