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.9 2003/11/24 21:45:26 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 {
583 String useTable = theTable;
584 if (mainTablePrefix!=null && mainTablePrefix.trim().length()>0)
585 useTable+=" "+mainTablePrefix;
587 // check o_store for entitylist
588 // only if no relational select
589 if (extraTables==null) {
590 if (StoreUtil.implementsStorableObject(theEntityClass)) {
591 StoreIdentifier search_sid =
593 theEntityClass, StoreContainerType.STOC_TYPE_ENTITYLIST,
594 StoreUtil.getEntityListUniqueIdentifierFor(useTable, aWhereClause, anOrderByClause, offset, limit));
595 EntityList hit = (EntityList) o_store.use(search_sid);
598 logger.debug("CACHE (hit): " + search_sid.toString());
606 EntityList theReturnList = null;
607 Connection con = null;
608 Statement stmt = null;
613 // build sql-statement
615 if ((aWhereClause != null) && (aWhereClause.trim().length() == 0)) {
619 StringBuffer countSql =
620 new StringBuffer("select count(*) from ").append(useTable);
621 StringBuffer selectSql =
622 new StringBuffer("select * from ").append(useTable);
624 // append extratables, if necessary
625 if (extraTables!=null) {
626 for (int i=0;i < extraTables.size();i++) {
627 countSql.append( ", " + extraTables.get(i));
628 selectSql.append( ", " + extraTables.get(i));
632 if (aWhereClause != null) {
633 selectSql.append(" where ").append(aWhereClause);
634 countSql.append(" where ").append(aWhereClause);
637 if ((anOrderByClause != null) && !(anOrderByClause.trim().length() == 0)) {
638 selectSql.append(" order by ").append(anOrderByClause);
641 if ((limit > -1) && (offset > -1)) {
642 selectSql.append(" LIMIT ").append(limit).append(" OFFSET ").append(offset);
647 con = getPooledCon();
648 stmt = con.createStatement();
651 rs = executeSql(stmt, selectSql.toString());
654 if (!evaluatedMetaData) {
655 evalMetaData(rs.getMetaData());
658 theReturnList = new EntityList();
659 Entity theResultEntity;
661 theResultEntity = makeEntityFromResultSet(rs);
662 theReturnList.add(theResultEntity);
668 // making entitylist infos
671 if (theReturnList != null) {
672 // now we decide if we have to know an overall count...
675 if ((limit > -1) && (offset > -1)) {
676 if (offsetCount == limit) {
677 rs = executeSql(stmt, countSql.toString());
681 count = rs.getInt(1);
687 logger.error("Could not count: " + countSql);
692 theReturnList.setCount(count);
693 theReturnList.setOffset(offset);
694 theReturnList.setWhere(aWhereClause);
695 theReturnList.setOrder(anOrderByClause);
696 theReturnList.setStorage(this);
697 theReturnList.setLimit(limit);
699 if (offset >= limit) {
700 theReturnList.setPrevBatch(offset - limit);
703 if ((offset + offsetCount) < count) {
704 theReturnList.setNextBatch(offset + limit);
707 if (extraTables==null && StoreUtil.implementsStorableObject(theEntityClass)) {
708 StoreIdentifier sid = theReturnList.getStoreIdentifier();
709 logger.debug("CACHE (add): " + sid.toString());
714 catch (SQLException sqe) {
715 throwSQLException(sqe, "selectByWhereClause");
720 freeConnection(con, stmt);
722 } catch (Throwable t) {
726 return theReturnList;
730 * Bastelt aus einer Zeile der Datenbank ein EntityObjekt.
732 * @param rs Das ResultSetObjekt.
733 * @return Entity Die Entity.
735 private Entity makeEntityFromResultSet(ResultSet rs)
736 throws StorageObjectFailure {
737 /** @todo OS: get Pkey from ResultSet and consult ObjectStore */
738 Map theResultHash = new HashMap();
739 String theResult = null;
741 Entity returnEntity = null;
744 int size = metadataFields.size();
746 for (int i = 0; i < size; i++) {
747 // alle durchlaufen bis nix mehr da
748 theType = metadataTypes[i];
750 if (theType == java.sql.Types.LONGVARBINARY) {
751 InputStreamReader is =
752 (InputStreamReader) rs.getCharacterStream(i + 1);
755 char[] data = new char[32768];
756 StringBuffer theResultString = new StringBuffer();
759 while ((len = is.read(data)) > 0) {
760 theResultString.append(data, 0, len);
764 theResult = theResultString.toString();
769 theResult = getValueAsString(rs, (i + 1), theType);
772 if (theResult != null) {
773 theResultHash.put(metadataFields.get(i), theResult);
777 if (theEntityClass != null) {
778 returnEntity = (Entity) theEntityClass.newInstance();
779 returnEntity.setStorage(this);
780 returnEntity.setValues(theResultHash);
782 if (returnEntity instanceof StorableObject) {
783 logger.debug("CACHE: ( in) " + returnEntity.getId() + " :" + theTable);
784 o_store.add(((StorableObject) returnEntity).getStoreIdentifier());
787 throwStorageObjectException("Internal Error: theEntityClass not set!");
790 catch (IllegalAccessException e) {
791 throwStorageObjectException("No access! -- " + e.getMessage());
793 catch (IOException e) {
794 throwStorageObjectException("IOException! -- " + e.getMessage());
796 catch (InstantiationException e) {
797 throwStorageObjectException("No Instatiation! -- " + e.getMessage());
799 catch (SQLException sqe) {
800 throwSQLException(sqe, "makeEntityFromResultSet");
809 * Inserts an entity into the database.
812 * @return der Wert des Primary-keys der eingef?gten Entity
814 public String insert(Entity theEntity) throws StorageObjectFailure {
816 invalidatePopupCache();
818 // invalidating all EntityLists corresponding with theEntityClass
819 if (StoreUtil.implementsStorableObject(theEntityClass)) {
820 StoreContainerType stoc_type =
821 StoreContainerType.valueOf(theEntityClass,
822 StoreContainerType.STOC_TYPE_ENTITYLIST);
823 o_store.invalidate(stoc_type);
826 String returnId = null;
827 Connection con = null;
828 PreparedStatement pstmt = null;
831 List streamedInput = theEntity.streamedInput();
832 StringBuffer f = new StringBuffer();
833 StringBuffer v = new StringBuffer();
836 boolean firstField = true;
839 for (int i = 0; i < getFields().size(); i++) {
840 aField = (String) getFields().get(i);
842 if (!aField.equals(thePKeyName)) {
846 if (!theEntity.hasValueForField(aField) && (
847 aField.equals("webdb_create") ||
848 aField.equals("webdb_lastchange"))) {
852 if ((streamedInput != null) && streamedInput.contains(aField)) {
856 if (theEntity.hasValueForField(aField)) {
859 JDBCStringRoutines.escapeStringLiteral((String) theEntity.getValue(aField)) + "'";
864 // wenn Wert gegeben, dann einbauen
865 if (aValue != null) {
866 if (firstField == false) {
882 StringBuffer sqlBuf =
883 new StringBuffer("insert into ").append(theTable).append("(").append(f)
884 .append(") values (").append(v).append(")");
885 String sql = sqlBuf.toString();
887 logger.debug("INSERT: " + sql);
888 con = getPooledCon();
889 con.setAutoCommit(false);
890 pstmt = con.prepareStatement(sql);
892 if (streamedInput != null) {
893 for (int i = 0; i < streamedInput.size(); i++) {
895 (String) theEntity.getValue((String) streamedInput.get(i));
896 pstmt.setBytes(i + 1, inputString.getBytes());
900 int ret = pstmt.executeUpdate();
907 pstmt = con.prepareStatement("select currval('" + getCoreTable() + "_id_seq')");
909 ResultSet rs = pstmt.executeQuery();
911 returnId = rs.getString(1);
912 theEntity.setId(returnId);
914 catch (SQLException sqe) {
915 throwSQLException(sqe, "insert");
919 con.setAutoCommit(true);
921 catch (Exception e) {
924 freeConnection(con, pstmt);
927 /** @todo store entity in o_store */
932 * Updates an entity in the database
936 public void update(Entity theEntity) throws StorageObjectFailure {
937 Connection con = null;
938 PreparedStatement pstmt = null;
940 /** @todo this is stupid: why do we prepare statement, when we
941 * throw it away afterwards. should be regular statement
942 * update/insert could better be one routine called save()
943 * that chooses to either insert or update depending if we
944 * have a primary key in the entity. i don't know if we
945 * still need the streamed input fields. // rk */
946 /** @todo extension: check if Entity did change, otherwise we don't need
947 * the roundtrip to the database */
948 /** invalidating corresponding entitylists in o_store*/
949 if (StoreUtil.implementsStorableObject(theEntityClass)) {
950 StoreContainerType stoc_type =
951 StoreContainerType.valueOf(theEntityClass,
952 StoreContainerType.STOC_TYPE_ENTITYLIST);
953 o_store.invalidate(stoc_type);
956 List streamedInput = theEntity.streamedInput();
957 String id = theEntity.getId();
959 StringBuffer fv = new StringBuffer();
960 boolean firstField = true;
963 invalidatePopupCache();
965 // build sql statement
966 for (int i = 0; i < getFields().size(); i++) {
967 aField = (String) metadataFields.get(i);
970 if ( !(aField.equals(thePKeyName) ||
971 aField.equals("webdb_create") ||
972 aField.equals("webdb_lastchange") ||
973 ((streamedInput != null) && streamedInput.contains(aField)))) {
974 if (theEntity.hasValueForField(aField)) {
975 if (firstField == false) {
982 fv.append(aField).append("='").append(JDBCStringRoutines.escapeStringLiteral((String) theEntity.getValue(aField))).append("'");
984 // fv.append(aField).append("='").append(StringUtil.quote((String)theEntity.getValue(aField))).append("'");
990 new StringBuffer("update ").append(theTable).append(" set ").append(fv);
993 if (metadataFields.contains("webdb_lastchange")) {
994 sql.append(",webdb_lastchange=NOW()");
997 // special case: the webdb_create requires the field in yyyy-mm-dd HH:mm
998 // format so anything extra will be ignored. -mh
999 if (metadataFields.contains("webdb_create") &&
1000 theEntity.hasValueForField("webdb_create")) {
1001 // minimum of 10 (yyyy-mm-dd)...
1002 if (theEntity.getValue("webdb_create").length() >= 10) {
1003 String dateString = theEntity.getValue("webdb_create");
1005 // if only 10, then add 00:00 so it doesn't throw a ParseException
1006 if (dateString.length() == 10) {
1007 dateString = dateString + " 00:00";
1012 java.util.Date d = userInputDateFormat.parse(dateString);
1013 // Timestamp tStamp = new Timestamp(d.getTime());
1014 sql.append(",webdb_create='" + JDBCStringRoutines.formatDate(d) + "'");
1016 catch (ParseException e) {
1017 throw new StorageObjectFailure(e);
1022 if (streamedInput != null) {
1023 for (int i = 0; i < streamedInput.size(); i++) {
1024 sql.append(",").append(streamedInput.get(i)).append("=?");
1028 sql.append(" where id=").append(id);
1029 logger.debug("UPDATE: " + sql);
1032 con = getPooledCon();
1033 con.setAutoCommit(false);
1034 pstmt = con.prepareStatement(sql.toString());
1036 if (streamedInput != null) {
1037 for (int i = 0; i < streamedInput.size(); i++) {
1038 String inputString =
1039 theEntity.getValue((String) streamedInput.get(i));
1040 pstmt.setBytes(i + 1, inputString.getBytes());
1044 pstmt.executeUpdate();
1046 catch (SQLException sqe) {
1047 throwSQLException(sqe, "update");
1051 con.setAutoCommit(true);
1053 catch (Exception e) {
1057 freeConnection(con, pstmt);
1063 * @param id des zu loeschenden Datensatzes
1064 * @return boolean liefert true zurueck, wenn loeschen erfolgreich war.
1066 public boolean delete(String id) throws StorageObjectFailure {
1067 invalidatePopupCache();
1069 // ostore send notification
1070 if (StoreUtil.implementsStorableObject(theEntityClass)) {
1071 String uniqueId = id;
1073 if (theEntityClass.equals(StorableObjectEntity.class)) {
1074 uniqueId += ("@" + theTable);
1077 logger.debug("CACHE: (del) " + id);
1079 StoreIdentifier search_sid =
1080 new StoreIdentifier(theEntityClass,
1081 StoreContainerType.STOC_TYPE_ENTITY, uniqueId);
1082 o_store.invalidate(search_sid);
1085 /** @todo could be prepared Statement */
1086 Statement stmt = null;
1087 Connection con = null;
1090 "delete from " + theTable + " where " + thePKeyName + "='" + id + "'";
1092 //theLog.printInfo("DELETE " + sql);
1094 con = getPooledCon();
1095 stmt = con.createStatement();
1096 res = stmt.executeUpdate(sql);
1097 } catch (SQLException sqe) {
1098 throwSQLException(sqe, "delete");
1100 freeConnection(con, stmt);
1103 return (res > 0) ? true : false;
1107 * Deletes entities based on a where clause
1109 * @param aWhereClause
1111 * @throws StorageObjectFailure
1113 public int deleteByWhereClause(String aWhereClause) throws StorageObjectFailure {
1114 invalidatePopupCache();
1115 if (StoreUtil.implementsStorableObject(theEntityClass)) {
1116 StoreContainerType stoc_type = StoreContainerType.valueOf(theEntityClass, StoreContainerType.STOC_TYPE_ENTITYLIST);
1117 o_store.invalidate(stoc_type);
1120 Statement stmt = null;
1121 Connection con = null;
1124 "delete from " + theTable + " where " + aWhereClause;
1126 //theLog.printInfo("DELETE " + sql);
1128 con = getPooledCon();
1129 stmt = con.createStatement();
1130 res = stmt.executeUpdate(sql);
1132 catch (SQLException sqe) {
1133 throwSQLException(sqe, "delete");
1136 freeConnection(con, stmt);
1142 /* noch nicht implementiert.
1143 * @return immer false
1145 public boolean delete(EntityList theEntityList) {
1146 invalidatePopupCache();
1151 /* invalidates the popupCache
1153 protected void invalidatePopupCache() {
1154 /** @todo invalidates toooo much */
1160 * Diese Methode fuehrt den Sqlstring <i>sql</i> aus und timed im Logfile.
1161 * @param stmt Statemnt
1162 * @param sql Sql-String
1164 * @exception StorageObjectException
1166 public ResultSet executeSql(Statement stmt, String sql)
1167 throws StorageObjectFailure, SQLException {
1169 long startTime = System.currentTimeMillis();
1172 rs = stmt.executeQuery(sql);
1174 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1176 catch (SQLException e) {
1177 logger.error(e.getMessage() +"\n" + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1184 public ResultSet executeSql(String sql) throws StorageObjectFailure, SQLException {
1185 long startTime = System.currentTimeMillis();
1186 Connection connection = null;
1187 Statement statement = null;
1190 connection = getPooledCon();
1191 statement = connection.createStatement();
1194 result = statement.executeQuery(sql);
1196 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1199 catch (Throwable e) {
1200 logger.error(e.getMessage() +"\n" + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1201 throw new StorageObjectFailure(e);
1204 if (connection!=null) {
1205 freeConnection(connection, statement);
1210 private Map processRow(ResultSet aResultSet) throws StorageObjectFailure, StorageObjectExc {
1212 Map result = new HashMap();
1213 ResultSetMetaData metaData = aResultSet.getMetaData();
1214 int nrColumns = metaData.getColumnCount();
1215 for (int i=0; i<nrColumns; i++) {
1216 result.put(metaData.getColumnName(i+1), getValueAsString(aResultSet, i+1, metaData.getColumnType(i+1)));
1221 catch (Throwable e) {
1222 throw new StorageObjectFailure(e);
1226 public List executeFreeSql(String sql, int aLimit) throws StorageObjectFailure, StorageObjectExc {
1227 Connection connection = null;
1228 Statement statement = null;
1230 List result = new Vector();
1231 connection = getPooledCon();
1232 statement = connection.createStatement();
1233 ResultSet resultset = executeSql(statement, sql);
1235 while (resultset.next() && result.size() < aLimit) {
1236 result.add(processRow(resultset));
1245 catch (Throwable e) {
1246 throw new StorageObjectFailure(e);
1249 if (connection!=null) {
1250 freeConnection(connection, statement);
1255 public Map executeFreeSingleRowSql(String anSqlStatement) throws StorageObjectFailure, StorageObjectExc {
1257 List resultList = executeFreeSql(anSqlStatement, 1);
1259 if (resultList.size()>0)
1260 return (Map) resultList.get(0);
1267 catch (Throwable t) {
1268 throw new StorageObjectFailure(t);
1272 public String executeFreeSingleValueSql(String sql) throws StorageObjectFailure, StorageObjectExc {
1273 Map row = executeFreeSingleRowSql(sql);
1278 Iterator i = row.values().iterator();
1280 return (String) i.next();
1286 * returns the number of rows in the table
1288 public int getSize(String where) throws SQLException, StorageObjectFailure {
1289 long startTime = System.currentTimeMillis();
1290 String sql = "SELECT Count(*) FROM " + theTable;
1292 if ((where != null) && (where.length() != 0)) {
1293 sql = sql + " where " + where;
1296 Connection con = null;
1297 Statement stmt = null;
1301 con = getPooledCon();
1302 stmt = con.createStatement();
1304 ResultSet rs = executeSql(stmt, sql);
1307 result = rs.getInt(1);
1310 catch (SQLException e) {
1311 logger.error("Database.getSize: " + e.getMessage());
1314 freeConnection(con, stmt);
1317 //theLog.printInfo(theTable + " has "+ result +" rows where " + where);
1318 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1323 public int executeUpdate(Statement stmt, String sql)
1324 throws StorageObjectFailure, SQLException {
1326 long startTime = System.currentTimeMillis();
1329 rs = stmt.executeUpdate(sql);
1331 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1333 catch (SQLException e) {
1334 logger.error("Failed: " + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1341 public int executeUpdate(String sql)
1342 throws StorageObjectFailure, SQLException {
1344 long startTime = System.currentTimeMillis();
1345 Connection con = null;
1346 PreparedStatement pstmt = null;
1349 con = getPooledCon();
1350 pstmt = con.prepareStatement(sql);
1351 result = pstmt.executeUpdate();
1353 catch (Throwable e) {
1354 logger.error("Database.executeUpdate(" + sql + "): " + e.getMessage());
1355 throw new StorageObjectFailure("Database.executeUpdate(" + sql + "): " + e.getMessage(), e);
1358 freeConnection(con, pstmt);
1361 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1366 * Wertet ResultSetMetaData aus und setzt interne Daten entsprechend
1367 * @param md ResultSetMetaData
1368 * @exception StorageObjectException
1370 private void evalMetaData(ResultSetMetaData md) throws StorageObjectFailure {
1371 this.evaluatedMetaData = true;
1372 this.metadataFields = new ArrayList();
1373 this.metadataLabels = new ArrayList();
1374 this.metadataNotNullFields = new ArrayList();
1377 int numFields = md.getColumnCount();
1378 this.metadataTypes = new int[numFields];
1383 for (int i = 1; i <= numFields; i++) {
1384 aField = md.getColumnName(i);
1385 metadataFields.add(aField);
1386 metadataLabels.add(md.getColumnLabel(i));
1387 aType = md.getColumnType(i);
1388 metadataTypes[i - 1] = aType;
1390 if (aField.equals(thePKeyName)) {
1391 thePKeyType = aType;
1395 if (md.isNullable(i) == ResultSetMetaData.columnNullable) {
1396 metadataNotNullFields.add(aField);
1400 catch (SQLException e) {
1401 throwSQLException(e, "evalMetaData");
1406 * Wertet die Metadaten eines Resultsets fuer eine Tabelle aus,
1407 * um die alle Columns und Typen einer Tabelle zu ermitteln.
1409 private void get_meta_data() throws StorageObjectFailure {
1410 Connection con = null;
1411 PreparedStatement pstmt = null;
1412 String sql = "select * from " + theTable + " where 0=1";
1415 con = getPooledCon();
1416 pstmt = con.prepareStatement(sql);
1418 logger.debug("METADATA: " + sql);
1419 ResultSet rs = pstmt.executeQuery();
1420 evalMetaData(rs.getMetaData());
1423 catch (SQLException e) {
1424 throwSQLException(e, "get_meta_data");
1427 freeConnection(con, pstmt);
1431 public Connection getPooledCon() throws StorageObjectFailure {
1432 Connection con = null;
1435 con = SQLManager.getInstance().requestConnection();
1437 catch (SQLException e) {
1438 logger.error("could not connect to the database " + e.getMessage());
1440 throw new StorageObjectFailure("Could not connect to the database", e);
1446 public void freeConnection(Connection con, Statement stmt)
1447 throws StorageObjectFailure {
1448 SQLManager.closeStatement(stmt);
1449 SQLManager.getInstance().returnConnection(con);
1453 * Wertet SQLException aus und wirft dannach eine StorageObjectException
1454 * @param sqe SQLException
1455 * @param wo Funktonsname, in der die SQLException geworfen wurde
1456 * @exception StorageObjectException
1458 protected void throwSQLException(SQLException sqe, String aFunction) throws StorageObjectFailure {
1460 String message = "";
1464 state = sqe.getSQLState();
1465 message = sqe.getMessage();
1466 vendor = sqe.getErrorCode();
1469 String information =
1472 ", vendor= " + vendor +
1473 ", message=" + message +
1474 ", function= " + aFunction;
1476 logger.error(information);
1478 throw new StorageObjectFailure(information, sqe);
1481 protected void _throwStorageObjectException(Exception e, String aFunction)
1482 throws StorageObjectFailure {
1485 logger.error(e.getMessage() + aFunction);
1486 throw new StorageObjectFailure(aFunction, e);
1491 * Loggt Fehlermeldung mit dem Parameter Message und wirft dannach
1492 * eine StorageObjectException
1493 * @param message Nachricht mit dem Fehler
1494 * @exception StorageObjectException
1496 void throwStorageObjectException(String aMessage) throws StorageObjectFailure {
1497 logger.error(aMessage);
1498 throw new StorageObjectFailure(aMessage, null);