2 * Copyright (C) 2001, 2002 The Mir-coders group
4 * This file is part of Mir.
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.
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.
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
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.
32 import java.sql.Connection;
33 import java.sql.ResultSet;
34 import java.sql.SQLException;
35 import java.sql.Statement;
36 import java.util.List;
39 import freemarker.template.SimpleHash;
40 import freemarker.template.SimpleList;
42 import mir.entity.Entity;
43 import mir.entity.EntityList;
47 * Implementiert Interface f?r die Speicherschicht.
48 * Bislang gibt es in der Bibliothek nur die M?glichkeit
49 * in einer Datenbank zu speichern.
53 public interface StorageObject {
55 * Dokumentation siehe Database.java
58 * @exception StorageObjectException
60 abstract public Entity selectById(String id) throws StorageObjectExc;
63 * Dokumentation siehe Database.java
67 * @exception StorageObjectException
69 abstract public EntityList selectByFieldValue(String aField, String aValue)
70 throws StorageObjectFailure;
73 * Dokumentation siehe Database.java
76 * @exception StorageObjectException
78 abstract public EntityList selectByWhereClause(String whereClause)
79 throws StorageObjectFailure;
82 * Dokumentation siehe Database.java
86 * @exception StorageObjectException
88 abstract public EntityList selectByWhereClause(String whereClause, int offset)
89 throws StorageObjectFailure;
92 * Dokumentation siehe Database.java
97 * @exception StorageObjectException
99 abstract public EntityList selectByWhereClause(String whereClause,
100 String orderBy, int offset) throws StorageObjectFailure;
103 * Dokumentation siehe Database.java
109 * @exception StorageObjectException
111 abstract public EntityList selectByWhereClause(String whereClause,
112 String orderBy, int offset, int limit) throws StorageObjectFailure;
115 * Dokumentation siehe Database.java
118 * @exception StorageObjectException
120 abstract public boolean delete(String id) throws StorageObjectFailure;
123 * Dokumentation siehe Database.java
125 * @exception StorageObjectException
127 abstract public List getFields() throws StorageObjectFailure;
130 * Dokumentation siehe Database.java
132 * @exception StorageObjectException
134 abstract public int[] getTypes() throws StorageObjectFailure;
137 * Dokumentation siehe Database.java
139 * @exception StorageObjectException
141 abstract public List getLabels() throws StorageObjectFailure;
144 * Dokumentation siehe Database.java
146 * @exception StorageObjectException
148 abstract public void update(Entity a) throws StorageObjectFailure;
151 * Dokumentation siehe Database.java
154 * @exception StorageObjectException
156 abstract public String insert(Entity a) throws StorageObjectFailure;
159 * Dokumentation siehe Database.java
160 * @return Class Klasse der Entity
162 abstract public Class getEntityClass();
165 * put your documentation comment here
168 abstract public String getIdName();
171 * Dokumentation siehe Database.java
174 abstract public String getTableName();
177 * Dokumentation siehe Database.java
180 abstract public SimpleHash getHashData();
183 * Dokumentation siehe Database.java
185 * @exception StorageObjectException
187 abstract public Connection getPooledCon() throws StorageObjectFailure;
194 * @throws StorageObjectFailure
195 * @throws SQLException
197 abstract public ResultSet executeSql(Statement a, String sql) throws StorageObjectFailure, SQLException;
203 * @throws StorageObjectFailure
204 * @throws SQLException
206 abstract public ResultSet executeSql(String sql) throws StorageObjectFailure, SQLException;
209 * Executes 1 sql statement and returns the results as a <code>List</code> of <code>Map</code>s
213 * @throws StorageObjectFailure
214 * @throws StorageObjectExc
216 abstract public List executeFreeSql(String sql, int aLimit) throws StorageObjectFailure, StorageObjectExc;
219 * Executes 1 sql statement and returns the first result row as a <<code>Map</code>s
220 * (<code>null</code> if there wasn't any row)
224 * @throws StorageObjectFailure
225 * @throws StorageObjectExc
227 abstract public Map executeFreeSingleRowSql(String sql) throws StorageObjectFailure, StorageObjectExc ;
230 * Executes 1 sql statement and returns the first column of the first result row as a <<code>String</code>s
231 * (<code>null</code> if there wasn't any row)
235 * @throws StorageObjectFailure
236 * @throws StorageObjectExc
238 abstract public String executeFreeSingleValueSql(String sql) throws StorageObjectFailure, StorageObjectExc ;
241 * Dokumentation siehe Database.java
245 abstract public void freeConnection(Connection con, Statement stmt)
246 throws StorageObjectFailure;
249 * Dokumentation siehe Database.java
252 abstract public SimpleList getPopupData() throws StorageObjectFailure;
254 abstract public int executeUpdate(Statement a, String sql)
255 throws StorageObjectFailure, SQLException;
257 abstract public int executeUpdate(String sql)
258 throws StorageObjectFailure, SQLException;
260 abstract public int getSize(String where)
261 throws SQLException, StorageObjectFailure;