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 mir.entity.Entity;
40 import mir.entity.EntityList;
43 * Interface for low-level database actions.
46 public interface StorageObject {
47 public Entity selectById(String id) throws StorageObjectExc;
49 public EntityList selectByFieldValue(String aField, String aValue) throws StorageObjectFailure;
51 public EntityList selectByWhereClause(String whereClause) throws StorageObjectFailure;
53 public EntityList selectByWhereClause(String whereClause, int offset) throws StorageObjectFailure;
55 public EntityList selectByWhereClause(String whereClause, String orderBy, int offset) throws StorageObjectFailure;
57 public EntityList selectByWhereClause(String whereClause, String orderBy, int offset, int limit) throws StorageObjectFailure;
59 public EntityList selectByWhereClause(String mainTablePrefix, List extraTables, String aWhereClause, String anOrderByClause, int offset, int limit) throws StorageObjectFailure;
61 public boolean delete(String id) throws StorageObjectFailure;
64 * Deletes entities based on a where clause
66 public int deleteByWhereClause(String aWhereClause) throws StorageObjectFailure;
68 public List getFields() throws StorageObjectFailure;
70 public int[] getTypes() throws StorageObjectFailure;
72 public List getLabels() throws StorageObjectFailure;
74 public void update(Entity a) throws StorageObjectFailure;
76 public String insert(Entity a) throws StorageObjectFailure;
78 public Class getEntityClass();
80 public String getIdName();
82 public String getTableName();
84 public Connection getPooledCon() throws StorageObjectFailure;
86 public ResultSet executeSql(Statement a, String sql) throws StorageObjectFailure, SQLException;
89 * Executes 1 sql statement and returns the results as a <code>List</code> of
92 public List executeFreeSql(String sql, int aLimit) throws StorageObjectFailure, StorageObjectExc;
95 * Executes 1 sql statement and returns the first result row as a <<code>Map</code>s
96 * (<code>null</code> if there wasn't any row)
98 public Map executeFreeSingleRowSql(String sql) throws StorageObjectFailure, StorageObjectExc ;
101 * Executes 1 sql statement and returns the first column of the first result row as a <<code>String</code>s
102 * (<code>null</code> if there wasn't any row)
104 public String executeFreeSingleValueSql(String sql) throws StorageObjectFailure, StorageObjectExc ;
106 public void freeConnection(Connection con, Statement stmt) throws StorageObjectFailure;
108 public int executeUpdate(Statement a, String sql) throws StorageObjectFailure, SQLException;
110 public int executeUpdate(String sql) throws StorageObjectFailure, SQLException;
112 public int getSize(String where) throws SQLException, StorageObjectFailure;
114 public int getSize(String mainTablePrefix, List extraTables, String where) throws SQLException, StorageObjectFailure;