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.17 2003/11/27 20:45:03 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.extendsStorableEntity(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, defaultLimit);
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);
542 public EntityList selectByWhereClause(String mainTablePrefix, List extraTables, String where, String order) throws StorageObjectFailure {
543 return selectByWhereClause(mainTablePrefix, extraTables, where, order, 0, defaultLimit);
547 * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.
548 * Als maximale Anzahl wird das Limit auf der Konfiguration genommen.
550 * @param wc where-Clause
551 * @param ob orderBy-Clause
552 * @param offset ab welchem Datensatz
553 * @return EntityList mit den gematchten Entities
554 * @exception StorageObjectException
556 public EntityList selectByWhereClause(String whereClause, String orderBy, int offset) throws StorageObjectFailure {
557 return selectByWhereClause(whereClause, orderBy, offset, defaultLimit);
561 * select-Operator returns EntityList with matching rows in Database.
562 * @param aWhereClause where-Clause
563 * @param anOrderByClause orderBy-Clause
564 * @param offset ab welchem Datensatz
565 * @param limit wieviele Datens?tze
566 * @return EntityList mit den gematchten Entities
567 * @exception StorageObjectException
569 public EntityList selectByWhereClause(String aWhereClause, String anOrderByClause,
570 int offset, int limit) throws StorageObjectFailure {
571 return selectByWhereClause("", null, aWhereClause, anOrderByClause, offset, limit);
576 * select-Operator returns EntityList with matching rows in Database.
577 * @param aWhereClause where-Clause
578 * @param anOrderByClause orderBy-Clause
579 * @param offset ab welchem Datensatz
580 * @param limit wieviele Datens?tze
581 * @return EntityList mit den gematchten Entities
582 * @exception StorageObjectException
584 public EntityList selectByWhereClause(String mainTablePrefix, List extraTables,
585 String aWhereClause, String anOrderByClause,
586 int offset, int limit) throws StorageObjectFailure {
588 // TODO get rid of emtpy Strings in extraTables
589 // make extraTables null, if single empty String in it
590 if (extraTables != null && ((String)extraTables.get(0)).trim().equals(""))
592 logger.debug("+++ made extraTables to null!");
596 String useTable = theTable;
597 String selectStar = "*";
598 if (mainTablePrefix!=null && mainTablePrefix.trim().length()>0) {
599 useTable+=" "+mainTablePrefix;
600 selectStar=mainTablePrefix.trim() + ".*";
603 // check o_store for entitylist
604 // only if no relational select
605 if (extraTables==null) {
606 if (StoreUtil.extendsStorableEntity(theEntityClass)) {
607 StoreIdentifier searchSid = new StoreIdentifier(theEntityClass,
608 StoreContainerType.STOC_TYPE_ENTITYLIST,
609 StoreUtil.getEntityListUniqueIdentifierFor(theTable,
610 aWhereClause, anOrderByClause, offset, limit));
611 EntityList hit = (EntityList) o_store.use(searchSid);
620 EntityList theReturnList = null;
621 Connection con = null;
622 Statement stmt = null;
627 // build sql-statement
629 if ((aWhereClause != null) && (aWhereClause.trim().length() == 0)) {
633 StringBuffer countSql =
634 new StringBuffer("select count(*) from ").append(useTable);
635 StringBuffer selectSql =
636 new StringBuffer("select "+selectStar+" from ").append(useTable);
638 // append extratables, if necessary
639 if (extraTables!=null) {
640 for (int i=0;i < extraTables.size();i++) {
641 if (!extraTables.get(i).equals("")) {
642 countSql.append( ", " + extraTables.get(i));
643 selectSql.append( ", " + extraTables.get(i));
648 if (aWhereClause != null) {
649 selectSql.append(" where ").append(aWhereClause);
650 countSql.append(" where ").append(aWhereClause);
653 if ((anOrderByClause != null) && !(anOrderByClause.trim().length() == 0)) {
654 selectSql.append(" order by ").append(anOrderByClause);
657 if ((limit > -1) && (offset > -1)) {
658 selectSql.append(" LIMIT ").append(limit).append(" OFFSET ").append(offset);
663 con = getPooledCon();
664 stmt = con.createStatement();
667 rs = executeSql(stmt, selectSql.toString());
670 if (!evaluatedMetaData) {
671 evalMetaData(rs.getMetaData());
674 theReturnList = new EntityList();
675 Entity theResultEntity;
677 theResultEntity = makeEntityFromResultSet(rs);
678 theReturnList.add(theResultEntity);
684 // making entitylist infos
687 if (theReturnList != null) {
688 // now we decide if we have to know an overall count...
691 if ((limit > -1) && (offset > -1)) {
692 if (offsetCount == limit) {
693 rs = executeSql(stmt, countSql.toString());
697 count = rs.getInt(1);
703 logger.error("Could not count: " + countSql);
708 theReturnList.setCount(count);
709 theReturnList.setOffset(offset);
710 theReturnList.setWhere(aWhereClause);
711 theReturnList.setOrder(anOrderByClause);
712 theReturnList.setStorage(this);
713 theReturnList.setLimit(limit);
715 if (offset >= limit) {
716 theReturnList.setPrevBatch(offset - limit);
719 if ((offset + offsetCount) < count) {
720 theReturnList.setNextBatch(offset + limit);
723 if (extraTables==null && StoreUtil.extendsStorableEntity(theEntityClass)) {
724 StoreIdentifier sid = theReturnList.getStoreIdentifier();
725 logger.debug("CACHE (add): " + sid.toString());
730 catch (SQLException sqe) {
731 throwSQLException(sqe, "selectByWhereClause");
736 freeConnection(con, stmt);
738 } catch (Throwable t) {
742 return theReturnList;
746 * Bastelt aus einer Zeile der Datenbank ein EntityObjekt.
748 * @param rs Das ResultSetObjekt.
749 * @return Entity Die Entity.
751 private Entity makeEntityFromResultSet(ResultSet rs)
752 throws StorageObjectFailure {
753 /** @todo OS: get Pkey from ResultSet and consult ObjectStore */
754 Map theResultHash = new HashMap();
755 String theResult = null;
757 Entity returnEntity = null;
760 int size = metadataFields.size();
762 for (int i = 0; i < size; i++) {
763 // alle durchlaufen bis nix mehr da
764 theType = metadataTypes[i];
766 if (theType == java.sql.Types.LONGVARBINARY) {
767 InputStreamReader is =
768 (InputStreamReader) rs.getCharacterStream(i + 1);
771 char[] data = new char[32768];
772 StringBuffer theResultString = new StringBuffer();
775 while ((len = is.read(data)) > 0) {
776 theResultString.append(data, 0, len);
780 theResult = theResultString.toString();
785 theResult = getValueAsString(rs, (i + 1), theType);
788 if (theResult != null) {
789 theResultHash.put(metadataFields.get(i), theResult);
793 if (theEntityClass != null) {
794 returnEntity = (Entity) theEntityClass.newInstance();
795 returnEntity.setStorage(this);
796 returnEntity.setValues(theResultHash);
798 if (returnEntity instanceof StorableObject) {
799 logger.debug("CACHE: ( in) " + returnEntity.getId() + " :" + theTable);
800 o_store.add(((StorableObject) returnEntity).getStoreIdentifier());
803 throwStorageObjectException("Internal Error: theEntityClass not set!");
806 catch (IllegalAccessException e) {
807 throwStorageObjectException("No access! -- " + e.getMessage());
809 catch (IOException e) {
810 throwStorageObjectException("IOException! -- " + e.getMessage());
812 catch (InstantiationException e) {
813 throwStorageObjectException("No Instatiation! -- " + e.getMessage());
815 catch (SQLException sqe) {
816 throwSQLException(sqe, "makeEntityFromResultSet");
825 * Inserts an entity into the database.
828 * @return der Wert des Primary-keys der eingef?gten Entity
830 public String insert(Entity theEntity) throws StorageObjectFailure {
832 invalidatePopupCache();
834 // invalidating all EntityLists corresponding with theEntityClass
835 if (StoreUtil.extendsStorableEntity(theEntityClass)) {
836 StoreContainerType stoc_type =
837 StoreContainerType.valueOf(theEntityClass,
838 StoreContainerType.STOC_TYPE_ENTITYLIST);
839 o_store.invalidate(stoc_type);
842 String returnId = null;
843 Connection con = null;
844 PreparedStatement pstmt = null;
847 List streamedInput = theEntity.streamedInput();
848 StringBuffer f = new StringBuffer();
849 StringBuffer v = new StringBuffer();
852 boolean firstField = true;
855 for (int i = 0; i < getFields().size(); i++) {
856 aField = (String) getFields().get(i);
858 if (!aField.equals(thePKeyName)) {
862 if (!theEntity.hasValueForField(aField) && (
863 aField.equals("webdb_create") ||
864 aField.equals("webdb_lastchange"))) {
868 if ((streamedInput != null) && streamedInput.contains(aField)) {
872 if (theEntity.hasValueForField(aField)) {
875 JDBCStringRoutines.escapeStringLiteral((String) theEntity.getValue(aField)) + "'";
880 // wenn Wert gegeben, dann einbauen
881 if (aValue != null) {
882 if (firstField == false) {
898 StringBuffer sqlBuf =
899 new StringBuffer("insert into ").append(theTable).append("(").append(f)
900 .append(") values (").append(v).append(")");
901 String sql = sqlBuf.toString();
903 logger.debug("INSERT: " + sql);
904 con = getPooledCon();
905 con.setAutoCommit(false);
906 pstmt = con.prepareStatement(sql);
908 if (streamedInput != null) {
909 for (int i = 0; i < streamedInput.size(); i++) {
911 (String) theEntity.getValue((String) streamedInput.get(i));
912 pstmt.setBytes(i + 1, inputString.getBytes());
916 int ret = pstmt.executeUpdate();
923 pstmt = con.prepareStatement("select currval('" + getCoreTable() + "_id_seq')");
925 ResultSet rs = pstmt.executeQuery();
927 returnId = rs.getString(1);
928 theEntity.setId(returnId);
930 catch (SQLException sqe) {
931 throwSQLException(sqe, "insert");
935 con.setAutoCommit(true);
937 catch (Exception e) {
940 freeConnection(con, pstmt);
943 /** @todo store entity in o_store */
948 * Updates an entity in the database
952 public void update(Entity theEntity) throws StorageObjectFailure {
953 Connection con = null;
954 PreparedStatement pstmt = null;
956 /** @todo this is stupid: why do we prepare statement, when we
957 * throw it away afterwards. should be regular statement
958 * update/insert could better be one routine called save()
959 * that chooses to either insert or update depending if we
960 * have a primary key in the entity. i don't know if we
961 * still need the streamed input fields. // rk */
962 /** @todo extension: check if Entity did change, otherwise we don't need
963 * the roundtrip to the database */
964 /** invalidating corresponding entitylists in o_store*/
965 if (StoreUtil.extendsStorableEntity(theEntityClass)) {
966 StoreContainerType stoc_type =
967 StoreContainerType.valueOf(theEntityClass,
968 StoreContainerType.STOC_TYPE_ENTITYLIST);
969 o_store.invalidate(stoc_type);
972 List streamedInput = theEntity.streamedInput();
973 String id = theEntity.getId();
975 StringBuffer fv = new StringBuffer();
976 boolean firstField = true;
979 invalidatePopupCache();
981 // build sql statement
982 for (int i = 0; i < getFields().size(); i++) {
983 aField = (String) metadataFields.get(i);
986 if ( !(aField.equals(thePKeyName) ||
987 aField.equals("webdb_create") ||
988 aField.equals("webdb_lastchange") ||
989 ((streamedInput != null) && streamedInput.contains(aField)))) {
990 if (theEntity.hasValueForField(aField)) {
991 if (firstField == false) {
998 fv.append(aField).append("='").append(JDBCStringRoutines.escapeStringLiteral((String) theEntity.getValue(aField))).append("'");
1000 // fv.append(aField).append("='").append(StringUtil.quote((String)theEntity.getValue(aField))).append("'");
1006 new StringBuffer("update ").append(theTable).append(" set ").append(fv);
1009 if (metadataFields.contains("webdb_lastchange")) {
1010 sql.append(",webdb_lastchange=NOW()");
1013 // special case: the webdb_create requires the field in yyyy-mm-dd HH:mm
1014 // format so anything extra will be ignored. -mh
1015 if (metadataFields.contains("webdb_create") &&
1016 theEntity.hasValueForField("webdb_create")) {
1017 // minimum of 10 (yyyy-mm-dd)...
1018 if (theEntity.getValue("webdb_create").length() >= 10) {
1019 String dateString = theEntity.getValue("webdb_create");
1021 // if only 10, then add 00:00 so it doesn't throw a ParseException
1022 if (dateString.length() == 10) {
1023 dateString = dateString + " 00:00";
1028 java.util.Date d = userInputDateFormat.parse(dateString);
1029 // Timestamp tStamp = new Timestamp(d.getTime());
1030 sql.append(",webdb_create='" + JDBCStringRoutines.formatDate(d) + "'");
1032 catch (ParseException e) {
1033 throw new StorageObjectFailure(e);
1038 if (streamedInput != null) {
1039 for (int i = 0; i < streamedInput.size(); i++) {
1040 sql.append(",").append(streamedInput.get(i)).append("=?");
1044 sql.append(" where id=").append(id);
1045 logger.debug("UPDATE: " + sql);
1048 con = getPooledCon();
1049 con.setAutoCommit(false);
1050 pstmt = con.prepareStatement(sql.toString());
1052 if (streamedInput != null) {
1053 for (int i = 0; i < streamedInput.size(); i++) {
1054 String inputString =
1055 theEntity.getValue((String) streamedInput.get(i));
1056 pstmt.setBytes(i + 1, inputString.getBytes());
1060 pstmt.executeUpdate();
1062 catch (SQLException sqe) {
1063 throwSQLException(sqe, "update");
1067 con.setAutoCommit(true);
1069 catch (Exception e) {
1073 freeConnection(con, pstmt);
1079 * @param id des zu loeschenden Datensatzes
1080 * @return boolean liefert true zurueck, wenn loeschen erfolgreich war.
1082 public boolean delete(String id) throws StorageObjectFailure {
1083 invalidatePopupCache();
1085 // ostore send notification
1086 if (StoreUtil.extendsStorableEntity(theEntityClass)) {
1087 String uniqueId = id;
1089 if (theEntityClass.equals(StorableObjectEntity.class)) {
1090 uniqueId += ("@" + theTable);
1093 logger.debug("CACHE: (del) " + id);
1095 StoreIdentifier search_sid =
1096 new StoreIdentifier(theEntityClass,
1097 StoreContainerType.STOC_TYPE_ENTITY, uniqueId);
1098 o_store.invalidate(search_sid);
1101 /** @todo could be prepared Statement */
1102 Statement stmt = null;
1103 Connection con = null;
1106 "delete from " + theTable + " where " + thePKeyName + "='" + id + "'";
1108 //theLog.printInfo("DELETE " + sql);
1110 con = getPooledCon();
1111 stmt = con.createStatement();
1112 res = stmt.executeUpdate(sql);
1113 } catch (SQLException sqe) {
1114 throwSQLException(sqe, "delete");
1116 freeConnection(con, stmt);
1119 return (res > 0) ? true : false;
1123 * Deletes entities based on a where clause
1125 * @param aWhereClause
1127 * @throws StorageObjectFailure
1129 public int deleteByWhereClause(String aWhereClause) throws StorageObjectFailure {
1130 invalidatePopupCache();
1131 if (StoreUtil.extendsStorableEntity(theEntityClass)) {
1132 StoreContainerType stoc_type = StoreContainerType.valueOf(theEntityClass, StoreContainerType.STOC_TYPE_ENTITYLIST);
1133 o_store.invalidate(stoc_type);
1136 Statement stmt = null;
1137 Connection con = null;
1140 "delete from " + theTable + " where " + aWhereClause;
1142 //theLog.printInfo("DELETE " + sql);
1144 con = getPooledCon();
1145 stmt = con.createStatement();
1146 res = stmt.executeUpdate(sql);
1148 catch (SQLException sqe) {
1149 throwSQLException(sqe, "delete");
1152 freeConnection(con, stmt);
1158 /* noch nicht implementiert.
1159 * @return immer false
1161 public boolean delete(EntityList theEntityList) {
1162 invalidatePopupCache();
1167 /* invalidates the popupCache
1169 protected void invalidatePopupCache() {
1170 /** @todo invalidates toooo much */
1176 * Diese Methode fuehrt den Sqlstring <i>sql</i> aus und timed im Logfile.
1177 * @param stmt Statemnt
1178 * @param sql Sql-String
1180 * @exception StorageObjectException
1182 public ResultSet executeSql(Statement stmt, String sql)
1183 throws StorageObjectFailure, SQLException {
1185 long startTime = System.currentTimeMillis();
1188 rs = stmt.executeQuery(sql);
1190 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1192 catch (SQLException e) {
1193 logger.error(e.getMessage() +"\n" + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1200 public ResultSet executeSql(String sql) throws StorageObjectFailure, SQLException {
1201 long startTime = System.currentTimeMillis();
1202 Connection connection = null;
1203 Statement statement = null;
1206 connection = getPooledCon();
1207 statement = connection.createStatement();
1210 result = statement.executeQuery(sql);
1212 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1215 catch (Throwable e) {
1216 logger.error(e.getMessage() +"\n" + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1217 throw new StorageObjectFailure(e);
1220 if (connection!=null) {
1221 freeConnection(connection, statement);
1226 private Map processRow(ResultSet aResultSet) throws StorageObjectFailure, StorageObjectExc {
1228 Map result = new HashMap();
1229 ResultSetMetaData metaData = aResultSet.getMetaData();
1230 int nrColumns = metaData.getColumnCount();
1231 for (int i=0; i<nrColumns; i++) {
1232 result.put(metaData.getColumnName(i+1), getValueAsString(aResultSet, i+1, metaData.getColumnType(i+1)));
1237 catch (Throwable e) {
1238 throw new StorageObjectFailure(e);
1242 public List executeFreeSql(String sql, int aLimit) throws StorageObjectFailure, StorageObjectExc {
1243 Connection connection = null;
1244 Statement statement = null;
1246 List result = new Vector();
1247 connection = getPooledCon();
1248 statement = connection.createStatement();
1249 ResultSet resultset = executeSql(statement, sql);
1251 while (resultset.next() && result.size() < aLimit) {
1252 result.add(processRow(resultset));
1261 catch (Throwable e) {
1262 throw new StorageObjectFailure(e);
1265 if (connection!=null) {
1266 freeConnection(connection, statement);
1271 public Map executeFreeSingleRowSql(String anSqlStatement) throws StorageObjectFailure, StorageObjectExc {
1273 List resultList = executeFreeSql(anSqlStatement, 1);
1275 if (resultList.size()>0)
1276 return (Map) resultList.get(0);
1283 catch (Throwable t) {
1284 throw new StorageObjectFailure(t);
1288 public String executeFreeSingleValueSql(String sql) throws StorageObjectFailure, StorageObjectExc {
1289 Map row = executeFreeSingleRowSql(sql);
1294 Iterator i = row.values().iterator();
1296 return (String) i.next();
1301 public int getSize(String where) throws SQLException, StorageObjectFailure {
1302 return getSize("", null, where);
1305 * returns the number of rows in the table
1307 public int getSize(String mainTablePrefix, List extraTables, String where) throws SQLException, StorageObjectFailure {
1309 long startTime = System.currentTimeMillis();
1311 String useTable = theTable;
1312 if (mainTablePrefix!=null && mainTablePrefix.trim().length()>0) {
1313 useTable+=" "+mainTablePrefix;
1315 StringBuffer countSql =
1316 new StringBuffer("select count(*) from ").append(useTable);
1317 // append extratables, if necessary
1318 if (extraTables!=null) {
1319 for (int i=0;i < extraTables.size();i++) {
1320 if (!extraTables.get(i).equals("")) {
1321 countSql.append( ", " + extraTables.get(i));
1326 if ((where != null) && (where.length() != 0)) {
1327 countSql.append( " where " + where);
1330 Connection con = null;
1331 Statement stmt = null;
1335 con = getPooledCon();
1336 stmt = con.createStatement();
1338 ResultSet rs = executeSql(stmt, countSql.toString());
1341 result = rs.getInt(1);
1344 catch (SQLException e) {
1345 logger.error("Database.getSize: " + e.getMessage());
1348 freeConnection(con, stmt);
1350 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + countSql);
1355 public int executeUpdate(Statement stmt, String sql)
1356 throws StorageObjectFailure, SQLException {
1358 long startTime = System.currentTimeMillis();
1361 rs = stmt.executeUpdate(sql);
1363 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1365 catch (SQLException e) {
1366 logger.error("Failed: " + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1373 public int executeUpdate(String sql)
1374 throws StorageObjectFailure, SQLException {
1376 long startTime = System.currentTimeMillis();
1377 Connection con = null;
1378 PreparedStatement pstmt = null;
1381 con = getPooledCon();
1382 pstmt = con.prepareStatement(sql);
1383 result = pstmt.executeUpdate();
1385 catch (Throwable e) {
1386 logger.error("Database.executeUpdate(" + sql + "): " + e.getMessage());
1387 throw new StorageObjectFailure("Database.executeUpdate(" + sql + "): " + e.getMessage(), e);
1390 freeConnection(con, pstmt);
1393 logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1398 * Wertet ResultSetMetaData aus und setzt interne Daten entsprechend
1399 * @param md ResultSetMetaData
1400 * @exception StorageObjectException
1402 private void evalMetaData(ResultSetMetaData md) throws StorageObjectFailure {
1403 this.evaluatedMetaData = true;
1404 this.metadataFields = new ArrayList();
1405 this.metadataLabels = new ArrayList();
1406 this.metadataNotNullFields = new ArrayList();
1409 int numFields = md.getColumnCount();
1410 this.metadataTypes = new int[numFields];
1415 for (int i = 1; i <= numFields; i++) {
1416 aField = md.getColumnName(i);
1417 metadataFields.add(aField);
1418 metadataLabels.add(md.getColumnLabel(i));
1419 aType = md.getColumnType(i);
1420 metadataTypes[i - 1] = aType;
1422 if (aField.equals(thePKeyName)) {
1423 thePKeyType = aType;
1427 if (md.isNullable(i) == ResultSetMetaData.columnNullable) {
1428 metadataNotNullFields.add(aField);
1432 catch (SQLException e) {
1433 throwSQLException(e, "evalMetaData");
1438 * Wertet die Metadaten eines Resultsets fuer eine Tabelle aus,
1439 * um die alle Columns und Typen einer Tabelle zu ermitteln.
1441 private void get_meta_data() throws StorageObjectFailure {
1442 Connection con = null;
1443 PreparedStatement pstmt = null;
1444 String sql = "select * from " + theTable + " where 0=1";
1447 con = getPooledCon();
1448 pstmt = con.prepareStatement(sql);
1450 logger.debug("METADATA: " + sql);
1451 ResultSet rs = pstmt.executeQuery();
1452 evalMetaData(rs.getMetaData());
1455 catch (SQLException e) {
1456 throwSQLException(e, "get_meta_data");
1459 freeConnection(con, pstmt);
1463 public Connection getPooledCon() throws StorageObjectFailure {
1464 Connection con = null;
1467 con = SQLManager.getInstance().requestConnection();
1469 catch (SQLException e) {
1470 logger.error("could not connect to the database " + e.getMessage());
1472 throw new StorageObjectFailure("Could not connect to the database", e);
1478 public void freeConnection(Connection con, Statement stmt)
1479 throws StorageObjectFailure {
1480 SQLManager.closeStatement(stmt);
1481 SQLManager.getInstance().returnConnection(con);
1485 * Wertet SQLException aus und wirft dannach eine StorageObjectException
1486 * @param sqe SQLException
1487 * @param wo Funktonsname, in der die SQLException geworfen wurde
1488 * @exception StorageObjectException
1490 protected void throwSQLException(SQLException sqe, String aFunction) throws StorageObjectFailure {
1492 String message = "";
1496 state = sqe.getSQLState();
1497 message = sqe.getMessage();
1498 vendor = sqe.getErrorCode();
1501 String information =
1504 ", vendor= " + vendor +
1505 ", message=" + message +
1506 ", function= " + aFunction;
1508 logger.error(information);
1510 throw new StorageObjectFailure(information, sqe);
1513 protected void _throwStorageObjectException(Exception e, String aFunction)
1514 throws StorageObjectFailure {
1517 logger.error(e.getMessage() + aFunction);
1518 throw new StorageObjectFailure(aFunction, e);
1523 * Loggt Fehlermeldung mit dem Parameter Message und wirft dannach
1524 * eine StorageObjectException
1525 * @param message Nachricht mit dem Fehler
1526 * @exception StorageObjectException
1528 void throwStorageObjectException(String aMessage) throws StorageObjectFailure {
1529 logger.error(aMessage);
1530 throw new StorageObjectFailure(aMessage, null);