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;
50 import com.codestudio.util.SQLManager;
52 import freemarker.template.SimpleHash;
53 import freemarker.template.SimpleList;
55 import mir.config.MirPropertiesConfiguration;
56 import mir.config.MirPropertiesConfiguration.PropertiesConfigExc;
57 import mir.entity.Entity;
58 import mir.entity.EntityList;
59 import mir.entity.StorableObjectEntity;
60 import mir.log.LoggerWrapper;
61 import mir.misc.HTMLTemplateProcessor;
62 import mir.misc.StringUtil;
63 import mir.storage.store.ObjectStore;
64 import mir.storage.store.StorableObject;
65 import mir.storage.store.StoreContainerType;
66 import mir.storage.store.StoreIdentifier;
67 import mir.storage.store.StoreUtil;
68 import mir.util.JDBCStringRoutines;
72 * Diese Klasse implementiert die Zugriffsschicht auf die Datenbank.
73 * Alle Projektspezifischen Datenbankklassen erben von dieser Klasse.
74 * In den Unterklassen wird im Minimalfall nur die Tabelle angegeben.
75 * Im Konfigurationsfile findet sich eine Verweis auf den verwendeten
76 * Treiber, Host, User und Passwort, ueber den der Zugriff auf die
79 * @version $Id: Database.java,v 1.45 2003/06/24 21:49:22 idfx Exp $
83 public class Database implements StorageObject {
84 private static Class GENERIC_ENTITY_CLASS = mir.entity.StorableObjectEntity.class;
85 private static Class STORABLE_OBJECT_ENTITY_CLASS = mir.entity.StorableObjectEntity.class;
88 private static SimpleHash POPUP_EMPTYLINE = new SimpleHash();
89 protected static final ObjectStore o_store = ObjectStore.getInstance();
90 private static final int _millisPerHour = 60 * 60 * 1000;
91 private static final int _millisPerMinute = 60 * 1000;
94 // always same object saves a little space
95 POPUP_EMPTYLINE.put("key", "");
96 POPUP_EMPTYLINE.put("value", "--");
99 protected LoggerWrapper logger;
100 protected MirPropertiesConfiguration configuration;
101 protected String theTable;
102 protected String theCoreTable = null;
103 protected String thePKeyName = "id";
104 protected int thePKeyType;
105 protected int thePKeyIndex;
106 protected boolean evaluatedMetaData = false;
107 protected ArrayList metadataFields;
108 protected ArrayList metadataLabels;
109 protected ArrayList metadataNotNullFields;
110 protected int[] metadataTypes;
111 protected Class theEntityClass;
112 protected SimpleList popupCache = null;
113 protected boolean hasPopupCache = false;
114 protected SimpleHash hashCache = null;
115 protected boolean hasTimestamp = true;
116 private String database_driver;
117 private String database_url;
118 private int defaultLimit;
119 protected DatabaseAdaptor theAdaptor;
120 private SimpleDateFormat _dateFormatterOut =
121 new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
122 private SimpleDateFormat _dateFormatterIn =
123 new SimpleDateFormat("yyyy-MM-dd HH:mm");
124 private Calendar _cal = new GregorianCalendar();
127 * Kontruktor bekommt den Filenamen des Konfigurationsfiles ?bergeben.
128 * Aus diesem file werden <code>Database.Logfile</code>,
129 * <code>Database.Username</code>,<code>Database.Password</code>,
130 * <code>Database.Host</code> und <code>Database.Adaptor</code>
131 * ausgelesen und ein Broker f?r die Verbindugen zur Datenbank
134 * @param String confFilename Dateiname der Konfigurationsdatei
136 public Database() throws StorageObjectFailure {
138 configuration = MirPropertiesConfiguration.instance();
140 catch (PropertiesConfigExc e) {
141 throw new StorageObjectFailure(e);
143 logger = new LoggerWrapper("Database");
145 String theAdaptorName = configuration.getString("Database.Adaptor");
146 defaultLimit = Integer.parseInt(configuration.getString("Database.Limit"));
149 theEntityClass = GENERIC_ENTITY_CLASS;
150 theAdaptor = (DatabaseAdaptor) Class.forName(theAdaptorName).newInstance();
152 catch (Throwable e) {
153 logger.error("Error in Database() constructor with " + theAdaptorName + " -- " + e.getMessage());
154 throw new StorageObjectFailure("Error in Database() constructor.", e);
159 * Liefert die Entity-Klasse zur?ck, in der eine Datenbankzeile gewrappt
160 * wird. Wird die Entity-Klasse durch die erbende Klasse nicht ?berschrieben,
161 * wird eine mir.entity.GenericEntity erzeugt.
163 * @return Class-Objekt der Entity
165 public java.lang.Class getEntityClass() {
166 return theEntityClass;
170 * Liefert die Standardbeschr?nkung von select-Statements zur?ck, also
171 * wieviel Datens?tze per Default selektiert werden.
173 * @return Standard-Anzahl der Datens?tze
175 public int getLimit() {
180 * Liefert den Namen des Primary-Keys zur?ck. Wird die Variable nicht von
181 * der erbenden Klasse ?berschrieben, so ist der Wert <code>PKEY</code>
182 * @return Name des Primary-Keys
184 public String getIdName() {
189 * Liefert den Namen der Tabelle, auf das sich das Datenbankobjekt bezieht.
191 * @return Name der Tabelle
193 public String getTableName() {
198 * Dient dazu vererbte Tabellen bei objectrelationalen DBMS
199 * zu speichern, wenn die id einer Tabelle in der parenttabelle verwaltet
201 * @return liefert theCoreTabel als String zurueck, wenn gesetzt, sonst
204 public String getCoreTable() {
205 if (theCoreTable != null) {
214 * Liefert Feldtypen der Felder der Tabelle zurueck (s.a. java.sql.Types)
215 * @return int-Array mit den Typen der Felder
216 * @exception StorageObjectException
218 public int[] getTypes() throws StorageObjectFailure {
219 if (metadataTypes == null) {
223 return metadataTypes;
227 * Liefert eine Liste der Labels der Tabellenfelder
228 * @return ArrayListe mit Labeln
229 * @exception StorageObjectException
231 public List getLabels() throws StorageObjectFailure {
232 if (metadataLabels == null) {
236 return metadataLabels;
240 * Liefert eine Liste der Felder der Tabelle
241 * @return ArrayList mit Feldern
242 * @exception StorageObjectException
244 public List getFields() throws StorageObjectFailure {
245 if (metadataFields == null) {
249 return metadataFields;
253 * Gets value out of ResultSet according to type and converts to String
254 * @param inValue Wert aus ResultSet.
255 * @param aType Datenbanktyp.
256 * @return liefert den Wert als String zurueck. Wenn keine Umwandlung moeglich
257 * dann /unsupported value/
259 private String getValueAsString(ResultSet rs, int valueIndex, int aType)
260 throws StorageObjectFailure {
261 String outValue = null;
266 case java.sql.Types.BIT:
267 outValue = (rs.getBoolean(valueIndex) == true) ? "1" : "0";
271 case java.sql.Types.INTEGER:
272 case java.sql.Types.SMALLINT:
273 case java.sql.Types.TINYINT:
274 case java.sql.Types.BIGINT:
276 int out = rs.getInt(valueIndex);
279 outValue = new Integer(out).toString();
284 case java.sql.Types.NUMERIC:
286 /** @todo Numeric can be float or double depending upon
287 * metadata.getScale() / especially with oracle */
288 long outl = rs.getLong(valueIndex);
291 outValue = new Long(outl).toString();
296 case java.sql.Types.REAL:
298 float tempf = rs.getFloat(valueIndex);
304 int tempf_int = (int) tempf;
305 tempf = (float) tempf_int;
307 outValue = "" + tempf;
308 outValue = outValue.replace('.', ',');
313 case java.sql.Types.DOUBLE:
315 double tempd = rs.getDouble(valueIndex);
321 int tempd_int = (int) tempd;
322 tempd = (double) tempd_int;
324 outValue = "" + tempd;
325 outValue = outValue.replace('.', ',');
330 case java.sql.Types.CHAR:
331 case java.sql.Types.VARCHAR:
332 case java.sql.Types.LONGVARCHAR:
333 outValue = rs.getString(valueIndex);
337 case java.sql.Types.LONGVARBINARY:
338 outValue = rs.getString(valueIndex);
342 case java.sql.Types.TIMESTAMP:
344 // it's important to use Timestamp here as getting it
345 // as a string is undefined and is only there for debugging
346 // according to the API. we can make it a string through formatting.
348 Timestamp timestamp = (rs.getTimestamp(valueIndex));
351 java.util.Date date = new java.util.Date(timestamp.getTime());
352 outValue = _dateFormatterOut.format(date);
356 _cal.get(Calendar.ZONE_OFFSET) + _cal.get(Calendar.DST_OFFSET);
358 StringUtil.zeroPaddingNumber(offset / _millisPerHour, 2, 2);
359 outValue = outValue + "+" + tzOffset;
365 outValue = "<unsupported value>";
366 logger.warn("Unsupported Datatype: at " + valueIndex + " (" + aType + ")");
368 } catch (SQLException e) {
369 throw new StorageObjectFailure("Could not get Value out of Resultset -- ",
378 * select-Operator um einen Datensatz zu bekommen.
379 * @param id Primaerschluessel des Datensatzes.
380 * @return liefert EntityObject des gefundenen Datensatzes oder null.
382 public Entity selectById(String id) throws StorageObjectExc {
383 if ((id == null) || id.equals("")) {
384 throw new StorageObjectExc("Database.selectById: Missing id");
387 // ask object store for object
388 if (StoreUtil.implementsStorableObject(theEntityClass)) {
389 String uniqueId = id;
391 if (theEntityClass.equals(StorableObjectEntity.class)) {
392 uniqueId += ("@" + theTable);
395 StoreIdentifier search_sid = new StoreIdentifier(theEntityClass, uniqueId);
396 logger.debug("CACHE: (dbg) looking for sid " + search_sid.toString());
398 Entity hit = (Entity) o_store.use(search_sid);
405 Statement stmt = null;
406 Connection con = getPooledCon();
407 Entity returnEntity = null;
412 /** @todo better prepared statement */
414 "select * from " + theTable + " where " + thePKeyName + "=" + id;
415 stmt = con.createStatement();
416 rs = executeSql(stmt, selectSql);
419 if (evaluatedMetaData == false) {
420 evalMetaData(rs.getMetaData());
424 returnEntity = makeEntityFromResultSet(rs);
427 logger.debug("No data for id: " + id + " in table " + theTable);
433 logger.debug("No Data for Id " + id + " in Table " + theTable);
436 catch (SQLException sqe) {
437 throwSQLException(sqe, "selectById");
440 catch (NumberFormatException e) {
441 logger.error("ID is no number: " + id);
444 freeConnection(con, stmt);
451 * select-Operator um Datensaetze zu bekommen, die key = value erfuellen.
452 * @param key Datenbankfeld der Bedingung.
453 * @param value Wert die der key anehmen muss.
454 * @return EntityList mit den gematchten Entities
456 public EntityList selectByFieldValue(String aField, String aValue) throws StorageObjectFailure {
457 return selectByFieldValue(aField, aValue, 0);
461 * select-Operator um Datensaetze zu bekommen, die key = value erfuellen.
462 * @param key Datenbankfeld der Bedingung.
463 * @param value Wert die der key anehmen muss.
464 * @param offset Gibt an ab welchem Datensatz angezeigt werden soll.
465 * @return EntityList mit den gematchten Entities
467 public EntityList selectByFieldValue(String aField, String aValue, int offset) throws StorageObjectFailure {
468 return selectByWhereClause(aField + "=" + aValue, offset);
472 * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.
473 * Also offset wird der erste Datensatz genommen.
475 * @param wc where-Clause
476 * @return EntityList mit den gematchten Entities
477 * @exception StorageObjectException
479 public EntityList selectByWhereClause(String where) throws StorageObjectFailure {
480 return selectByWhereClause(where, 0);
484 * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.
485 * Als maximale Anzahl wird das Limit auf der Konfiguration genommen.
487 * @param wc where-Clause
488 * @param offset ab welchem Datensatz.
489 * @return EntityList mit den gematchten Entities
490 * @exception StorageObjectException
492 public EntityList selectByWhereClause(String whereClause, int offset) throws StorageObjectFailure {
493 return selectByWhereClause(whereClause, null, offset);
497 * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.
498 * Also offset wird der erste Datensatz genommen.
499 * Als maximale Anzahl wird das Limit auf der Konfiguration genommen.
501 * @param wc where-Clause
502 * @param ob orderBy-Clause
503 * @return EntityList mit den gematchten Entities
504 * @exception StorageObjectException
506 public EntityList selectByWhereClause(String where, String order) throws StorageObjectFailure {
507 return selectByWhereClause(where, order, 0);
511 * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.
512 * Als maximale Anzahl wird das Limit auf der Konfiguration genommen.
514 * @param wc where-Clause
515 * @param ob orderBy-Clause
516 * @param offset ab welchem Datensatz
517 * @return EntityList mit den gematchten Entities
518 * @exception StorageObjectException
520 public EntityList selectByWhereClause(String whereClause, String orderBy, int offset) throws StorageObjectFailure {
521 return selectByWhereClause(whereClause, orderBy, offset, defaultLimit);
525 * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.
526 * @param aWhereClause where-Clause
527 * @param anOrderByClause orderBy-Clause
528 * @param offset ab welchem Datensatz
529 * @param limit wieviele Datens?tze
530 * @return EntityList mit den gematchten Entities
531 * @exception StorageObjectException
533 public EntityList selectByWhereClause(String aWhereClause, String anOrderByClause,
534 int offset, int limit) throws StorageObjectFailure {
536 // check o_store for entitylist
537 if (StoreUtil.implementsStorableObject(theEntityClass)) {
538 StoreIdentifier search_sid =
540 theEntityClass, StoreContainerType.STOC_TYPE_ENTITYLIST,
541 StoreUtil.getEntityListUniqueIdentifierFor(theTable, aWhereClause, anOrderByClause, offset, limit));
542 EntityList hit = (EntityList) o_store.use(search_sid);
545 logger.debug("CACHE (hit): " + search_sid.toString());
552 EntityList theReturnList = null;
553 Connection con = null;
554 Statement stmt = null;
559 // build sql-statement
561 /** @todo count sql string should only be assembled if we really count
562 * see below at the end of method //rk */
563 if ((aWhereClause != null) && (aWhereClause.trim().length() == 0)) {
567 StringBuffer countSql =
568 new StringBuffer("select count(*) from ").append(theTable);
569 StringBuffer selectSql =
570 new StringBuffer("select * from ").append(theTable);
572 if (aWhereClause != null) {
573 selectSql.append(" where ").append(aWhereClause);
574 countSql.append(" where ").append(aWhereClause);
577 if ((anOrderByClause != null) && !(anOrderByClause.trim().length() == 0)) {
578 selectSql.append(" order by ").append(anOrderByClause);
581 if (theAdaptor.hasLimit()) {
582 if ((limit > -1) && (offset > -1)) {
583 selectSql.append(" LIMIT ").append(limit).append(" OFFSET ").append(offset);
589 con = getPooledCon();
590 stmt = con.createStatement();
593 rs = executeSql(stmt, selectSql.toString());
596 if (!evaluatedMetaData) {
597 evalMetaData(rs.getMetaData());
600 theReturnList = new EntityList();
602 Entity theResultEntity;
605 theResultEntity = makeEntityFromResultSet(rs);
606 theReturnList.add(theResultEntity);
613 // making entitylist infos
614 if (!(theAdaptor.hasLimit())) {
618 if (theReturnList != null) {
619 // now we decide if we have to know an overall count...
622 if ((limit > -1) && (offset > -1)) {
623 if (offsetCount == limit) {
624 /** @todo counting should be deffered to entitylist
625 * getSize() should be used */
626 rs = executeSql(stmt, countSql.toString());
630 count = rs.getInt(1);
636 logger.error("Could not count: " + countSql);
641 theReturnList.setCount(count);
642 theReturnList.setOffset(offset);
643 theReturnList.setWhere(aWhereClause);
644 theReturnList.setOrder(anOrderByClause);
645 theReturnList.setStorage(this);
646 theReturnList.setLimit(limit);
648 if (offset >= limit) {
649 theReturnList.setPrevBatch(offset - limit);
652 if ((offset + offsetCount) < count) {
653 theReturnList.setNextBatch(offset + limit);
656 if (StoreUtil.implementsStorableObject(theEntityClass)) {
657 StoreIdentifier sid = theReturnList.getStoreIdentifier();
658 logger.debug("CACHE (add): " + sid.toString());
663 catch (SQLException sqe) {
664 throwSQLException(sqe, "selectByWhereClause");
669 freeConnection(con, stmt);
671 } catch (Throwable t) {
675 return theReturnList;
679 * Bastelt aus einer Zeile der Datenbank ein EntityObjekt.
681 * @param rs Das ResultSetObjekt.
682 * @return Entity Die Entity.
684 private Entity makeEntityFromResultSet(ResultSet rs)
685 throws StorageObjectFailure {
686 /** @todo OS: get Pkey from ResultSet and consult ObjectStore */
687 Map theResultHash = new HashMap();
688 String theResult = null;
690 Entity returnEntity = null;
693 int size = metadataFields.size();
695 for (int i = 0; i < size; i++) {
696 // alle durchlaufen bis nix mehr da
697 theType = metadataTypes[i];
699 if (theType == java.sql.Types.LONGVARBINARY) {
700 InputStreamReader is =
701 (InputStreamReader) rs.getCharacterStream(i + 1);
704 char[] data = new char[32768];
705 StringBuffer theResultString = new StringBuffer();
708 while ((len = is.read(data)) > 0) {
709 theResultString.append(data, 0, len);
713 theResult = theResultString.toString();
718 theResult = getValueAsString(rs, (i + 1), theType);
721 if (theResult != null) {
722 theResultHash.put(metadataFields.get(i), theResult);
726 if (theEntityClass != null) {
727 returnEntity = (Entity) theEntityClass.newInstance();
728 returnEntity.setValues(theResultHash);
729 returnEntity.setStorage(this);
731 if (returnEntity instanceof StorableObject) {
732 logger.debug("CACHE: ( in) " + returnEntity.getId() + " :" + theTable);
733 o_store.add(((StorableObject) returnEntity).getStoreIdentifier());
736 throwStorageObjectException("Internal Error: theEntityClass not set!");
739 catch (IllegalAccessException e) {
740 throwStorageObjectException("No access! -- " + e.getMessage());
742 catch (IOException e) {
743 throwStorageObjectException("IOException! -- " + e.getMessage());
745 catch (InstantiationException e) {
746 throwStorageObjectException("No Instatiation! -- " + e.getMessage());
748 catch (SQLException sqe) {
749 throwSQLException(sqe, "makeEntityFromResultSet");
758 * Inserts an entity into the database.
761 * @return der Wert des Primary-keys der eingef?gten Entity
763 public String insert(Entity theEntity) throws StorageObjectFailure {
765 invalidatePopupCache();
767 // invalidating all EntityLists corresponding with theEntityClass
768 if (StoreUtil.implementsStorableObject(theEntityClass)) {
769 StoreContainerType stoc_type =
770 StoreContainerType.valueOf(theEntityClass,
771 StoreContainerType.STOC_TYPE_ENTITYLIST);
772 o_store.invalidate(stoc_type);
775 String returnId = null;
776 Connection con = null;
777 PreparedStatement pstmt = null;
780 List streamedInput = theEntity.streamedInput();
781 StringBuffer f = new StringBuffer();
782 StringBuffer v = new StringBuffer();
785 boolean firstField = true;
788 for (int i = 0; i < getFields().size(); i++) {
789 aField = (String) getFields().get(i);
791 if (!aField.equals(thePKeyName)) {
795 if (aField.equals("webdb_create") ||
796 aField.equals("webdb_lastchange")) {
800 if ((streamedInput != null) && streamedInput.contains(aField)) {
803 if (theEntity.hasValueForField(aField)) {
806 JDBCStringRoutines.escapeStringLiteral((String) theEntity.getValue(
812 // wenn Wert gegeben, dann einbauen
813 if (aValue != null) {
814 if (firstField == false) {
830 StringBuffer sqlBuf =
831 new StringBuffer("insert into ").append(theTable).append("(").append(f)
832 .append(") values (").append(v).append(")");
833 String sql = sqlBuf.toString();
835 logger.debug("INSERT: " + sql);
836 con = getPooledCon();
837 con.setAutoCommit(false);
838 pstmt = con.prepareStatement(sql);
840 if (streamedInput != null) {
841 for (int i = 0; i < streamedInput.size(); i++) {
843 (String) theEntity.getValue((String) streamedInput.get(i));
844 pstmt.setBytes(i + 1, inputString.getBytes());
848 int ret = pstmt.executeUpdate();
855 pstmt = con.prepareStatement(theAdaptor.getLastInsertSQL(this));
857 ResultSet rs = pstmt.executeQuery();
859 returnId = rs.getString(1);
860 theEntity.setId(returnId);
862 catch (SQLException sqe) {
863 sqe.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));
864 throwSQLException(sqe, "insert");
868 con.setAutoCommit(true);
870 catch (Exception e) {
871 e.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));
874 freeConnection(con, pstmt);
877 /** @todo store entity in o_store */
882 * Updates an entity in the database
886 public void update(Entity theEntity) throws StorageObjectFailure {
887 Connection con = null;
888 PreparedStatement pstmt = null;
890 /** @todo this is stupid: why do we prepare statement, when we
891 * throw it away afterwards. should be regular statement
892 * update/insert could better be one routine called save()
893 * that chooses to either insert or update depending if we
894 * have a primary key in the entity. i don't know if we
895 * still need the streamed input fields. // rk */
896 /** @todo extension: check if Entity did change, otherwise we don't need
897 * the roundtrip to the database */
898 /** invalidating corresponding entitylists in o_store*/
899 if (StoreUtil.implementsStorableObject(theEntityClass)) {
900 StoreContainerType stoc_type =
901 StoreContainerType.valueOf(theEntityClass,
902 StoreContainerType.STOC_TYPE_ENTITYLIST);
903 o_store.invalidate(stoc_type);
906 List streamedInput = theEntity.streamedInput();
907 String id = theEntity.getId();
909 StringBuffer fv = new StringBuffer();
910 boolean firstField = true;
913 invalidatePopupCache();
915 // build sql statement
916 for (int i = 0; i < getFields().size(); i++) {
917 aField = (String) metadataFields.get(i);
920 if ( !(aField.equals(thePKeyName) ||
921 aField.equals("webdb_create") ||
922 aField.equals("webdb_lastchange") ||
923 ((streamedInput != null) && streamedInput.contains(aField)))) {
924 if (theEntity.hasValueForField(aField)) {
925 if (firstField == false) {
932 fv.append(aField).append("='").append(JDBCStringRoutines.escapeStringLiteral((String) theEntity.getValue(aField))).append("'");
934 // fv.append(aField).append("='").append(StringUtil.quote((String)theEntity.getValue(aField))).append("'");
940 new StringBuffer("update ").append(theTable).append(" set ").append(fv);
943 if (metadataFields.contains("webdb_lastchange")) {
944 sql.append(",webdb_lastchange=NOW()");
947 // special case: the webdb_create requires the field in yyyy-mm-dd HH:mm
948 // format so anything extra will be ignored. -mh
949 if (metadataFields.contains("webdb_create") &&
950 theEntity.hasValueForField("webdb_create")) {
951 // minimum of 10 (yyyy-mm-dd)...
952 if (theEntity.getValue("webdb_create").length() >= 10) {
953 String dateString = theEntity.getValue("webdb_create");
955 // if only 10, then add 00:00 so it doesn't throw a ParseException
956 if (dateString.length() == 10) {
957 dateString = dateString + " 00:00";
962 java.util.Date d = _dateFormatterIn.parse(dateString);
963 Timestamp tStamp = new Timestamp(d.getTime());
964 sql.append(",webdb_create='" + tStamp.toString() + "'");
965 } catch (ParseException e) {
966 throw new StorageObjectFailure(e);
971 if (streamedInput != null) {
972 for (int i = 0; i < streamedInput.size(); i++) {
973 sql.append(",").append(streamedInput.get(i)).append("=?");
977 sql.append(" where id=").append(id);
978 logger.debug("UPDATE: " + sql);
981 con = getPooledCon();
982 con.setAutoCommit(false);
983 pstmt = con.prepareStatement(sql.toString());
985 if (streamedInput != null) {
986 for (int i = 0; i < streamedInput.size(); i++) {
988 theEntity.getValue((String) streamedInput.get(i));
989 pstmt.setBytes(i + 1, inputString.getBytes());
993 pstmt.executeUpdate();
995 catch (SQLException sqe) {
996 throwSQLException(sqe, "update");
1000 con.setAutoCommit(true);
1002 catch (Exception e) {
1006 freeConnection(con, pstmt);
1012 * @param id des zu loeschenden Datensatzes
1013 * @return boolean liefert true zurueck, wenn loeschen erfolgreich war.
1015 public boolean delete(String id) throws StorageObjectFailure {
1016 invalidatePopupCache();
1018 // ostore send notification
1019 if (StoreUtil.implementsStorableObject(theEntityClass)) {
1020 String uniqueId = id;
1022 if (theEntityClass.equals(StorableObjectEntity.class)) {
1023 uniqueId += ("@" + theTable);
1026 logger.debug("CACHE: (del) " + id);
1028 StoreIdentifier search_sid =
1029 new StoreIdentifier(theEntityClass,
1030 StoreContainerType.STOC_TYPE_ENTITY, uniqueId);
1031 o_store.invalidate(search_sid);
1034 /** @todo could be prepared Statement */
1035 Statement stmt = null;
1036 Connection con = null;
1039 "delete from " + theTable + " where " + thePKeyName + "='" + id + "'";
1041 //theLog.printInfo("DELETE " + sql);
1043 con = getPooledCon();
1044 stmt = con.createStatement();
1045 res = stmt.executeUpdate(sql);
1046 } catch (SQLException sqe) {
1047 throwSQLException(sqe, "delete");
1049 freeConnection(con, stmt);
1052 return (res > 0) ? true : false;
1055 /* noch nicht implementiert.
1056 * @return immer false
1058 public boolean delete(EntityList theEntityList) {
1059 invalidatePopupCache();
1065 * Diese Methode sollte ueberschrieben werden, wenn fuer die abgeleitete Database-Klasse
1066 * eine SimpleList mit Standard-Popupdaten erzeugt werden koennen soll.
1069 public SimpleList getPopupData() throws StorageObjectFailure {
1074 * Holt Daten fuer Popups.
1075 * @param name Name des Feldes.
1076 * @param hasNullValue Wenn true wird eine leerer Eintrag fuer die Popups erzeugt.
1077 * @return SimpleList Gibt freemarker.template.SimpleList zurueck.
1079 public SimpleList getPopupData(String name, boolean hasNullValue)
1080 throws StorageObjectFailure {
1081 return getPopupData(name, hasNullValue, null);
1085 * Holt Daten fuer Popups.
1086 * @param name Name des Feldes.
1087 * @param hasNullValue Wenn true wird eine leerer Eintrag fuer die Popups erzeugt.
1088 * @param where Schraenkt die Selektion der Datensaetze ein.
1089 * @return SimpleList Gibt freemarker.template.SimpleList zurueck.
1091 public SimpleList getPopupData(String name, boolean hasNullValue, String where)
1092 throws StorageObjectFailure {
1093 return getPopupData(name, hasNullValue, where, null);
1097 * Holt Daten fuer Popups.
1098 * @param name Name des Feldes.
1099 * @param hasNullValue Wenn true wird eine leerer Eintrag fuer die Popups erzeugt.
1100 * @param where Schraenkt die Selektion der Datensaetze ein.
1101 * @param order Gibt ein Feld als Sortierkriterium an.
1102 * @return SimpleList Gibt freemarker.template.SimpleList zurueck.
1104 public SimpleList getPopupData(String name, boolean hasNullValue,
1105 String where, String order) throws StorageObjectFailure {
1107 if (hasPopupCache && (popupCache != null)) {
1111 SimpleList simpleList = null;
1112 Connection con = null;
1113 Statement stmt = null;
1117 new StringBuffer("select ").append(thePKeyName).append(",").append(name)
1118 .append(" from ").append(theTable);
1120 if ((where != null) && !(where.length() == 0)) {
1121 sql.append(" where ").append(where);
1124 sql.append(" order by ");
1126 if ((order != null) && !(order.length() == 0)) {
1134 con = getPooledCon();
1135 } catch (Exception e) {
1136 throw new StorageObjectFailure(e);
1140 stmt = con.createStatement();
1142 ResultSet rs = executeSql(stmt, sql.toString());
1145 if (!evaluatedMetaData) {
1149 simpleList = new SimpleList();
1151 // if popup has null-selector
1153 simpleList.add(POPUP_EMPTYLINE);
1156 SimpleHash popupDict;
1159 popupDict = new SimpleHash();
1160 popupDict.put("key", getValueAsString(rs, 1, thePKeyType));
1161 popupDict.put("value", rs.getString(2));
1162 simpleList.add(popupDict);
1168 catch (Exception e) {
1169 logger.error("getPopupData: " + e.getMessage());
1170 throw new StorageObjectFailure(e);
1172 freeConnection(con, stmt);
1175 if (hasPopupCache) {
1176 popupCache = simpleList;
1183 * Liefert alle Daten der Tabelle als SimpleHash zurueck. Dies wird verwandt,
1184 * wenn in den Templates ein Lookup-Table benoetigt wird. Sollte nur bei kleinen
1185 * Tabellen Verwendung finden.
1186 * @return SimpleHash mit den Tabellezeilen.
1188 public SimpleHash getHashData() {
1189 /** @todo dangerous! this should have a flag to be enabled, otherwise
1190 * very big Hashes could be returned */
1191 if (hashCache == null) {
1194 HTMLTemplateProcessor.makeSimpleHash(selectByWhereClause("", -1));
1196 catch (StorageObjectFailure e) {
1197 logger.debug(e.getMessage());
1204 /* invalidates the popupCache
1206 protected void invalidatePopupCache() {
1207 /** @todo invalidates toooo much */
1213 * Diese Methode fuehrt den Sqlstring <i>sql</i> aus und timed im Logfile.
1214 * @param stmt Statemnt
1215 * @param sql Sql-String
1217 * @exception StorageObjectException
1219 public ResultSet executeSql(Statement stmt, String sql)
1220 throws StorageObjectFailure, SQLException {
1222 long startTime = System.currentTimeMillis();
1225 rs = stmt.executeQuery(sql);
1227 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1229 catch (SQLException e) {
1230 logger.error(e.getMessage() +"\n" + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1237 public ResultSet executeSql(String sql) throws StorageObjectFailure, SQLException {
1238 long startTime = System.currentTimeMillis();
1239 Connection connection = null;
1240 Statement statement = null;
1243 connection = getPooledCon();
1244 statement = connection.createStatement();
1247 result = statement.executeQuery(sql);
1249 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1252 catch (Throwable e) {
1253 logger.error(e.getMessage() +"\n" + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1254 throw new StorageObjectFailure(e);
1257 if (connection!=null) {
1258 freeConnection(connection, statement);
1263 private Map processRow(ResultSet aResultSet) throws StorageObjectFailure, StorageObjectExc {
1265 Map result = new HashMap();
1266 ResultSetMetaData metaData = aResultSet.getMetaData();
1267 int nrColumns = metaData.getColumnCount();
1268 for (int i=0; i<nrColumns; i++) {
1269 result.put(metaData.getColumnName(i+1), getValueAsString(aResultSet, i+1, metaData.getColumnType(i+1)));
1274 catch (Throwable e) {
1275 throw new StorageObjectFailure(e);
1279 public List executeFreeSql(String sql, int aLimit) throws StorageObjectFailure, StorageObjectExc {
1280 Connection connection = null;
1281 Statement statement = null;
1283 List result = new Vector();
1284 connection = getPooledCon();
1285 statement = connection.createStatement();
1286 ResultSet resultset = executeSql(statement, sql);
1288 while (resultset.next() && result.size() < aLimit) {
1289 result.add(processRow(resultset));
1298 catch (Throwable e) {
1299 throw new StorageObjectFailure(e);
1302 if (connection!=null) {
1303 freeConnection(connection, statement);
1308 public Map executeFreeSingleRowSql(String anSqlStatement) throws StorageObjectFailure, StorageObjectExc {
1310 List resultList = executeFreeSql(anSqlStatement, 1);
1312 if (resultList.size()>0)
1313 return (Map) resultList.get(0);
1320 catch (Throwable t) {
1321 throw new StorageObjectFailure(t);
1325 public String executeFreeSingleValueSql(String sql) throws StorageObjectFailure, StorageObjectExc {
1326 Map row = executeFreeSingleRowSql(sql);
1331 Iterator i = row.values().iterator();
1333 return (String) i.next();
1339 * returns the number of rows in the table
1341 public int getSize(String where) throws SQLException, StorageObjectFailure {
1342 long startTime = System.currentTimeMillis();
1343 String sql = "SELECT Count(*) FROM " + theTable;
1345 if ((where != null) && (where.length() != 0)) {
1346 sql = sql + " where " + where;
1349 Connection con = null;
1350 Statement stmt = null;
1354 con = getPooledCon();
1355 stmt = con.createStatement();
1357 ResultSet rs = executeSql(stmt, sql);
1360 result = rs.getInt(1);
1363 catch (SQLException e) {
1364 logger.error("Database.getSize: " + e.getMessage());
1367 freeConnection(con, stmt);
1370 //theLog.printInfo(theTable + " has "+ result +" rows where " + where);
1371 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1376 public int executeUpdate(Statement stmt, String sql)
1377 throws StorageObjectFailure, SQLException {
1379 long startTime = System.currentTimeMillis();
1382 rs = stmt.executeUpdate(sql);
1384 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1386 catch (SQLException e) {
1387 logger.error("Failed: " + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1394 public int executeUpdate(String sql)
1395 throws StorageObjectFailure, SQLException {
1397 long startTime = System.currentTimeMillis();
1398 Connection con = null;
1399 PreparedStatement pstmt = null;
1402 con = getPooledCon();
1403 pstmt = con.prepareStatement(sql);
1404 result = pstmt.executeUpdate();
1406 catch (Throwable e) {
1407 logger.error("Database.executeUpdate(" + sql + "): " + e.getMessage());
1408 throw new StorageObjectFailure("Database.executeUpdate(" + sql + "): " + e.getMessage(), e);
1411 freeConnection(con, pstmt);
1414 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1419 * Wertet ResultSetMetaData aus und setzt interne Daten entsprechend
1420 * @param md ResultSetMetaData
1421 * @exception StorageObjectException
1423 private void evalMetaData(ResultSetMetaData md) throws StorageObjectFailure {
1424 this.evaluatedMetaData = true;
1425 this.metadataFields = new ArrayList();
1426 this.metadataLabels = new ArrayList();
1427 this.metadataNotNullFields = new ArrayList();
1430 int numFields = md.getColumnCount();
1431 this.metadataTypes = new int[numFields];
1436 for (int i = 1; i <= numFields; i++) {
1437 aField = md.getColumnName(i);
1438 metadataFields.add(aField);
1439 metadataLabels.add(md.getColumnLabel(i));
1440 aType = md.getColumnType(i);
1441 metadataTypes[i - 1] = aType;
1443 if (aField.equals(thePKeyName)) {
1444 thePKeyType = aType;
1448 if (md.isNullable(i) == ResultSetMetaData.columnNullable) {
1449 metadataNotNullFields.add(aField);
1453 catch (SQLException e) {
1454 throwSQLException(e, "evalMetaData");
1459 * Wertet die Metadaten eines Resultsets fuer eine Tabelle aus,
1460 * um die alle Columns und Typen einer Tabelle zu ermitteln.
1462 private void get_meta_data() throws StorageObjectFailure {
1463 Connection con = null;
1464 PreparedStatement pstmt = null;
1465 String sql = "select * from " + theTable + " where 0=1";
1468 con = getPooledCon();
1469 pstmt = con.prepareStatement(sql);
1471 logger.debug("METADATA: " + sql);
1472 ResultSet rs = pstmt.executeQuery();
1473 evalMetaData(rs.getMetaData());
1476 catch (SQLException e) {
1477 throwSQLException(e, "get_meta_data");
1480 freeConnection(con, pstmt);
1484 public Connection getPooledCon() throws StorageObjectFailure {
1485 Connection con = null;
1488 con = SQLManager.getInstance().requestConnection();
1490 catch (SQLException e) {
1491 logger.error("could not connect to the database " + e.getMessage());
1493 throw new StorageObjectFailure("Could not connect to the database", e);
1499 public void freeConnection(Connection con, Statement stmt)
1500 throws StorageObjectFailure {
1501 SQLManager.closeStatement(stmt);
1502 SQLManager.getInstance().returnConnection(con);
1506 * Wertet SQLException aus und wirft dannach eine StorageObjectException
1507 * @param sqe SQLException
1508 * @param wo Funktonsname, in der die SQLException geworfen wurde
1509 * @exception StorageObjectException
1511 protected void throwSQLException(SQLException sqe, String aFunction) throws StorageObjectFailure {
1513 String message = "";
1517 state = sqe.getSQLState();
1518 message = sqe.getMessage();
1519 vendor = sqe.getErrorCode();
1522 String information =
1525 ", vendor= " + vendor +
1526 ", message=" + message +
1527 ", function= " + aFunction;
1529 logger.error(information);
1531 throw new StorageObjectFailure(information, sqe);
1534 protected void _throwStorageObjectException(Exception e, String aFunction)
1535 throws StorageObjectFailure {
1538 logger.error(e.getMessage() + aFunction);
1539 throw new StorageObjectFailure(aFunction, e);
1544 * Loggt Fehlermeldung mit dem Parameter Message und wirft dannach
1545 * eine StorageObjectException
1546 * @param message Nachricht mit dem Fehler
1547 * @exception StorageObjectException
1549 void throwStorageObjectException(String aMessage) throws StorageObjectFailure {
1550 logger.error(aMessage);
1551 throw new StorageObjectFailure(aMessage, null);