source/mir/storage/Database.java

   1 /*
   2  * Copyright (C) 2001, 2002 The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  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.
  29  */
  30 package mir.storage;
  31
  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.*;
  48 import java.util.Map;
  49
  50 import com.codestudio.util.SQLManager;
  51
  52 import freemarker.template.SimpleHash;
  53 import freemarker.template.SimpleList;
  54
  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;
  69
  70
  71 /**
  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
  77  * Datenbank erfolgt.
  78  *
  79  * @version $Id: Database.java,v 1.43 2003/05/06 17:37:50 zapata Exp $
  80  * @author rk
  81  *
  82  */
  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;
  86
  87
  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;
  92
  93   static {
  94     // always same object saves a little space
  95     POPUP_EMPTYLINE.put("key", "");
  96     POPUP_EMPTYLINE.put("value", "--");
  97   }
  98
  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();
 125
 126   /**
 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
 132    * erzeugt.
 133    *
 134    * @param   String confFilename Dateiname der Konfigurationsdatei
 135    */
 136   public Database() throws StorageObjectFailure {
 137     try {
 138       configuration = MirPropertiesConfiguration.instance();
 139     }
 140     catch (PropertiesConfigExc e) {
 141       throw new StorageObjectFailure(e);
 142     }
 143     logger = new LoggerWrapper("Database");
 144
 145     String theAdaptorName = configuration.getString("Database.Adaptor");
 146     defaultLimit = Integer.parseInt(configuration.getString("Database.Limit"));
 147
 148     try {
 149       theEntityClass = GENERIC_ENTITY_CLASS;
 150       theAdaptor = (DatabaseAdaptor) Class.forName(theAdaptorName).newInstance();
 151     }
 152     catch (Throwable e) {
 153       logger.error("Error in Database() constructor with " + theAdaptorName + " -- " + e.getMessage());
 154       throw new StorageObjectFailure("Error in Database() constructor.", e);
 155     }
 156   }
 157
 158   /**
 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.
 162    *
 163    * @return Class-Objekt der Entity
 164    */
 165   public java.lang.Class getEntityClass() {
 166     return theEntityClass;
 167   }
 168
 169   /**
 170    * Liefert die Standardbeschr?nkung von select-Statements zur?ck, also
 171    * wieviel Datens?tze per Default selektiert werden.
 172    *
 173    * @return Standard-Anzahl der Datens?tze
 174    */
 175   public int getLimit() {
 176     return defaultLimit;
 177   }
 178
 179   /**
 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
 183    */
 184   public String getIdName() {
 185     return thePKeyName;
 186   }
 187
 188   /**
 189    * Liefert den Namen der Tabelle, auf das sich das Datenbankobjekt bezieht.
 190    *
 191    * @return Name der Tabelle
 192    */
 193   public String getTableName() {
 194     return theTable;
 195   }
 196
 197   /*
 198   *   Dient dazu vererbte Tabellen bei objectrelationalen DBMS
 199   *   zu speichern, wenn die id einer Tabelle in der parenttabelle verwaltet
 200   *   wird.
 201   *   @return liefert theCoreTabel als String zurueck, wenn gesetzt, sonst
 202   *    the Table
 203    */
 204   public String getCoreTable() {
 205     if (theCoreTable != null) {
 206       return theCoreTable;
 207     }
 208     else {
 209       return theTable;
 210     }
 211   }
 212
 213   /**
 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
 217    */
 218   public int[] getTypes() throws StorageObjectFailure {
 219     if (metadataTypes == null) {
 220       get_meta_data();
 221     }
 222
 223     return metadataTypes;
 224   }
 225
 226   /**
 227    * Liefert eine Liste der Labels der Tabellenfelder
 228    * @return ArrayListe mit Labeln
 229    * @exception StorageObjectException
 230    */
 231   public List getLabels() throws StorageObjectFailure {
 232     if (metadataLabels == null) {
 233       get_meta_data();
 234     }
 235
 236     return metadataLabels;
 237   }
 238
 239   /**
 240    * Liefert eine Liste der Felder der Tabelle
 241    * @return ArrayList mit Feldern
 242    * @exception StorageObjectException
 243    */
 244   public List getFields() throws StorageObjectFailure {
 245     if (metadataFields == null) {
 246       get_meta_data();
 247     }
 248
 249     return metadataFields;
 250   }
 251
 252   /*
 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/
 258    */
 259   private String getValueAsString(ResultSet rs, int valueIndex, int aType)
 260     throws StorageObjectFailure {
 261     String outValue = null;
 262
 263     if (rs != null) {
 264       try {
 265         switch (aType) {
 266           case java.sql.Types.BIT:
 267             outValue = (rs.getBoolean(valueIndex) == true) ? "1" : "0";
 268
 269             break;
 270
 271           case java.sql.Types.INTEGER:
 272           case java.sql.Types.SMALLINT:
 273           case java.sql.Types.TINYINT:
 274           case java.sql.Types.BIGINT:
 275
 276             int out = rs.getInt(valueIndex);
 277
 278             if (!rs.wasNull()) {
 279               outValue = new Integer(out).toString();
 280             }
 281
 282             break;
 283
 284           case java.sql.Types.NUMERIC:
 285
 286             /** @todo Numeric can be float or double depending upon
 287              *  metadata.getScale() / especially with oracle */
 288             long outl = rs.getLong(valueIndex);
 289
 290             if (!rs.wasNull()) {
 291               outValue = new Long(outl).toString();
 292             }
 293
 294             break;
 295
 296           case java.sql.Types.REAL:
 297
 298             float tempf = rs.getFloat(valueIndex);
 299
 300             if (!rs.wasNull()) {
 301               tempf *= 10;
 302               tempf += 0.5;
 303
 304               int tempf_int = (int) tempf;
 305               tempf = (float) tempf_int;
 306               tempf /= 10;
 307               outValue = "" + tempf;
 308               outValue = outValue.replace('.', ',');
 309             }
 310
 311             break;
 312
 313           case java.sql.Types.DOUBLE:
 314
 315             double tempd = rs.getDouble(valueIndex);
 316
 317             if (!rs.wasNull()) {
 318               tempd *= 10;
 319               tempd += 0.5;
 320
 321               int tempd_int = (int) tempd;
 322               tempd = (double) tempd_int;
 323               tempd /= 10;
 324               outValue = "" + tempd;
 325               outValue = outValue.replace('.', ',');
 326             }
 327
 328             break;
 329
 330           case java.sql.Types.CHAR:
 331           case java.sql.Types.VARCHAR:
 332           case java.sql.Types.LONGVARCHAR:
 333             outValue = rs.getString(valueIndex);
 334
 335             break;
 336
 337           case java.sql.Types.LONGVARBINARY:
 338             outValue = rs.getString(valueIndex);
 339
 340             break;
 341
 342           case java.sql.Types.TIMESTAMP:
 343
 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.
 347             // -mh
 348             Timestamp timestamp = (rs.getTimestamp(valueIndex));
 349
 350             if (!rs.wasNull()) {
 351               java.util.Date date = new java.util.Date(timestamp.getTime());
 352               outValue = _dateFormatterOut.format(date);
 353               _cal.setTime(date);
 354
 355               int offset =
 356                   _cal.get(Calendar.ZONE_OFFSET) + _cal.get(Calendar.DST_OFFSET);
 357               String tzOffset =
 358                   StringUtil.zeroPaddingNumber(offset / _millisPerHour, 2, 2);
 359               outValue = outValue + "+" + tzOffset;
 360             }
 361
 362             break;
 363
 364           default:
 365             outValue = "<unsupported value>";
 366             logger.warn("Unsupported Datatype: at " + valueIndex + " (" + aType + ")");
 367         }
 368       } catch (SQLException e) {
 369         throw new StorageObjectFailure("Could not get Value out of Resultset -- ",
 370           e);
 371       }
 372     }
 373
 374     return outValue;
 375   }
 376
 377   /*
 378   *   select-Operator um einen Datensatz zu bekommen.
 379   *   @param id Primaerschluessel des Datensatzes.
 380   *   @return liefert EntityObject des gefundenen Datensatzes oder null.
 381    */
 382   public Entity selectById(String id) throws StorageObjectExc {
 383     if ((id == null) || id.equals("")) {
 384       throw new StorageObjectExc("Database.selectById: Missing id");
 385     }
 386
 387     // ask object store for object
 388     if (StoreUtil.implementsStorableObject(theEntityClass)) {
 389       String uniqueId = id;
 390
 391       if (theEntityClass.equals(StorableObjectEntity.class)) {
 392         uniqueId += ("@" + theTable);
 393       }
 394
 395       StoreIdentifier search_sid = new StoreIdentifier(theEntityClass, uniqueId);
 396       logger.debug("CACHE: (dbg) looking for sid " + search_sid.toString());
 397
 398       Entity hit = (Entity) o_store.use(search_sid);
 399
 400       if (hit != null) {
 401         return hit;
 402       }
 403     }
 404
 405     Statement stmt = null;
 406     Connection con = getPooledCon();
 407     Entity returnEntity = null;
 408
 409     try {
 410       ResultSet rs;
 411
 412       /** @todo better prepared statement */
 413       String selectSql =
 414         "select * from " + theTable + " where " + thePKeyName + "=" + id;
 415       stmt = con.createStatement();
 416       rs = executeSql(stmt, selectSql);
 417
 418       if (rs != null) {
 419         if (evaluatedMetaData == false) {
 420           evalMetaData(rs.getMetaData());
 421         }
 422
 423         if (rs.next()) {
 424           returnEntity = makeEntityFromResultSet(rs);
 425         }
 426         else {
 427           logger.debug("No data for id: " + id + " in table " + theTable);
 428         }
 429
 430         rs.close();
 431       }
 432       else {
 433         logger.debug("No Data for Id " + id + " in Table " + theTable);
 434       }
 435     }
 436     catch (SQLException sqe) {
 437       throwSQLException(sqe, "selectById");
 438       return null;
 439     }
 440     catch (NumberFormatException e) {
 441       logger.error("ID is no number: " + id);
 442     }
 443     finally {
 444       freeConnection(con, stmt);
 445     }
 446
 447     return returnEntity;
 448   }
 449
 450   /**
 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
 455    */
 456   public EntityList selectByFieldValue(String aField, String aValue) throws StorageObjectFailure {
 457     return selectByFieldValue(aField, aValue, 0);
 458   }
 459
 460   /**
 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
 466    */
 467   public EntityList selectByFieldValue(String aField, String aValue, int offset) throws StorageObjectFailure {
 468     return selectByWhereClause(aField + "=" + aValue, offset);
 469   }
 470
 471   /**
 472    * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.
 473    * Also offset wird der erste Datensatz genommen.
 474    *
 475    * @param wc where-Clause
 476    * @return EntityList mit den gematchten Entities
 477    * @exception StorageObjectException
 478    */
 479   public EntityList selectByWhereClause(String where) throws StorageObjectFailure {
 480     return selectByWhereClause(where, 0);
 481   }
 482
 483   /**
 484    * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.
 485    * Als maximale Anzahl wird das Limit auf der Konfiguration genommen.
 486    *
 487    * @param wc where-Clause
 488    * @param offset ab welchem Datensatz.
 489    * @return EntityList mit den gematchten Entities
 490    * @exception StorageObjectException
 491    */
 492   public EntityList selectByWhereClause(String whereClause, int offset) throws StorageObjectFailure {
 493     return selectByWhereClause(whereClause, null, offset);
 494   }
 495
 496   /**
 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.
 500    *
 501    * @param wc where-Clause
 502    * @param ob orderBy-Clause
 503    * @return EntityList mit den gematchten Entities
 504    * @exception StorageObjectException
 505    */
 506   public EntityList selectByWhereClause(String where, String order) throws StorageObjectFailure {
 507     return selectByWhereClause(where, order, 0);
 508   }
 509
 510   /**
 511    * select-Operator liefert eine EntityListe mit den gematchten Datens?tzen zur?ck.
 512    * Als maximale Anzahl wird das Limit auf der Konfiguration genommen.
 513    *
 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
 519    */
 520   public EntityList selectByWhereClause(String whereClause, String orderBy, int offset) throws StorageObjectFailure {
 521     return selectByWhereClause(whereClause, orderBy, offset, defaultLimit);
 522   }
 523
 524   /**
 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
 532    */
 533   public EntityList selectByWhereClause(String aWhereClause, String anOrderByClause,
 534             int offset, int limit) throws StorageObjectFailure {
 535
 536     // check o_store for entitylist
 537     if (StoreUtil.implementsStorableObject(theEntityClass)) {
 538       StoreIdentifier search_sid =
 539           new StoreIdentifier(
 540             theEntityClass, StoreContainerType.STOC_TYPE_ENTITYLIST,
 541             StoreUtil.getEntityListUniqueIdentifierFor(theTable, aWhereClause, anOrderByClause, offset, limit));
 542       EntityList hit = (EntityList) o_store.use(search_sid);
 543
 544       if (hit != null) {
 545         logger.debug("CACHE (hit): " + search_sid.toString());
 546
 547         return hit;
 548       }
 549     }
 550
 551     // local
 552     EntityList theReturnList = null;
 553     Connection con = null;
 554     Statement stmt = null;
 555     ResultSet rs;
 556     int offsetCount = 0;
 557     int count = 0;
 558
 559     // build sql-statement
 560
 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)) {
 564       aWhereClause = null;
 565     }
 566
 567     StringBuffer countSql =
 568       new StringBuffer("select count(*) from ").append(theTable);
 569     StringBuffer selectSql =
 570       new StringBuffer("select * from ").append(theTable);
 571
 572     if (aWhereClause != null) {
 573       selectSql.append(" where ").append(aWhereClause);
 574       countSql.append(" where ").append(aWhereClause);
 575     }
 576
 577     if ((anOrderByClause != null) && !(anOrderByClause.trim().length() == 0)) {
 578       selectSql.append(" order by ").append(anOrderByClause);
 579     }
 580
 581     if (theAdaptor.hasLimit()) {
 582       if ((limit > -1) && (offset > -1)) {
 583         selectSql.append(" LIMIT ").append(limit).append(" OFFSET ").append(offset);
 584       }
 585     }
 586
 587     // execute sql
 588     try {
 589       con = getPooledCon();
 590       stmt = con.createStatement();
 591
 592       // selecting...
 593       rs = executeSql(stmt, selectSql.toString());
 594
 595       if (rs != null) {
 596         if (!evaluatedMetaData) {
 597           evalMetaData(rs.getMetaData());
 598         }
 599
 600         theReturnList = new EntityList();
 601
 602         Entity theResultEntity;
 603
 604         while (rs.next()) {
 605           theResultEntity = makeEntityFromResultSet(rs);
 606           theReturnList.add(theResultEntity);
 607           offsetCount++;
 608         }
 609
 610         rs.close();
 611       }
 612
 613       // making entitylist infos
 614       if (!(theAdaptor.hasLimit())) {
 615         count = offsetCount;
 616       }
 617
 618       if (theReturnList != null) {
 619         // now we decide if we have to know an overall count...
 620         count = offsetCount;
 621
 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());
 627
 628             if (rs != null) {
 629               if (rs.next()) {
 630                 count = rs.getInt(1);
 631               }
 632
 633               rs.close();
 634             }
 635             else {
 636               logger.error("Could not count: " + countSql);
 637             }
 638           }
 639         }
 640
 641         theReturnList.setCount(count);
 642         theReturnList.setOffset(offset);
 643         theReturnList.setWhere(aWhereClause);
 644         theReturnList.setOrder(anOrderByClause);
 645         theReturnList.setStorage(this);
 646         theReturnList.setLimit(limit);
 647
 648         if (offset >= limit) {
 649           theReturnList.setPrevBatch(offset - limit);
 650         }
 651
 652         if ((offset + offsetCount) < count) {
 653           theReturnList.setNextBatch(offset + limit);
 654         }
 655
 656         if (StoreUtil.implementsStorableObject(theEntityClass)) {
 657           StoreIdentifier sid = theReturnList.getStoreIdentifier();
 658           logger.debug("CACHE (add): " + sid.toString());
 659           o_store.add(sid);
 660         }
 661       }
 662     } catch (SQLException sqe) {
 663       throwSQLException(sqe, "selectByWhereClause");
 664     } finally {
 665       try {
 666         if (con != null) {
 667           freeConnection(con, stmt);
 668         }
 669       } catch (Throwable t) {
 670       }
 671     }
 672
 673     return theReturnList;
 674   }
 675
 676   /**
 677    *  Bastelt aus einer Zeile der Datenbank ein EntityObjekt.
 678    *
 679    *  @param rs Das ResultSetObjekt.
 680    *  @return Entity Die Entity.
 681    */
 682   private Entity makeEntityFromResultSet(ResultSet rs)
 683     throws StorageObjectFailure {
 684     /** @todo OS: get Pkey from ResultSet and consult ObjectStore */
 685     Map theResultHash = new HashMap();
 686     String theResult = null;
 687     int theType;
 688     Entity returnEntity = null;
 689
 690     try {
 691       int size = metadataFields.size();
 692
 693       for (int i = 0; i < size; i++) {
 694         // alle durchlaufen bis nix mehr da
 695         theType = metadataTypes[i];
 696
 697         if (theType == java.sql.Types.LONGVARBINARY) {
 698           InputStreamReader is =
 699             (InputStreamReader) rs.getCharacterStream(i + 1);
 700
 701           if (is != null) {
 702             char[] data = new char[32768];
 703             StringBuffer theResultString = new StringBuffer();
 704             int len;
 705
 706             while ((len = is.read(data)) > 0) {
 707               theResultString.append(data, 0, len);
 708             }
 709
 710             is.close();
 711             theResult = theResultString.toString();
 712           } else {
 713             theResult = null;
 714           }
 715         } else {
 716           theResult = getValueAsString(rs, (i + 1), theType);
 717         }
 718
 719         if (theResult != null) {
 720           theResultHash.put(metadataFields.get(i), theResult);
 721         }
 722       }
 723
 724       if (theEntityClass != null) {
 725         returnEntity = (Entity) theEntityClass.newInstance();
 726         returnEntity.setValues(theResultHash);
 727         returnEntity.setStorage(this);
 728
 729         if (returnEntity instanceof StorableObject) {
 730           logger.debug("CACHE: ( in) " + returnEntity.getId() + " :" + theTable);
 731           o_store.add(((StorableObject) returnEntity).getStoreIdentifier());
 732         }
 733       } else {
 734         throwStorageObjectException("Internal Error: theEntityClass not set!");
 735       }
 736     }
 737     catch (IllegalAccessException e) {
 738       throwStorageObjectException("No access! -- " + e.getMessage());
 739     }
 740     catch (IOException e) {
 741       throwStorageObjectException("IOException! -- " + e.getMessage());
 742     }
 743     catch (InstantiationException e) {
 744       throwStorageObjectException("No Instatiation! -- " + e.getMessage());
 745     }
 746     catch (SQLException sqe) {
 747       throwSQLException(sqe, "makeEntityFromResultSet");
 748
 749       return null;
 750     }
 751
 752     return returnEntity;
 753   }
 754
 755   /**
 756    * Inserts an entity into the database.
 757    *
 758    * @param theEntity
 759    * @return der Wert des Primary-keys der eingef?gten Entity
 760    */
 761   public String insert(Entity theEntity) throws StorageObjectFailure {
 762     //cache
 763     invalidatePopupCache();
 764
 765     // invalidating all EntityLists corresponding with theEntityClass
 766     if (StoreUtil.implementsStorableObject(theEntityClass)) {
 767       StoreContainerType stoc_type =
 768         StoreContainerType.valueOf(theEntityClass,
 769           StoreContainerType.STOC_TYPE_ENTITYLIST);
 770       o_store.invalidate(stoc_type);
 771     }
 772
 773     String returnId = null;
 774     Connection con = null;
 775     PreparedStatement pstmt = null;
 776
 777     try {
 778       List streamedInput = theEntity.streamedInput();
 779       StringBuffer f = new StringBuffer();
 780       StringBuffer v = new StringBuffer();
 781       String aField;
 782       String aValue;
 783       boolean firstField = true;
 784
 785       // make sql-string
 786       for (int i = 0; i < getFields().size(); i++) {
 787         aField = (String) getFields().get(i);
 788
 789         if (!aField.equals(thePKeyName)) {
 790           aValue = null;
 791
 792           // exceptions
 793           if (aField.equals("webdb_create") ||
 794               aField.equals("webdb_lastchange")) {
 795             aValue = "NOW()";
 796           }
 797           else {
 798             if ((streamedInput != null) && streamedInput.contains(aField)) {
 799               aValue = "?";
 800             } else {
 801               if (theEntity.hasValueForField(aField)) {
 802                 aValue =
 803                   "'" +
 804                   JDBCStringRoutines.escapeStringLiteral((String) theEntity.getValue(
 805                       aField)) + "'";
 806               }
 807             }
 808           }
 809
 810           // wenn Wert gegeben, dann einbauen
 811           if (aValue != null) {
 812             if (firstField == false) {
 813               f.append(",");
 814               v.append(",");
 815             }
 816             else {
 817               firstField = false;
 818             }
 819
 820             f.append(aField);
 821             v.append(aValue);
 822           }
 823         }
 824       }
 825        // end for
 826
 827       // insert into db
 828       StringBuffer sqlBuf =
 829         new StringBuffer("insert into ").append(theTable).append("(").append(f)
 830                                         .append(") values (").append(v).append(")");
 831       String sql = sqlBuf.toString();
 832
 833       logger.debug("INSERT: " + sql);
 834       con = getPooledCon();
 835       con.setAutoCommit(false);
 836       pstmt = con.prepareStatement(sql);
 837
 838       if (streamedInput != null) {
 839         for (int i = 0; i < streamedInput.size(); i++) {
 840           String inputString =
 841             (String) theEntity.getValue((String) streamedInput.get(i));
 842           pstmt.setBytes(i + 1, inputString.getBytes());
 843         }
 844       }
 845
 846       int ret = pstmt.executeUpdate();
 847
 848       if (ret == 0) {
 849         //insert failed
 850         return null;
 851       }
 852
 853       pstmt = con.prepareStatement(theAdaptor.getLastInsertSQL(this));
 854
 855       ResultSet rs = pstmt.executeQuery();
 856       rs.next();
 857       returnId = rs.getString(1);
 858       theEntity.setId(returnId);
 859     }
 860     catch (SQLException sqe) {
 861       throwSQLException(sqe, "insert");
 862     }
 863     finally {
 864       try {
 865         con.setAutoCommit(true);
 866       }
 867       catch (Exception e) {
 868       }
 869
 870       freeConnection(con, pstmt);
 871     }
 872
 873     /** @todo store entity in o_store */
 874     return returnId;
 875   }
 876
 877   /**
 878    * Updates an entity in the database
 879    *
 880    * @param theEntity
 881    */
 882   public void update(Entity theEntity) throws StorageObjectFailure {
 883     Connection con = null;
 884     PreparedStatement pstmt = null;
 885
 886     /** @todo this is stupid: why do we prepare statement, when we
 887      *  throw it away afterwards. should be regular statement
 888      *  update/insert could better be one routine called save()
 889      *  that chooses to either insert or update depending if we
 890      *  have a primary key in the entity. i don't know if we
 891      *  still need the streamed input fields. // rk  */
 892     /** @todo extension: check if Entity did change, otherwise we don't need
 893      *  the roundtrip to the database */
 894     /** invalidating corresponding entitylists in o_store*/
 895     if (StoreUtil.implementsStorableObject(theEntityClass)) {
 896       StoreContainerType stoc_type =
 897         StoreContainerType.valueOf(theEntityClass,
 898           StoreContainerType.STOC_TYPE_ENTITYLIST);
 899       o_store.invalidate(stoc_type);
 900     }
 901
 902     List streamedInput = theEntity.streamedInput();
 903     String id = theEntity.getId();
 904     String aField;
 905     StringBuffer fv = new StringBuffer();
 906     boolean firstField = true;
 907
 908     //cache
 909     invalidatePopupCache();
 910
 911     // build sql statement
 912     for (int i = 0; i < getFields().size(); i++) {
 913       aField = (String) metadataFields.get(i);
 914
 915       // only normal cases
 916       if (  !(aField.equals(thePKeyName) ||
 917             aField.equals("webdb_create") ||
 918             aField.equals("webdb_lastchange") ||
 919             ((streamedInput != null) && streamedInput.contains(aField)))) {
 920         if (theEntity.hasValueForField(aField)) {
 921           if (firstField == false) {
 922             fv.append(", ");
 923           }
 924           else {
 925             firstField = false;
 926           }
 927
 928           fv.append(aField).append("='").append(JDBCStringRoutines.escapeStringLiteral((String) theEntity.getValue(aField))).append("'");
 929
 930           //              fv.append(aField).append("='").append(StringUtil.quote((String)theEntity.getValue(aField))).append("'");
 931         }
 932       }
 933     }
 934
 935     StringBuffer sql =
 936       new StringBuffer("update ").append(theTable).append(" set ").append(fv);
 937
 938     // exceptions
 939     if (metadataFields.contains("webdb_lastchange")) {
 940       sql.append(",webdb_lastchange=NOW()");
 941     }
 942
 943     // special case: the webdb_create requires the field in yyyy-mm-dd HH:mm
 944     // format so anything extra will be ignored. -mh
 945     if (metadataFields.contains("webdb_create") &&
 946         theEntity.hasValueForField("webdb_create")) {
 947       // minimum of 10 (yyyy-mm-dd)...
 948       if (theEntity.getValue("webdb_create").length() >= 10) {
 949         String dateString = theEntity.getValue("webdb_create");
 950
 951         // if only 10, then add 00:00 so it doesn't throw a ParseException
 952         if (dateString.length() == 10) {
 953           dateString = dateString + " 00:00";
 954         }
 955
 956         // TimeStamp stuff
 957         try {
 958           java.util.Date d = _dateFormatterIn.parse(dateString);
 959           Timestamp tStamp = new Timestamp(d.getTime());
 960           sql.append(",webdb_create='" + tStamp.toString() + "'");
 961         } catch (ParseException e) {
 962           throw new StorageObjectFailure(e);
 963         }
 964       }
 965     }
 966
 967     if (streamedInput != null) {
 968       for (int i = 0; i < streamedInput.size(); i++) {
 969         sql.append(",").append(streamedInput.get(i)).append("=?");
 970       }
 971     }
 972
 973     sql.append(" where id=").append(id);
 974     logger.debug("UPDATE: " + sql);
 975
 976     try {
 977       con = getPooledCon();
 978       con.setAutoCommit(false);
 979       pstmt = con.prepareStatement(sql.toString());
 980
 981       if (streamedInput != null) {
 982         for (int i = 0; i < streamedInput.size(); i++) {
 983           String inputString =
 984             theEntity.getValue((String) streamedInput.get(i));
 985           pstmt.setBytes(i + 1, inputString.getBytes());
 986         }
 987       }
 988
 989       pstmt.executeUpdate();
 990     }
 991     catch (SQLException sqe) {
 992       throwSQLException(sqe, "update");
 993     }
 994     finally {
 995       try {
 996         con.setAutoCommit(true);
 997       }
 998       catch (Exception e) {
 999         ;
1000       }
1001
1002       freeConnection(con, pstmt);
1003     }
1004   }
1005
1006   /*
1007   *   delete-Operator
1008   *   @param id des zu loeschenden Datensatzes
1009   *   @return boolean liefert true zurueck, wenn loeschen erfolgreich war.
1010    */
1011   public boolean delete(String id) throws StorageObjectFailure {
1012     invalidatePopupCache();
1013
1014     // ostore send notification
1015     if (StoreUtil.implementsStorableObject(theEntityClass)) {
1016       String uniqueId = id;
1017
1018       if (theEntityClass.equals(StorableObjectEntity.class)) {
1019         uniqueId += ("@" + theTable);
1020       }
1021
1022       logger.debug("CACHE: (del) " + id);
1023
1024       StoreIdentifier search_sid =
1025         new StoreIdentifier(theEntityClass,
1026           StoreContainerType.STOC_TYPE_ENTITY, uniqueId);
1027       o_store.invalidate(search_sid);
1028     }
1029
1030     /** @todo could be prepared Statement */
1031     Statement stmt = null;
1032     Connection con = null;
1033     int res = 0;
1034     String sql =
1035       "delete from " + theTable + " where " + thePKeyName + "='" + id + "'";
1036
1037     //theLog.printInfo("DELETE " + sql);
1038     try {
1039       con = getPooledCon();
1040       stmt = con.createStatement();
1041       res = stmt.executeUpdate(sql);
1042     } catch (SQLException sqe) {
1043       throwSQLException(sqe, "delete");
1044     } finally {
1045       freeConnection(con, stmt);
1046     }
1047
1048     return (res > 0) ? true : false;
1049   }
1050
1051   /* noch nicht implementiert.
1052   * @return immer false
1053    */
1054   public boolean delete(EntityList theEntityList) {
1055     invalidatePopupCache();
1056
1057     return false;
1058   }
1059
1060   /**
1061    * Diese Methode sollte ueberschrieben werden, wenn fuer die abgeleitete Database-Klasse
1062    * eine SimpleList mit Standard-Popupdaten erzeugt werden koennen soll.
1063    * @return null
1064    */
1065   public SimpleList getPopupData() throws StorageObjectFailure {
1066     return null;
1067   }
1068
1069   /**
1070    *  Holt Daten fuer Popups.
1071    *  @param name  Name des Feldes.
1072    *  @param hasNullValue  Wenn true wird eine leerer  Eintrag fuer die Popups erzeugt.
1073    *  @return SimpleList Gibt freemarker.template.SimpleList zurueck.
1074    */
1075   public SimpleList getPopupData(String name, boolean hasNullValue)
1076     throws StorageObjectFailure {
1077     return getPopupData(name, hasNullValue, null);
1078   }
1079
1080   /**
1081    *  Holt Daten fuer Popups.
1082    *  @param name  Name des Feldes.
1083    *  @param hasNullValue  Wenn true wird eine leerer  Eintrag fuer die Popups erzeugt.
1084    *  @param where  Schraenkt die Selektion der Datensaetze ein.
1085    *  @return SimpleList Gibt freemarker.template.SimpleList zurueck.
1086    */
1087   public SimpleList getPopupData(String name, boolean hasNullValue, String where)
1088     throws StorageObjectFailure {
1089     return getPopupData(name, hasNullValue, where, null);
1090   }
1091
1092   /**
1093    *  Holt Daten fuer Popups.
1094    *  @param name  Name des Feldes.
1095    *  @param hasNullValue  Wenn true wird eine leerer  Eintrag fuer die Popups erzeugt.
1096    *  @param where  Schraenkt die Selektion der Datensaetze ein.
1097    *  @param order  Gibt ein Feld als Sortierkriterium an.
1098    *  @return SimpleList Gibt freemarker.template.SimpleList zurueck.
1099    */
1100   public SimpleList getPopupData(String name, boolean hasNullValue,
1101     String where, String order) throws StorageObjectFailure {
1102     // caching
1103     if (hasPopupCache && (popupCache != null)) {
1104       return popupCache;
1105     }
1106
1107     SimpleList simpleList = null;
1108     Connection con = null;
1109     Statement stmt = null;
1110
1111     // build sql
1112     StringBuffer sql =
1113       new StringBuffer("select ").append(thePKeyName).append(",").append(name)
1114                                  .append(" from ").append(theTable);
1115
1116     if ((where != null) && !(where.length() == 0)) {
1117       sql.append(" where ").append(where);
1118     }
1119
1120     sql.append(" order by ");
1121
1122     if ((order != null) && !(order.length() == 0)) {
1123       sql.append(order);
1124     } else {
1125       sql.append(name);
1126     }
1127
1128     // execute sql
1129     try {
1130       con = getPooledCon();
1131     } catch (Exception e) {
1132       throw new StorageObjectFailure(e);
1133     }
1134
1135     try {
1136       stmt = con.createStatement();
1137
1138       ResultSet rs = executeSql(stmt, sql.toString());
1139
1140       if (rs != null) {
1141         if (!evaluatedMetaData) {
1142           get_meta_data();
1143         }
1144
1145         simpleList = new SimpleList();
1146
1147         // if popup has null-selector
1148         if (hasNullValue) {
1149           simpleList.add(POPUP_EMPTYLINE);
1150         }
1151
1152         SimpleHash popupDict;
1153
1154         while (rs.next()) {
1155           popupDict = new SimpleHash();
1156           popupDict.put("key", getValueAsString(rs, 1, thePKeyType));
1157           popupDict.put("value", rs.getString(2));
1158           simpleList.add(popupDict);
1159         }
1160
1161         rs.close();
1162       }
1163     }
1164     catch (Exception e) {
1165       logger.error("getPopupData: " + e.getMessage());
1166       throw new StorageObjectFailure(e);
1167     } finally {
1168       freeConnection(con, stmt);
1169     }
1170
1171     if (hasPopupCache) {
1172       popupCache = simpleList;
1173     }
1174
1175     return simpleList;
1176   }
1177
1178   /**
1179    * Liefert alle Daten der Tabelle als SimpleHash zurueck. Dies wird verwandt,
1180    * wenn in den Templates ein Lookup-Table benoetigt wird. Sollte nur bei kleinen
1181    * Tabellen Verwendung finden.
1182    * @return SimpleHash mit den Tabellezeilen.
1183    */
1184   public SimpleHash getHashData() {
1185     /** @todo dangerous! this should have a flag to be enabled, otherwise
1186      *  very big Hashes could be returned */
1187     if (hashCache == null) {
1188       try {
1189         hashCache =
1190           HTMLTemplateProcessor.makeSimpleHash(selectByWhereClause("", -1));
1191       }
1192       catch (StorageObjectFailure e) {
1193         logger.debug(e.getMessage());
1194       }
1195     }
1196
1197     return hashCache;
1198   }
1199
1200   /* invalidates the popupCache
1201    */
1202   protected void invalidatePopupCache() {
1203     /** @todo  invalidates toooo much */
1204     popupCache = null;
1205     hashCache = null;
1206   }
1207
1208   /**
1209    * Diese Methode fuehrt den Sqlstring <i>sql</i> aus und timed im Logfile.
1210    * @param stmt Statemnt
1211    * @param sql Sql-String
1212    * @return ResultSet
1213    * @exception StorageObjectException
1214    */
1215   public ResultSet executeSql(Statement stmt, String sql)
1216                             throws StorageObjectFailure, SQLException {
1217     ResultSet rs;
1218     long startTime = System.currentTimeMillis();
1219
1220     try {
1221       rs = stmt.executeQuery(sql);
1222
1223       logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1224     }
1225     catch (SQLException e) {
1226       logger.error(e.getMessage() +"\n" + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1227       throw e;
1228     }
1229
1230     return rs;
1231   }
1232
1233   public ResultSet executeSql(String sql) throws StorageObjectFailure, SQLException {
1234     long startTime = System.currentTimeMillis();
1235     Connection connection = null;
1236     Statement statement = null;
1237
1238     try {
1239       connection = getPooledCon();
1240       statement = connection.createStatement();
1241       ResultSet result;
1242
1243       result = statement.executeQuery(sql);
1244
1245       logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1246       return result;
1247     }
1248     catch (Throwable e) {
1249       logger.error(e.getMessage() +"\n" + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1250       throw new StorageObjectFailure(e);
1251     }
1252     finally {
1253       if (connection!=null) {
1254         freeConnection(connection, statement);
1255       }
1256     }
1257   }
1258
1259   private Map processRow(ResultSet aResultSet) throws StorageObjectFailure, StorageObjectExc {
1260     try {
1261       Map result = new HashMap();
1262       ResultSetMetaData metaData = aResultSet.getMetaData();
1263       int nrColumns = metaData.getColumnCount();
1264       for (int i=0; i<nrColumns; i++) {
1265         result.put(metaData.getColumnName(i+1), getValueAsString(aResultSet, i+1, metaData.getColumnType(i+1)));
1266       }
1267
1268       return result;
1269     }
1270     catch (Throwable e) {
1271       throw new StorageObjectFailure(e);
1272     }
1273   }
1274
1275   public List executeFreeSql(String sql, int aLimit) throws StorageObjectFailure, StorageObjectExc {
1276     try {
1277       List result = new Vector();
1278       ResultSet resultset = executeSql(sql);
1279       try {
1280         while (resultset.next() && result.size() < aLimit) {
1281           result.add(processRow(resultset));
1282         }
1283       }
1284       finally {
1285         resultset.close();
1286       }
1287
1288       return result;
1289     }
1290     catch (Throwable e) {
1291       throw new StorageObjectFailure(e);
1292     }
1293   };
1294
1295   public Map executeFreeSingleRowSql(String sql) throws StorageObjectFailure, StorageObjectExc {
1296     try {
1297       ResultSet resultset = executeSql(sql);
1298       try {
1299
1300         if (resultset.next())
1301           return processRow(resultset);
1302         else
1303           return null;
1304       }
1305       finally {
1306         resultset.close();
1307       }
1308     }
1309     catch (Throwable t) {
1310       throw new StorageObjectFailure(t);
1311     }
1312   };
1313
1314   public String executeFreeSingleValueSql(String sql) throws StorageObjectFailure, StorageObjectExc {
1315     Map row = executeFreeSingleRowSql(sql);
1316
1317     if (row==null)
1318       return null;
1319
1320     Iterator i = row.values().iterator();
1321     if (i.hasNext())
1322       return (String) i.next();
1323     else
1324       return null;
1325   };
1326
1327   /**
1328    * returns the number of rows in the table
1329    */
1330   public int getSize(String where) throws SQLException, StorageObjectFailure {
1331     long startTime = System.currentTimeMillis();
1332     String sql = "SELECT Count(*) FROM " + theTable;
1333
1334     if ((where != null) && (where.length() != 0)) {
1335       sql = sql + " where " + where;
1336     }
1337
1338     Connection con = null;
1339     Statement stmt = null;
1340     int result = 0;
1341
1342     try {
1343       con = getPooledCon();
1344       stmt = con.createStatement();
1345
1346       ResultSet rs = executeSql(stmt, sql);
1347
1348       while (rs.next()) {
1349         result = rs.getInt(1);
1350       }
1351     }
1352     catch (SQLException e) {
1353       logger.error("Database.getSize: " + e.getMessage());
1354     }
1355     finally {
1356       freeConnection(con, stmt);
1357     }
1358
1359     //theLog.printInfo(theTable + " has "+ result +" rows where " + where);
1360     logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1361
1362     return result;
1363   }
1364
1365   public int executeUpdate(Statement stmt, String sql)
1366     throws StorageObjectFailure, SQLException {
1367     int rs;
1368     long startTime = System.currentTimeMillis();
1369
1370     try {
1371       rs = stmt.executeUpdate(sql);
1372
1373       logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1374     }
1375     catch (SQLException e) {
1376       logger.error("Failed: " + (System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1377       throw e;
1378     }
1379
1380     return rs;
1381   }
1382
1383   public int executeUpdate(String sql)
1384     throws StorageObjectFailure, SQLException {
1385     int result = -1;
1386     long startTime = System.currentTimeMillis();
1387     Connection con = null;
1388     PreparedStatement pstmt = null;
1389
1390     try {
1391       con = getPooledCon();
1392       pstmt = con.prepareStatement(sql);
1393       result = pstmt.executeUpdate();
1394     }
1395     catch (Throwable e) {
1396       logger.error("Database.executeUpdate(" + sql + "): " + e.getMessage());
1397       throw new StorageObjectFailure("Database.executeUpdate(" + sql + "): " + e.getMessage(), e);
1398     }
1399     finally {
1400       freeConnection(con, pstmt);
1401     }
1402
1403     logger.debug((System.currentTimeMillis() - startTime) + "ms. for: " + sql);
1404     return result;
1405   }
1406
1407   /**
1408    * Wertet ResultSetMetaData aus und setzt interne Daten entsprechend
1409    * @param md ResultSetMetaData
1410    * @exception StorageObjectException
1411    */
1412   private void evalMetaData(ResultSetMetaData md) throws StorageObjectFailure {
1413     this.evaluatedMetaData = true;
1414     this.metadataFields = new ArrayList();
1415     this.metadataLabels = new ArrayList();
1416     this.metadataNotNullFields = new ArrayList();
1417
1418     try {
1419       int numFields = md.getColumnCount();
1420       this.metadataTypes = new int[numFields];
1421
1422       String aField;
1423       int aType;
1424
1425       for (int i = 1; i <= numFields; i++) {
1426         aField = md.getColumnName(i);
1427         metadataFields.add(aField);
1428         metadataLabels.add(md.getColumnLabel(i));
1429         aType = md.getColumnType(i);
1430         metadataTypes[i - 1] = aType;
1431
1432         if (aField.equals(thePKeyName)) {
1433           thePKeyType = aType;
1434           thePKeyIndex = i;
1435         }
1436
1437         if (md.isNullable(i) == ResultSetMetaData.columnNullable) {
1438           metadataNotNullFields.add(aField);
1439         }
1440       }
1441     }
1442     catch (SQLException e) {
1443       throwSQLException(e, "evalMetaData");
1444     }
1445   }
1446
1447   /**
1448    *  Wertet die Metadaten eines Resultsets fuer eine Tabelle aus,
1449    *  um die alle Columns und Typen einer Tabelle zu ermitteln.
1450    */
1451   private void get_meta_data() throws StorageObjectFailure {
1452     Connection con = null;
1453     PreparedStatement pstmt = null;
1454     String sql = "select * from " + theTable + " where 0=1";
1455
1456     try {
1457       con = getPooledCon();
1458       pstmt = con.prepareStatement(sql);
1459
1460       logger.debug("METADATA: " + sql);
1461       ResultSet rs = pstmt.executeQuery();
1462       evalMetaData(rs.getMetaData());
1463       rs.close();
1464     }
1465     catch (SQLException e) {
1466       throwSQLException(e, "get_meta_data");
1467     }
1468     finally {
1469       freeConnection(con, pstmt);
1470     }
1471   }
1472
1473   public Connection getPooledCon() throws StorageObjectFailure {
1474     Connection con = null;
1475
1476     try {
1477       con = SQLManager.getInstance().requestConnection();
1478     }
1479     catch (SQLException e) {
1480       logger.error("could not connect to the database " + e.getMessage());
1481
1482       throw new StorageObjectFailure("Could not connect to the database", e);
1483     }
1484
1485     return con;
1486   }
1487
1488   public void freeConnection(Connection con, Statement stmt)
1489     throws StorageObjectFailure {
1490     SQLManager.closeStatement(stmt);
1491     SQLManager.getInstance().returnConnection(con);
1492   }
1493
1494   /**
1495    * Wertet SQLException aus und wirft dannach eine StorageObjectException
1496    * @param sqe SQLException
1497    * @param wo Funktonsname, in der die SQLException geworfen wurde
1498    * @exception StorageObjectException
1499    */
1500   protected void throwSQLException(SQLException sqe, String aFunction) throws StorageObjectFailure {
1501     String state = "";
1502     String message = "";
1503     int vendor = 0;
1504
1505     if (sqe != null) {
1506       state = sqe.getSQLState();
1507       message = sqe.getMessage();
1508       vendor = sqe.getErrorCode();
1509     }
1510
1511     String information =
1512         "SQL Error: " +
1513         "state= " + state +
1514         ", vendor= " + vendor +
1515         ", message=" + message +
1516         ", function= " + aFunction;
1517
1518     logger.error(information);
1519
1520     throw new StorageObjectFailure(information, sqe);
1521   }
1522
1523   protected void _throwStorageObjectException(Exception e, String aFunction)
1524     throws StorageObjectFailure {
1525
1526     if (e != null) {
1527       logger.error(e.getMessage() + aFunction);
1528       throw new StorageObjectFailure(aFunction, e);
1529     }
1530   }
1531
1532   /**
1533    * Loggt Fehlermeldung mit dem Parameter Message und wirft dannach
1534    * eine StorageObjectException
1535    * @param message Nachricht mit dem Fehler
1536    * @exception StorageObjectException
1537    */
1538   void throwStorageObjectException(String aMessage) throws StorageObjectFailure {
1539     logger.error(aMessage);
1540     throw new StorageObjectFailure(aMessage, null);
1541   }
1542 }