some codeformatting, license for the new classes
[mir.git] / source / mir / storage / StorageObject.java
index b39b28b..773aaed 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
- * Implementiert Interface f?r die Speicherschicht.\r
- * Bislang gibt es in der Bibliothek nur die M?glichkeit\r
- * in einer Datenbank zu speichern.\r
- */\r
-\r
-package mir.storage;\r
-\r
-import java.sql.Connection;\r
-import java.sql.ResultSet;\r
-import java.sql.SQLException;\r
-import java.sql.Statement;\r
-import java.util.ArrayList;\r
-\r
-import mir.entity.Entity;\r
-import mir.entity.EntityList;\r
-import freemarker.template.SimpleHash;\r
-import freemarker.template.SimpleList;\r
-\r
-\r
-/**\r
- * Implementiert Interface f?r die Speicherschicht.\r
- * Bislang gibt es in der Bibliothek nur die M?glichkeit\r
- * in einer Datenbank zu speichern.\r
- * @author RK\r
- * @version    29.6.1999\r
- */\r
-public interface StorageObject {\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @param id\r
-   * @return Entity\r
-   * @exception StorageObjectException\r
-   */\r
-  abstract public Entity selectById(String id) throws StorageObjectExc;\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @param aField\r
-   * @param aValue\r
-   * @return EntityList\r
-   * @exception StorageObjectException\r
-   */\r
-  abstract public EntityList selectByFieldValue(String aField, String aValue) throws\r
-      StorageObjectFailure;\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @param whereClause\r
-   * @return EntityList\r
-   * @exception StorageObjectException\r
-   */\r
-  abstract public EntityList selectByWhereClause(String whereClause) throws\r
-      StorageObjectFailure;\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @param whereClause\r
-   * @param offset\r
-   * @return EntityList\r
-   * @exception StorageObjectException\r
-   */\r
-  abstract public EntityList selectByWhereClause(String whereClause, int offset) throws\r
-      StorageObjectFailure;\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @param whereClause\r
-   * @param orderBy\r
-   * @param offset\r
-   * @return EntityList\r
-   * @exception StorageObjectException\r
-   */\r
-  abstract public EntityList selectByWhereClause(String whereClause,\r
-                                                 String orderBy,\r
-                                                 int offset) throws\r
-      StorageObjectFailure;\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @param whereClause\r
-   * @param orderBy\r
-   * @param offset\r
-   * @param limit\r
-   * @return EntityList\r
-   * @exception StorageObjectException\r
-   */\r
-  abstract public EntityList selectByWhereClause(String whereClause,\r
-                                                 String orderBy,\r
-                                                 int offset, int limit) throws\r
-      StorageObjectFailure;\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @param id\r
-   * @return boolen\r
-   * @exception StorageObjectException\r
-   */\r
-  abstract public boolean delete(String id) throws StorageObjectFailure;\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @return ArrayList\r
-   * @exception StorageObjectException\r
-   */\r
-  abstract public ArrayList getFields() throws StorageObjectFailure;\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @return int[]\r
-   * @exception StorageObjectException\r
-   */\r
-  abstract public int[] getTypes() throws StorageObjectFailure;\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @return ArrayList\r
-   * @exception StorageObjectException\r
-   */\r
-  abstract public ArrayList getLabels() throws StorageObjectFailure;\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @param a\r
-   * @exception StorageObjectException\r
-   */\r
-  abstract public void update(Entity a) throws StorageObjectFailure;\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @param a\r
-   * @return String id\r
-   * @exception StorageObjectException\r
-   */\r
-  abstract public String insert(Entity a) throws StorageObjectFailure;\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @return Class Klasse der Entity\r
-   */\r
-  abstract public Class getEntityClass();\r
-\r
-  /**\r
-   * put your documentation comment here\r
-   * @return\r
-   */\r
-  abstract public String getIdName();\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @return String\r
-   */\r
-  abstract public String getTableName();\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @return SimpleHash\r
-   */\r
-  abstract public SimpleHash getHashData();\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @return Connection\r
-   * @exception StorageObjectException\r
-   */\r
-  abstract public Connection getPooledCon() throws StorageObjectFailure;\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @param a\r
-   * @param sql\r
-   * @return ResultSet\r
-   * @exception StorageObjectException, SQLException\r
-   */\r
-  abstract public ResultSet executeSql(Statement a, String sql) throws\r
-      StorageObjectFailure,\r
-      SQLException;\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @param con\r
-   * @param stmt\r
-   */\r
-  abstract public void freeConnection(Connection con, Statement stmt) throws\r
-      StorageObjectFailure;\r
-\r
-  /**\r
-   * Dokumentation siehe Database.java\r
-   * @return\r
-   */\r
-  abstract public SimpleList getPopupData() throws StorageObjectFailure;\r
-\r
-  abstract public int executeUpdate(Statement a, String sql) throws\r
-      StorageObjectFailure, SQLException;\r
-\r
-  abstract public int executeUpdate(String sql) throws StorageObjectFailure,\r
-      SQLException;\r
-\r
-  abstract public int getSize(String where) throws SQLException,\r
-      StorageObjectFailure;\r
-}\r
-\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.
+ */
+/*
+ * Implementiert Interface f?r die Speicherschicht.
+ * Bislang gibt es in der Bibliothek nur die M?glichkeit
+ * in einer Datenbank zu speichern.
+ */
+package mir.storage;
+
+import freemarker.template.SimpleHash;
+import freemarker.template.SimpleList;
+
+import mir.entity.Entity;
+import mir.entity.EntityList;
+
+import java.sql.Connection;
+import java.sql.ResultSet;
+import java.sql.SQLException;
+import java.sql.Statement;
+
+import java.util.ArrayList;
+
+
+/**
+ * Implementiert Interface f?r die Speicherschicht.
+ * Bislang gibt es in der Bibliothek nur die M?glichkeit
+ * in einer Datenbank zu speichern.
+ * @author RK
+ * @version        29.6.1999
+ */
+public interface StorageObject {
+  /**
+   * Dokumentation siehe Database.java
+   * @param id
+   * @return Entity
+   * @exception StorageObjectException
+   */
+  abstract public Entity selectById(String id) throws StorageObjectExc;
+
+  /**
+   * Dokumentation siehe Database.java
+   * @param aField
+   * @param aValue
+   * @return EntityList
+   * @exception StorageObjectException
+   */
+  abstract public EntityList selectByFieldValue(String aField, String aValue)
+    throws StorageObjectFailure;
+
+  /**
+   * Dokumentation siehe Database.java
+   * @param whereClause
+   * @return EntityList
+   * @exception StorageObjectException
+   */
+  abstract public EntityList selectByWhereClause(String whereClause)
+    throws StorageObjectFailure;
+
+  /**
+   * Dokumentation siehe Database.java
+   * @param whereClause
+   * @param offset
+   * @return EntityList
+   * @exception StorageObjectException
+   */
+  abstract public EntityList selectByWhereClause(String whereClause, int offset)
+    throws StorageObjectFailure;
+
+  /**
+   * Dokumentation siehe Database.java
+   * @param whereClause
+   * @param orderBy
+   * @param offset
+   * @return EntityList
+   * @exception StorageObjectException
+   */
+  abstract public EntityList selectByWhereClause(String whereClause,
+    String orderBy, int offset) throws StorageObjectFailure;
+
+  /**
+   * Dokumentation siehe Database.java
+   * @param whereClause
+   * @param orderBy
+   * @param offset
+   * @param limit
+   * @return EntityList
+   * @exception StorageObjectException
+   */
+  abstract public EntityList selectByWhereClause(String whereClause,
+    String orderBy, int offset, int limit) throws StorageObjectFailure;
+
+  /**
+   * Dokumentation siehe Database.java
+   * @param id
+   * @return boolen
+   * @exception StorageObjectException
+   */
+  abstract public boolean delete(String id) throws StorageObjectFailure;
+
+  /**
+   * Dokumentation siehe Database.java
+   * @return ArrayList
+   * @exception StorageObjectException
+   */
+  abstract public ArrayList getFields() throws StorageObjectFailure;
+
+  /**
+   * Dokumentation siehe Database.java
+   * @return int[]
+   * @exception StorageObjectException
+   */
+  abstract public int[] getTypes() throws StorageObjectFailure;
+
+  /**
+   * Dokumentation siehe Database.java
+   * @return ArrayList
+   * @exception StorageObjectException
+   */
+  abstract public ArrayList getLabels() throws StorageObjectFailure;
+
+  /**
+   * Dokumentation siehe Database.java
+   * @param a
+   * @exception StorageObjectException
+   */
+  abstract public void update(Entity a) throws StorageObjectFailure;
+
+  /**
+   * Dokumentation siehe Database.java
+   * @param a
+   * @return String id
+   * @exception StorageObjectException
+   */
+  abstract public String insert(Entity a) throws StorageObjectFailure;
+
+  /**
+   * Dokumentation siehe Database.java
+   * @return Class Klasse der Entity
+   */
+  abstract public Class getEntityClass();
+
+  /**
+   * put your documentation comment here
+   * @return
+   */
+  abstract public String getIdName();
+
+  /**
+   * Dokumentation siehe Database.java
+   * @return String
+   */
+  abstract public String getTableName();
+
+  /**
+   * Dokumentation siehe Database.java
+   * @return SimpleHash
+   */
+  abstract public SimpleHash getHashData();
+
+  /**
+   * Dokumentation siehe Database.java
+   * @return Connection
+   * @exception StorageObjectException
+   */
+  abstract public Connection getPooledCon() throws StorageObjectFailure;
+
+  /**
+   * Dokumentation siehe Database.java
+   * @param a
+   * @param sql
+   * @return ResultSet
+   * @exception StorageObjectException, SQLException
+   */
+  abstract public ResultSet executeSql(Statement a, String sql)
+    throws StorageObjectFailure, SQLException;
+
+  /**
+   * Dokumentation siehe Database.java
+   * @param con
+   * @param stmt
+   */
+  abstract public void freeConnection(Connection con, Statement stmt)
+    throws StorageObjectFailure;
+
+  /**
+   * Dokumentation siehe Database.java
+   * @return
+   */
+  abstract public SimpleList getPopupData() throws StorageObjectFailure;
+
+  abstract public int executeUpdate(Statement a, String sql)
+    throws StorageObjectFailure, SQLException;
+
+  abstract public int executeUpdate(String sql)
+    throws StorageObjectFailure, SQLException;
+
+  abstract public int getSize(String where)
+    throws SQLException, StorageObjectFailure;
+}