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.io.IOException;
33 import java.io.InputStreamReader;
34 import java.sql.Connection;
35 import java.sql.PreparedStatement;
36 import java.sql.ResultSet;
37 import java.sql.ResultSetMetaData;
38 import java.sql.SQLException;
39 import java.sql.Statement;
40 import java.sql.Timestamp;
41 import java.text.ParseException;
42 import java.text.SimpleDateFormat;
43 import java.util.ArrayList;
44 import java.util.Calendar;
45 import java.util.GregorianCalendar;
46 import java.util.HashMap;
47 import java.util.Iterator;
48 import java.util.List;
50 import java.util.TimeZone;
51 import java.util.Vector;
53 import mir.config.MirPropertiesConfiguration;
54 import mir.config.MirPropertiesConfiguration.PropertiesConfigExc;
55 import mir.entity.Entity;
56 import mir.entity.EntityList;
57 import mir.entity.StorableObjectEntity;
58 import mir.log.LoggerWrapper;
59 import mir.misc.StringUtil;
60 import mir.storage.store.ObjectStore;
61 import mir.storage.store.StorableObject;
62 import mir.storage.store.StoreContainerType;
63 import mir.storage.store.StoreIdentifier;
64 import mir.storage.store.StoreUtil;
65 import mir.util.JDBCStringRoutines;
67 import com.codestudio.util.SQLManager;
71 * Diese Klasse implementiert die Zugriffsschicht auf die Datenbank.
72 * Alle Projektspezifischen Datenbankklassen erben von dieser Klasse.
73 * In den Unterklassen wird im Minimalfall nur die Tabelle angegeben.
74 * Im Konfigurationsfile findet sich eine Verweis auf den verwendeten
75 * Treiber, Host, User und Passwort, ueber den der Zugriff auf die
78 * @version $Id: Database.java,v 1.44.2.11 2003/11/24 23:37:18 rk Exp $
82 public class Database implements StorageObject {
83 private static Class GENERIC_ENTITY_CLASS = mir.entity.StorableObjectEntity.class;
84 private static Class STORABLE_OBJECT_ENTITY_CLASS = mir.entity.StorableObjectEntity.class;
87 private static Map POPUP_EMPTYLINE = new HashMap();
88 protected static final ObjectStore o_store = ObjectStore.getInstance();
89 private static final int _millisPerHour = 60 * 60 * 1000;
90 private static final int _millisPerMinute = 60 * 1000;
93 // always same object saves a little space
94 POPUP_EMPTYLINE.put("key", "");
95 POPUP_EMPTYLINE.put("value", "--");
98 protected LoggerWrapper logger;
99 protected MirPropertiesConfiguration configuration;
100 protected String theTable;
101 protected String theCoreTable = null;
102 protected String thePKeyName = "id";
103 protected int thePKeyType;
104 protected int thePKeyIndex;
105 protected boolean evaluatedMetaData = false;
106 protected ArrayList metadataFields;
107 protected ArrayList metadataLabels;
108 protected ArrayList metadataNotNullFields;
109 protected int[] metadataTypes;
110 protected Class theEntityClass;
111 protected List popupCache = null;
112 protected boolean hasPopupCache = false;
113 protected Map hashCache = null;
114 protected boolean hasTimestamp = true;
115 private String database_driver;
116 private String database_url;
117 private int defaultLimit;
120 SimpleDateFormat internalDateFormat;
121 SimpleDateFormat userInputDateFormat;
123 private SimpleDateFormat _dateFormatterOut;
124 private SimpleDateFormat _dateFormatterIn;
125 _dateFormatterOut = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
126 _dateFormatterIn = new SimpleDateFormat("yyyy-MM-dd HH:mm");
130 * Kontruktor bekommt den Filenamen des Konfigurationsfiles ?bergeben.
131 * Aus diesem file werden <code>Database.Logfile</code>,
132 * <code>Database.Username</code>,<code>Database.Password</code>,
133 * <code>Database.Host</code> und <code>Database.Adaptor</code>
134 * ausgelesen und ein Broker f?r die Verbindugen zur Datenbank
137 * @param String confFilename Dateiname der Konfigurationsdatei
139 public Database() throws StorageObjectFailure {
141 configuration = MirPropertiesConfiguration.instance();
143 catch (PropertiesConfigExc e) {
144 throw new StorageObjectFailure(e);
146 logger = new LoggerWrapper("Database");
147 timezone = TimeZone.getTimeZone(configuration.getString("Mir.DefaultTimezone"));
148 internalDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
149 internalDateFormat.setTimeZone(timezone);
151 userInputDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm");
152 userInputDateFormat.setTimeZone(timezone);
155 String theAdaptorName = configuration.getString("Database.Adaptor");
156 defaultLimit = Integer.parseInt(configuration.getString("Database.Limit"));
159 theEntityClass = GENERIC_ENTITY_CLASS;
161 catch (Throwable e) {
162 logger.error("Error in Database() constructor with " + theAdaptorName + " -- " + e.getMessage());
163 throw new StorageObjectFailure("Error in Database() constructor.", e);
168 * Liefert die Entity-Klasse zur?ck, in der eine Datenbankzeile gewrappt
169 * wird. Wird die Entity-Klasse durch die erbende Klasse nicht ?berschrieben,
170 * wird eine mir.entity.GenericEntity erzeugt.
172 * @return Class-Objekt der Entity
174 public java.lang.Class getEntityClass() {
175 return theEntityClass;
179 * Liefert die Standardbeschr?nkung von select-Statements zur?ck, also
180 * wieviel Datens?tze per Default selektiert werden.
182 * @return Standard-Anzahl der Datens?tze
184 public int getLimit() {
189 * Liefert den Namen des Primary-Keys zur?ck. Wird die Variable nicht von
190 * der erbenden Klasse ?berschrieben, so ist der Wert <code>PKEY</code>
191 * @return Name des Primary-Keys
193 public String getIdName() {
198 * Liefert den Namen der Tabelle, auf das sich das Datenbankobjekt bezieht.
200 * @return Name der Tabelle
202 public String getTableName() {
207 * Dient dazu vererbte Tabellen bei objectrelationalen DBMS
208 * zu speichern, wenn die id einer Tabelle in der parenttabelle verwaltet
210 * @return liefert theCoreTabel als String zurueck, wenn gesetzt, sonst
213 public String getCoreTable() {
214 if (theCoreTable != null) {
223 * Liefert Feldtypen der Felder der Tabelle zurueck (s.a. java.sql.Types)
224 * @return int-Array mit den Typen der Felder
225 * @exception StorageObjectException
227 public int[] getTypes() throws StorageObjectFailure {
228 if (metadataTypes == null) {
232 return metadataTypes;
236 * Liefert eine Liste der Labels der Tabellenfelder
237 * @return ArrayListe mit Labeln
238 * @exception StorageObjectException
240 public List getLabels() throws StorageObjectFailure {
241 if (metadataLabels == null) {
245 return metadataLabels;
249 * Liefert eine Liste der Felder der Tabelle
250 * @return ArrayList mit Feldern
251 * @exception StorageObjectException
253 public List getFields() throws StorageObjectFailure {
254 if (metadataFields == null) {
258 return metadataFields;
262 * Gets value out of ResultSet according to type and converts to String
263 * @param rs ResultSet.
264 * @param aType a type from java.sql.Types.*
265 * @param index index in ResultSet
266 * @return returns the value as String. If no conversion is possible
267 * /unsupported value/ is returned
269 private String getValueAsString(ResultSet rs, int valueIndex, int aType)
270 throws StorageObjectFailure {
271 String outValue = null;
276 case java.sql.Types.BIT:
277 outValue = (rs.getBoolean(valueIndex) == true) ? "1" : "0";
281 case java.sql.Types.INTEGER:
282 case java.sql.Types.SMALLINT:
283 case java.sql.Types.TINYINT:
284 case java.sql.Types.BIGINT:
286 int out = rs.getInt(valueIndex);
289 outValue = new Integer(out).toString();
294 case java.sql.Types.NUMERIC:
296 /** @todo Numeric can be float or double depending upon
297 * metadata.getScale() / especially with oracle */
298 long outl = rs.getLong(valueIndex);
301 outValue = new Long(outl).toString();
306 case java.sql.Types.REAL:
308 float tempf = rs.getFloat(valueIndex);
314 int tempf_int = (int) tempf;
315 tempf = (float) tempf_int;
317 outValue = "" + tempf;
318 outValue = outValue.replace('.', ',');
323 case java.sql.Types.DOUBLE:
325 double tempd = rs.getDouble(valueIndex);
331 int tempd_int = (int) tempd;
332 tempd = (double) tempd_int;
334 outValue = "" + tempd;
335 outValue = outValue.replace('.', ',');
340 case java.sql.Types.CHAR:
341 case java.sql.Types.VARCHAR:
342 case java.sql.Types.LONGVARCHAR:
343 outValue = rs.getString(valueIndex);
347 case java.sql.Types.LONGVARBINARY:
348 outValue = rs.getString(valueIndex);
352 case java.sql.Types.TIMESTAMP:
354 // it's important to use Timestamp here as getting it
355 // as a string is undefined and is only there for debugging
356 // according to the API. we can make it a string through formatting.
358 Timestamp timestamp = (rs.getTimestamp(valueIndex));
361 java.util.Date date = new java.util.Date(timestamp.getTime());
363 Calendar calendar = new GregorianCalendar();
364 calendar.setTime(date);
365 calendar.setTimeZone(timezone);
366 outValue = internalDateFormat.format(date);
368 int offset = calendar.get(Calendar.ZONE_OFFSET) + calendar.get(Calendar.DST_OFFSET);
369 String tzOffset = StringUtil.zeroPaddingNumber(Math.abs(offset) / _millisPerHour, 2, 2);
372 outValue = outValue + "-";
374 outValue = outValue + "+";
375 outValue = outValue + tzOffset;
381 outValue = "<unsupported value>";
382 logger.warn("Unsupported Datatype: at " + valueIndex + " (" + aType + ")");
384 } catch (SQLException e) {
385 throw new StorageObjectFailure("Could not get Value out of Resultset -- ",
394 * select-Operator um einen Datensatz zu bekommen.
395 * @param id Primaerschluessel des Datensatzes.
396 * @return liefert EntityObject des gefundenen Datensatzes oder null.
398 public Entity selectById(String id) throws StorageObjectExc {
399 if ((id == null) || id.equals("")) {
400 throw new StorageObjectExc("Database.selectById: Missing id");
403 // ask object store for object
404 if (StoreUtil.implementsStorableObject(theEntityClass)) {
405 String uniqueId = id;
407 if (theEntityClass.equals(StorableObjectEntity.class)) {
408 uniqueId += ("@" + theTable);
411 StoreIdentifier search_sid = new StoreIdentifier(theEntityClass, uniqueId);
412 logger.debug("CACHE: (dbg) looking for sid " + search_sid.toString());
414 Entity hit = (Entity) o_store.use(search_sid);
421 Statement stmt = null;
422 Connection con = getPooledCon();
423 Entity returnEntity = null;
428 /** @todo better prepared statement */
430 "select * from " + theTable + " where " + thePKeyName + "=" + id;
431 stmt = con.createStatement();
432 rs = executeSql(stmt, selectSql);
435 if (evaluatedMetaData == false) {
436 evalMetaData(rs.getMetaData());
440 returnEntity = makeEntityFromResultSet(rs);
443 logger.debug("No data for id: " + id + " in table " + theTable);
449 logger.debug("No Data for Id " + id + " in Table " + theTable);
452 catch (SQLException sqe) {
453 throwSQLException(sqe, "selectById");
456 catch (NumberFormatException e) {
457 logger.error("ID is no number: " + id);
460 freeConnection(con, stmt);
467 * This method makes it possible to make selects across multiple tables
469 * @param mainTablePrefix prefix for the mainTable
470 * @param extraTables a vector of tables for relational select
471 * @param aWhereClause whereClause
472 * @return EntityList of selected Objects
473 * @throws StorageObjectFailure
476 public EntityList selectByWhereClauseWithExtraTables(String mainTablePrefix,
477 List extraTables, String aWhereClause )
478 throws StorageObjectFailure {
479 return selectByWhereClause( mainTablePrefix, extraTables, aWhereClause, "", 0, -1);
483 * select-Operator um Datensaetze zu bekommen, die key = value erfuellen.
484 * @param key Datenbankfeld der Bedingung.
485 * @param value Wert die der key anehmen muss.
486 * @return EntityList mit den gematchten Entities
488 public EntityList selectByFieldValue(String aField, String aValue) throws StorageObjectFailure {
489 return selectByFieldValue(aField, aValue, 0);
493 * select-Operator um Datensaetze zu bekommen, die key = value erfuellen.
494 * @param key Datenbankfeld der Bedingung.
495 * @param value Wert die der key anehmen muss.
496 * @param offset Gibt an ab welchem Datensatz angezeigt werden soll.
497 * @return EntityList mit den gematchten Entities
499 public EntityList selectByFieldValue(String aField, String aValue, int offset) throws StorageObjectFailure {
500 return selectByWhereClause(aField + "=" + aValue, offset);
504 * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.
505 * Also offset wird der erste Datensatz genommen.
507 * @param wc where-Clause
508 * @return EntityList mit den gematchten Entities
509 * @exception StorageObjectException
511 public EntityList selectByWhereClause(String where) throws StorageObjectFailure {
512 return selectByWhereClause(where, 0);
516 * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.
517 * Als maximale Anzahl wird das Limit auf der Konfiguration genommen.
519 * @param wc where-Clause
520 * @param offset ab welchem Datensatz.
521 * @return EntityList mit den gematchten Entities
522 * @exception StorageObjectException
524 public EntityList selectByWhereClause(String whereClause, int offset) throws StorageObjectFailure {
525 return selectByWhereClause(whereClause, null, offset);
529 * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.
530 * Also offset wird der erste Datensatz genommen.
531 * Als maximale Anzahl wird das Limit auf der Konfiguration genommen.
533 * @param wc where-Clause
534 * @param ob orderBy-Clause
535 * @return EntityList mit den gematchten Entities
536 * @exception StorageObjectException
538 public EntityList selectByWhereClause(String where, String order) throws StorageObjectFailure {
539 return selectByWhereClause(where, order, 0);
543 * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.
544 * Als maximale Anzahl wird das Limit auf der Konfiguration genommen.
546 * @param wc where-Clause
547 * @param ob orderBy-Clause
548 * @param offset ab welchem Datensatz
549 * @return EntityList mit den gematchten Entities
550 * @exception StorageObjectException
552 public EntityList selectByWhereClause(String whereClause, String orderBy, int offset) throws StorageObjectFailure {
553 return selectByWhereClause(whereClause, orderBy, offset, defaultLimit);
557 * select-Operator returns EntityList with matching rows in Database.
558 * @param aWhereClause where-Clause
559 * @param anOrderByClause orderBy-Clause
560 * @param offset ab welchem Datensatz
561 * @param limit wieviele Datens?tze
562 * @return EntityList mit den gematchten Entities
563 * @exception StorageObjectException
565 public EntityList selectByWhereClause(String aWhereClause, String anOrderByClause,
566 int offset, int limit) throws StorageObjectFailure {
567 return selectByWhereClause("", null, aWhereClause, anOrderByClause, offset, limit);
571 * select-Operator returns EntityList with matching rows in Database.
572 * @param aWhereClause where-Clause
573 * @param anOrderByClause orderBy-Clause
574 * @param offset ab welchem Datensatz
575 * @param limit wieviele Datens?tze
576 * @return EntityList mit den gematchten Entities
577 * @exception StorageObjectException
579 public EntityList selectByWhereClause(String mainTablePrefix, List extraTables,
580 String aWhereClause, String anOrderByClause,
581 int offset, int limit) throws StorageObjectFailure {
584 String useTable = theTable;
585 String selectStar = "*";
586 if (mainTablePrefix!=null && mainTablePrefix.trim().length()>0) {
587 useTable+=" "+mainTablePrefix;
588 selectStar=mainTablePrefix.trim() + ".*";
591 // check o_store for entitylist
592 // only if no relational select
593 if (extraTables==null) {
594 if (StoreUtil.implementsStorableObject(theEntityClass)) {
595 StoreIdentifier search_sid =
597 theEntityClass, StoreContainerType.STOC_TYPE_ENTITYLIST,
598 StoreUtil.getEntityListUniqueIdentifierFor(useTable, aWhereClause, anOrderByClause, offset, limit));
599 EntityList hit = (EntityList) o_store.use(search_sid);
602 logger.debug("CACHE (hit): " + search_sid.toString());
610 EntityList theReturnList = null;
611 Connection con = null;
612 Statement stmt = null;
617 // build sql-statement
619 if ((aWhereClause != null) && (aWhereClause.trim().length() == 0)) {
623 StringBuffer countSql =
624 new StringBuffer("select count(*) from ").append(useTable);
625 StringBuffer selectSql =
626 new StringBuffer("select "+selectStar+" from ").append(useTable);
628 // append extratables, if necessary
629 if (extraTables!=null) {
630 for (int i=0;i < extraTables.size();i++) {
631 countSql.append( ", " + extraTables.get(i));
632 selectSql.append( ", " + extraTables.get(i));
636 if (aWhereClause != null) {
637 selectSql.append(" where ").append(aWhereClause);
638 countSql.append(" where ").append(aWhereClause);
641 if ((anOrderByClause != null) && !(anOrderByClause.trim().length() == 0)) {
642 selectSql.append(" order by ").append(anOrderByClause);
645 if ((limit > -1) && (offset > -1)) {
646 selectSql.append(" LIMIT ").append(limit).append(" OFFSET ").append(offset);
651 con = getPooledCon();
652 stmt = con.createStatement();
655 rs = executeSql(stmt, selectSql.toString());
658 if (!evaluatedMetaData) {
659 evalMetaData(rs.getMetaData());
662 theReturnList = new EntityList();
663 Entity theResultEntity;
665 theResultEntity = makeEntityFromResultSet(rs);
666 theReturnList.add(theResultEntity);
672 // making entitylist infos
675 if (theReturnList != null) {
676 // now we decide if we have to know an overall count...
679 if ((limit > -1) && (offset > -1)) {
680 if (offsetCount == limit) {
681 rs = executeSql(stmt, countSql.toString());
685 count = rs.getInt(1);
691 logger.error("Could not count: " + countSql);
696 theReturnList.setCount(count);
697 theReturnList.setOffset(offset);
698 theReturnList.setWhere(aWhereClause);
699 theReturnList.setOrder(anOrderByClause);
700 theReturnList.setStorage(this);
701 theReturnList.setLimit(limit);
703 if (offset >= limit) {
704 theReturnList.setPrevBatch(offset - limit);
707 if ((offset + offsetCount) < count) {
708 theReturnList.setNextBatch(offset + limit);
711 if (extraTables==null && StoreUtil.implementsStorableObject(theEntityClass)) {
712 StoreIdentifier sid = theReturnList.getStoreIdentifier();
713 logger.debug("CACHE (add): " + sid.toString());
718 catch (SQLException sqe) {
719 throwSQLException(sqe, "selectByWhereClause");
724 freeConnection(con, stmt);
726 } catch (Throwable t) {
730 return theReturnList;
734 * Bastelt aus einer Zeile der Datenbank ein EntityObjekt.
736 * @param rs Das ResultSetObjekt.
737 * @return Entity Die Entity.
739 private Entity makeEntityFromResultSet(ResultSet rs)
740 throws StorageObjectFailure {
741 /** @todo OS: get Pkey from ResultSet and consult ObjectStore */
742 Map theResultHash = new HashMap();
743 String theResult = null;
745 Entity returnEntity = null;
748 int size = metadataFields.size();
750 for (int i = 0; i < size; i++) {
751 // alle durchlaufen bis nix mehr da
752 theType = metadataTypes[i];
754 if (theType == java.sql.Types.LONGVARBINARY) {
755 InputStreamReader is =
756 (InputStreamReader) rs.getCharacterStream(i + 1);
759 char[] data = new char[32768];
760 StringBuffer theResultString = new StringBuffer();
763 while ((len = is.read(data)) > 0) {
764 theResultString.append(data, 0, len);
768 theResult = theResultString.toString();
773 theResult = getValueAsString(rs, (i + 1), theType);
776 if (theResult != null) {
777 theResultHash.put(metadataFields.get(i), theResult);
781 if (theEntityClass != null) {
782 returnEntity = (Entity) theEntityClass.newInstance();
783 returnEntity.setStorage(this);
784 returnEntity.setValues(theResultHash);
786 if (returnEntity instanceof StorableObject) {
787 logger.debug("CACHE: ( in) " + returnEntity.getId() + " :" + theTable);
788 o_store.add(((StorableObject) returnEntity).getStoreIdentifier());
791 throwStorageObjectException("Internal Error: theEntityClass not set!");
794 catch (IllegalAccessException e) {
795 throwStorageObjectException("No access! -- " + e.getMessage());
797 catch (IOException e) {
798 throwStorageObjectException("IOException! -- " + e.getMessage());
800 catch (InstantiationException e) {
801 throwStorageObjectException("No Instatiation! -- " + e.getMessage());
803 catch (SQLException sqe) {
804 throwSQLException(sqe, "makeEntityFromResultSet");
813 * Inserts an entity into the database.
816 * @return der Wert des Primary-keys der eingef?gten Entity
818 public String insert(Entity theEntity) throws StorageObjectFailure {
820 invalidatePopupCache();
822 // invalidating all EntityLists corresponding with theEntityClass
823 if (StoreUtil.implementsStorableObject(theEntityClass)) {
824 StoreContainerType stoc_type =
825 StoreContainerType.valueOf(theEntityClass,
826 StoreContainerType.STOC_TYPE_ENTITYLIST);
827 o_store.invalidate(stoc_type);
830 String returnId = null;
831 Connection con = null;
832 PreparedStatement pstmt = null;
835 List streamedInput = theEntity.streamedInput();
836 StringBuffer f = new StringBuffer();
837 StringBuffer v = new StringBuffer();
840 boolean firstField = true;
843 for (int i = 0; i < getFields().size(); i++) {
844 aField = (String) getFields().get(i);
846 if (!aField.equals(thePKeyName)) {
850 if (!theEntity.hasValueForField(aField) && (
851 aField.equals("webdb_create") ||
852 aField.equals("webdb_lastchange"))) {
856 if ((streamedInput != null) && streamedInput.contains(aField)) {
860 if (theEntity.hasValueForField(aField)) {
863 JDBCStringRoutines.escapeStringLiteral((String) theEntity.getValue(aField)) + "'";
868 // wenn Wert gegeben, dann einbauen
869 if (aValue != null) {
870 if (firstField == false) {
886 StringBuffer sqlBuf =
887 new StringBuffer("insert into ").append(theTable).append("(").append(f)
888 .append(") values (").append(v).append(")");
889 String sql = sqlBuf.toString();
891 logger.debug("INSERT: " + sql);
892 con = getPooledCon();
893 con.setAutoCommit(false);
894 pstmt = con.prepareStatement(sql);
896 if (streamedInput != null) {
897 for (int i = 0; i < streamedInput.size(); i++) {
899 (String) theEntity.getValue((String) streamedInput.get(i));
900 pstmt.setBytes(i + 1, inputString.getBytes());
904 int ret = pstmt.executeUpdate();
911 pstmt = con.prepareStatement("select currval('" + getCoreTable() + "_id_seq')");
913 ResultSet rs = pstmt.executeQuery();
915 returnId = rs.getString(1);
916 theEntity.setId(returnId);
918 catch (SQLException sqe) {
919 throwSQLException(sqe, "insert");
923 con.setAutoCommit(true);
925 catch (Exception e) {
928 freeConnection(con, pstmt);
931 /** @todo store entity in o_store */
936 * Updates an entity in the database
940 public void update(Entity theEntity) throws StorageObjectFailure {
941 Connection con = null;
942 PreparedStatement pstmt = null;
944 /** @todo this is stupid: why do we prepare statement, when we
945 * throw it away afterwards. should be regular statement
946 * update/insert could better be one routine called save()
947 * that chooses to either insert or update depending if we
948 * have a primary key in the entity. i don't know if we
949 * still need the streamed input fields. // rk */
950 /** @todo extension: check if Entity did change, otherwise we don't need
951 * the roundtrip to the database */
952 /** invalidating corresponding entitylists in o_store*/
953 if (StoreUtil.implementsStorableObject(theEntityClass)) {
954 StoreContainerType stoc_type =
955 StoreContainerType.valueOf(theEntityClass,
956 StoreContainerType.STOC_TYPE_ENTITYLIST);
957 o_store.invalidate(stoc_type);
960 List streamedInput = theEntity.streamedInput();
961 String id = theEntity.getId();
963 StringBuffer fv = new StringBuffer();
964 boolean firstField = true;
967 invalidatePopupCache();
969 // build sql statement
970 for (int i = 0; i < getFields().size(); i++) {
971 aField = (String) metadataFields.get(i);
974 if ( !(aField.equals(thePKeyName) ||
975 aField.equals("webdb_create") ||
976 aField.equals("webdb_lastchange") ||
977 ((streamedInput != null) && streamedInput.contains(aField)))) {
978 if (theEntity.hasValueForField(aField)) {
979 if (firstField == false) {
986 fv.append(aField).append("='").append(JDBCStringRoutines.escapeStringLiteral((String) theEntity.getValue(aField))).append("'");
988 // fv.append(aField).append("='").append(StringUtil.quote((String)theEntity.getValue(aField))).append("'");
994 new StringBuffer("update ").append(theTable).append(" set ").append(fv);
997 if (metadataFields.contains("webdb_lastchange")) {
998 sql.append(",webdb_lastchange=NOW()");
1001 // special case: the webdb_create requires the field in yyyy-mm-dd HH:mm
1002 // format so anything extra will be ignored. -mh
1003 if (metadataFields.contains("webdb_create") &&
1004 theEntity.hasValueForField("webdb_create")) {
1005 // minimum of 10 (yyyy-mm-dd)...
1006 if (theEntity.getValue("webdb_create").length() >= 10) {
1007 String dateString = theEntity.getValue("webdb_create");
1009 // if only 10, then add 00:00 so it doesn't throw a ParseException
1010 if (dateString.length() == 10) {
1011 dateString = dateString + " 00:00";
1016 java.util.Date d = userInputDateFormat.parse(dateString);
1017 // Timestamp tStamp = new Timestamp(d.getTime());
1018 sql.append(",webdb_create='" + JDBCStringRoutines.formatDate(d) + "'");
1020 catch (ParseException e) {
1021 throw new StorageObjectFailure(e);
1026 if (streamedInput != null) {
1027 for (int i = 0; i < streamedInput.size(); i++) {
1028 sql.append(",").append(streamedInput.get(i)).append("=?");
1032 sql.append(" where id=").append(id);
1033 logger.debug("UPDATE: " + sql);
1036 con = getPooledCon();
1037 con.setAutoCommit(false);
1038 pstmt = con.prepareStatement(sql.toString());
1040 if (streamedInput != null) {
1041 for (int i = 0; i < streamedInput.size(); i++) {
1042 String inputString =
1043 theEntity.getValue((String) streamedInput.get(i));
1044 pstmt.setBytes(i + 1, inputString.getBytes());
1048 pstmt.executeUpdate();
1050 catch (SQLException sqe) {
1051 throwSQLException(sqe, "update");
1055 con.setAutoCommit(true);
1057 catch (Exception e) {
1061 freeConnection(con, pstmt);
1067 * @param id des zu loeschenden Datensatzes
1068 * @return boolean liefert true zurueck, wenn loeschen erfolgreich war.
1070 public boolean delete(String id) throws StorageObjectFailure {
1071 invalidatePopupCache();
1073 // ostore send notification
1074 if (StoreUtil.implementsStorableObject(theEntityClass)) {
1075 String uniqueId = id;
1077 if (theEntityClass.equals(StorableObjectEntity.class)) {
1078 uniqueId += ("@" + theTable);
1081 logger.debug("CACHE: (del) " + id);
1083 StoreIdentifier search_sid =
1084 new StoreIdentifier(theEntityClass,
1085 StoreContainerType.STOC_TYPE_ENTITY, uniqueId);
1086 o_store.invalidate(search_sid);
1089 /** @todo could be prepared Statement */
1090 Statement stmt = null;
1091 Connection con = null;
1094 "delete from " + theTable + " where " + thePKeyName + "='" + id + "'";
1096 //theLog.printInfo("DELETE " + sql);
1098 con = getPooledCon();
1099 stmt = con.createStatement();
1100 res = stmt.executeUpdate(sql);
1101 } catch (SQLException sqe) {
1102 throwSQLException(sqe, "delete");
1104 freeConnection(con, stmt);
1107 return (res > 0) ? true : false;
1111 * Deletes entities based on a where clause
1113 * @param aWhereClause
1115 * @throws StorageObjectFailure
1117 public int deleteByWhereClause(String aWhereClause) throws StorageObjectFailure {
1118 invalidatePopupCache();
1119 if (StoreUtil.implementsStorableObject(theEntityClass)) {
1120 StoreContainerType stoc_type = StoreContainerType.valueOf(theEntityClass, StoreContainerType.STOC_TYPE_ENTITYLIST);
1121 o_store.invalidate(stoc_type);
1124 Statement stmt = null;
1125 Connection con = null;
1128 "delete from " + theTable + " where " + aWhereClause;
1130 //theLog.printInfo("DELETE " + sql);
1132 con = getPooledCon();
1133 stmt = con.createStatement();
1134 res = stmt.executeUpdate(sql);
1136 catch (SQLException sqe) {
1137 throwSQLException(sqe, "delete");
1140 freeConnection(con, stmt);
1146 /* noch nicht implementiert.
1147 * @return immer false
1149 public boolean delete(EntityList theEntityList) {
1150 invalidatePopupCache();
1155 /* invalidates the popupCache
1157 protected void invalidatePopupCache() {
1158 /** @todo invalidates toooo much */
1164 * Diese Methode fuehrt den Sqlstring <i>sql</i> aus und timed im Logfile.
1165 * @param stmt Statemnt
1166 * @param sql Sql-String
1168 * @exception StorageObjectException
1170 public ResultSet executeSql(Statement stmt, String sql)
1171 throws StorageObjectFailure, SQLException {
1173 long startTime = System.currentTimeMillis();
1176 rs = stmt.executeQuery(sql);
1178 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1180 catch (SQLException e) {
1181 logger.error(e.getMessage() +"\n" + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1188 public ResultSet executeSql(String sql) throws StorageObjectFailure, SQLException {
1189 long startTime = System.currentTimeMillis();
1190 Connection connection = null;
1191 Statement statement = null;
1194 connection = getPooledCon();
1195 statement = connection.createStatement();
1198 result = statement.executeQuery(sql);
1200 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1203 catch (Throwable e) {
1204 logger.error(e.getMessage() +"\n" + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1205 throw new StorageObjectFailure(e);
1208 if (connection!=null) {
1209 freeConnection(connection, statement);
1214 private Map processRow(ResultSet aResultSet) throws StorageObjectFailure, StorageObjectExc {
1216 Map result = new HashMap();
1217 ResultSetMetaData metaData = aResultSet.getMetaData();
1218 int nrColumns = metaData.getColumnCount();
1219 for (int i=0; i<nrColumns; i++) {
1220 result.put(metaData.getColumnName(i+1), getValueAsString(aResultSet, i+1, metaData.getColumnType(i+1)));
1225 catch (Throwable e) {
1226 throw new StorageObjectFailure(e);
1230 public List executeFreeSql(String sql, int aLimit) throws StorageObjectFailure, StorageObjectExc {
1231 Connection connection = null;
1232 Statement statement = null;
1234 List result = new Vector();
1235 connection = getPooledCon();
1236 statement = connection.createStatement();
1237 ResultSet resultset = executeSql(statement, sql);
1239 while (resultset.next() && result.size() < aLimit) {
1240 result.add(processRow(resultset));
1249 catch (Throwable e) {
1250 throw new StorageObjectFailure(e);
1253 if (connection!=null) {
1254 freeConnection(connection, statement);
1259 public Map executeFreeSingleRowSql(String anSqlStatement) throws StorageObjectFailure, StorageObjectExc {
1261 List resultList = executeFreeSql(anSqlStatement, 1);
1263 if (resultList.size()>0)
1264 return (Map) resultList.get(0);
1271 catch (Throwable t) {
1272 throw new StorageObjectFailure(t);
1276 public String executeFreeSingleValueSql(String sql) throws StorageObjectFailure, StorageObjectExc {
1277 Map row = executeFreeSingleRowSql(sql);
1282 Iterator i = row.values().iterator();
1284 return (String) i.next();
1290 * returns the number of rows in the table
1292 public int getSize(String where) throws SQLException, StorageObjectFailure {
1293 long startTime = System.currentTimeMillis();
1294 String sql = "SELECT Count(*) FROM " + theTable;
1296 if ((where != null) && (where.length() != 0)) {
1297 sql = sql + " where " + where;
1300 Connection con = null;
1301 Statement stmt = null;
1305 con = getPooledCon();
1306 stmt = con.createStatement();
1308 ResultSet rs = executeSql(stmt, sql);
1311 result = rs.getInt(1);
1314 catch (SQLException e) {
1315 logger.error("Database.getSize: " + e.getMessage());
1318 freeConnection(con, stmt);
1321 //theLog.printInfo(theTable + " has "+ result +" rows where " + where);
1322 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1327 public int executeUpdate(Statement stmt, String sql)
1328 throws StorageObjectFailure, SQLException {
1330 long startTime = System.currentTimeMillis();
1333 rs = stmt.executeUpdate(sql);
1335 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1337 catch (SQLException e) {
1338 logger.error("Failed: " + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1345 public int executeUpdate(String sql)
1346 throws StorageObjectFailure, SQLException {
1348 long startTime = System.currentTimeMillis();
1349 Connection con = null;
1350 PreparedStatement pstmt = null;
1353 con = getPooledCon();
1354 pstmt = con.prepareStatement(sql);
1355 result = pstmt.executeUpdate();
1357 catch (Throwable e) {
1358 logger.error("Database.executeUpdate(" + sql + "): " + e.getMessage());
1359 throw new StorageObjectFailure("Database.executeUpdate(" + sql + "): " + e.getMessage(), e);
1362 freeConnection(con, pstmt);
1365 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1370 * Wertet ResultSetMetaData aus und setzt interne Daten entsprechend
1371 * @param md ResultSetMetaData
1372 * @exception StorageObjectException
1374 private void evalMetaData(ResultSetMetaData md) throws StorageObjectFailure {
1375 this.evaluatedMetaData = true;
1376 this.metadataFields = new ArrayList();
1377 this.metadataLabels = new ArrayList();
1378 this.metadataNotNullFields = new ArrayList();
1381 int numFields = md.getColumnCount();
1382 this.metadataTypes = new int[numFields];
1387 for (int i = 1; i <= numFields; i++) {
1388 aField = md.getColumnName(i);
1389 metadataFields.add(aField);
1390 metadataLabels.add(md.getColumnLabel(i));
1391 aType = md.getColumnType(i);
1392 metadataTypes[i - 1] = aType;
1394 if (aField.equals(thePKeyName)) {
1395 thePKeyType = aType;
1399 if (md.isNullable(i) == ResultSetMetaData.columnNullable) {
1400 metadataNotNullFields.add(aField);
1404 catch (SQLException e) {
1405 throwSQLException(e, "evalMetaData");
1410 * Wertet die Metadaten eines Resultsets fuer eine Tabelle aus,
1411 * um die alle Columns und Typen einer Tabelle zu ermitteln.
1413 private void get_meta_data() throws StorageObjectFailure {
1414 Connection con = null;
1415 PreparedStatement pstmt = null;
1416 String sql = "select * from " + theTable + " where 0=1";
1419 con = getPooledCon();
1420 pstmt = con.prepareStatement(sql);
1422 logger.debug("METADATA: " + sql);
1423 ResultSet rs = pstmt.executeQuery();
1424 evalMetaData(rs.getMetaData());
1427 catch (SQLException e) {
1428 throwSQLException(e, "get_meta_data");
1431 freeConnection(con, pstmt);
1435 public Connection getPooledCon() throws StorageObjectFailure {
1436 Connection con = null;
1439 con = SQLManager.getInstance().requestConnection();
1441 catch (SQLException e) {
1442 logger.error("could not connect to the database " + e.getMessage());
1444 throw new StorageObjectFailure("Could not connect to the database", e);
1450 public void freeConnection(Connection con, Statement stmt)
1451 throws StorageObjectFailure {
1452 SQLManager.closeStatement(stmt);
1453 SQLManager.getInstance().returnConnection(con);
1457 * Wertet SQLException aus und wirft dannach eine StorageObjectException
1458 * @param sqe SQLException
1459 * @param wo Funktonsname, in der die SQLException geworfen wurde
1460 * @exception StorageObjectException
1462 protected void throwSQLException(SQLException sqe, String aFunction) throws StorageObjectFailure {
1464 String message = "";
1468 state = sqe.getSQLState();
1469 message = sqe.getMessage();
1470 vendor = sqe.getErrorCode();
1473 String information =
1476 ", vendor= " + vendor +
1477 ", message=" + message +
1478 ", function= " + aFunction;
1480 logger.error(information);
1482 throw new StorageObjectFailure(information, sqe);
1485 protected void _throwStorageObjectException(Exception e, String aFunction)
1486 throws StorageObjectFailure {
1489 logger.error(e.getMessage() + aFunction);
1490 throw new StorageObjectFailure(aFunction, e);
1495 * Loggt Fehlermeldung mit dem Parameter Message und wirft dannach
1496 * eine StorageObjectException
1497 * @param message Nachricht mit dem Fehler
1498 * @exception StorageObjectException
1500 void throwStorageObjectException(String aMessage) throws StorageObjectFailure {
1501 logger.error(aMessage);
1502 throw new StorageObjectFailure(aMessage, null);