now using MirPropertiesConfiguration
[mir.git] / source / mir / storage / StorageObject.java
index ac85d05..5e63c2b 100755 (executable)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2001, 2002  The Mir-coders group
+ * Copyright (C) 2001, 2002 The Mir-coders group
  *
  * This file is part of Mir.
  *
  * 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.
+ * the code of this program with  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 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.List;
+import java.util.Map;
+
+import freemarker.template.SimpleHash;
+import freemarker.template.SimpleList;
+
+import mir.entity.Entity;
+import mir.entity.EntityList;
 
 
 /**
@@ -193,14 +187,46 @@ public interface StorageObject {
   abstract public Connection getPooledCon() throws StorageObjectFailure;
 
   /**
-   * Dokumentation siehe Database.java
+   *
    * @param a
    * @param sql
-   * @return ResultSet
-   * @exception StorageObjectException, SQLException
+   * @return
+   * @throws StorageObjectFailure
+   * @throws SQLException
    */
-  abstract public ResultSet executeSql(Statement a, String sql)
-    throws StorageObjectFailure, SQLException;
+  abstract public ResultSet executeSql(Statement a, String sql) throws StorageObjectFailure, SQLException;
+
+  /**
+   * Executes 1 sql statement and returns the results as a <code>List</code> of <code>Map</code>s
+   *
+   * @param sql
+   * @return
+   * @throws StorageObjectFailure
+   * @throws StorageObjectExc
+   */
+  abstract public List executeFreeSql(String sql, int aLimit) throws StorageObjectFailure, StorageObjectExc;
+
+  /**
+   * Executes 1 sql statement and returns the first result row as a <<code>Map</code>s
+   * (<code>null</code> if there wasn't any row)
+   *
+   * @param sql
+   * @return
+   * @throws StorageObjectFailure
+   * @throws StorageObjectExc
+   */
+  abstract public Map executeFreeSingleRowSql(String sql) throws StorageObjectFailure, StorageObjectExc ;
+
+  /**
+   * Executes 1 sql statement and returns the first column of the first result row as a <<code>String</code>s
+   * (<code>null</code> if there wasn't any row)
+   *
+   * @param sql
+   * @return
+   * @throws StorageObjectFailure
+   * @throws StorageObjectExc
+   */
+  abstract public String executeFreeSingleValueSql(String sql) throws StorageObjectFailure, StorageObjectExc ;
 
   /**
    * Dokumentation siehe Database.java