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