////////////////////////////////////////////////////////////////////////////////
   //CabaWeb
   //Copyright (C) 2004  Thomas Vogt <Thomas.Vogt@TVC-Software.com>
   //
   //This library is free software; you can redistribute it and/or
   //modify it under the terms of the GNU Lesser General Public
   //License as published by the Free Software Foundation; either
   //version 2.1 of the License, or (at your option) any later version.
   //
  //This library is distributed in the hope that it will be useful,
  //but WITHOUT ANY WARRANTY; without even the implied warranty of
  //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  //Lesser General Public License for more details.
  //
  //You should have received a copy of the GNU Lesser General Public
  //License along with this library; if not, write to the Free Software
  //Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  ////////////////////////////////////////////////////////////////////////////////
  
  package org.fhw.cabaweb.data.abstracts;
  
  import java.util.Collection;
  import java.util.Locale;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  import org.apache.ojb.broker.PersistenceBroker;
  import org.apache.ojb.broker.PersistenceBrokerFactory;
  
  import org.fhw.cabaweb.ojb.interfaces.UseCase;
  
  /***
   * Abstrakte Klasse f&uuml;r die Daten Kapselung
   *
   * @author  <a href="mailto:thomas.vogt@tvc-software.com">Thomas Vogt</a>
   * @version Version 1.0 07.05.2004
   */
  public abstract class AbstractDataInterface
  {
      /***
       * The <code>Log</code> instance for this application.
       */
      protected Log log = LogFactory.getLog("org.fhw.cabaweb.data.abstracts.AbstractDataInterface");
  
      /*** Instanz des Persistenzbrokers */
      protected PersistenceBroker broker;
  
      /*** Instanz der aktuellen Locale */
      protected Locale locale;
  
      /*** Instanz des OJB UseCase Interfaces */
      protected UseCase useCase;
  
      /***
       * AbstractDataInterface Konstruktor.
       *
       * Locale Default de_DE
       */
      public AbstractDataInterface()
      {
          this.locale = new Locale("de", "DE");
  
          if (log.isDebugEnabled())
          {
              log.debug(" Set Default Locale " + locale.getDisplayLanguage());
          }
      }
  
      /***
       * AbstractDataInterface Konstruktor.
       *
       * @param   locale Die Locale (Sprache)
       */
      public AbstractDataInterface(Locale locale)
      {
          if (locale == null)
              locale = new Locale("de", "DE");
  
          if (log.isDebugEnabled())
          {
              log.debug(" Set Locale " + locale.getDisplayLanguage());
          }
  
          this.locale = locale;
      }
  
      /***
       * Holt die Locale Variable.
       *
       * @return   locale Die Locale (Sprache)
       */
      protected Locale getLocale()
      {
          return this.locale;
      }
  
      /***
       * Setzt die Locale Variable.
       *
      * @param   locale Die Locale (Sprache)
      */
     public void setLocale(Locale locale)
     {
         if (locale == null)
             locale = new Locale("de", "DE");
 
         if (log.isDebugEnabled())
         {
             log.debug(" Set Locale " + locale.getDisplayLanguage());
         }
 
         this.locale = locale;
     }
 
     /***
      * Methode zum setzen des PersistenceBorkers. MUSS vor jeder Aktion ausgeführt werden.
      */
     protected void setUp()
     {
         this.broker = null;
 
         try
         {
             this.broker = PersistenceBrokerFactory.defaultPersistenceBroker();
         }
         catch (Throwable t)
         {
             t.printStackTrace();
         }
     }
 
     /***
      * Methode zum löschen des PersistenceBorkers. MUSS vor nach Aktion ausgeführt werden.
      */
     protected void tearDown()
     {
         try
         {
             broker.close();
         }
         catch (Throwable t)
         {
             t.printStackTrace();
         }
     }
 
     /***
      * Umsetzen der Daten des gelieferten Objekts und Delegation der weiteren
      * Verarbeitung an die OJB Klassen.
      *
      * @param   arg Das Objekt das gespeichert werden soll
      * @return  Gibt true zurueck wenn der Vorgang erfolgreich abgeschlossen wurde, sonst false.
      */
     public abstract boolean erzeugen(Object arg);
 
     /***
      * Umsetzen der Daten des gelieferten Objekts und Delegation der weiteren
      * Verarbeitung an die OJB Klassen.
      * Dass Objekt wird anhand seines Primary Keys indentifiziert.
      *
      * @param   arg Das Objekt das editiert werden soll
      * @return  Gibt true zurueck wenn der Vorgang erfolgreich abgeschlossen wurde, sonst false.
      */
     public abstract boolean editieren(Object arg);
 
     /***
      * Methode zum loeschen eines Objekts.
      * Dass Objekt wird anhand seines Primary Keys indentifiziert.
      *
      * @param   arg Das Objekt das gelöscht werden soll
      * @return  Gibt true zurueck wenn der Vorgang erfolgreich abgeschlossen wurde, sonst false.
      */
     public abstract boolean loeschen(Object arg);
 
     /***
      * Methode zum suchen eines Objekts.
      * Dass Objekt wird anhand seines Primary Keys indentifiziert.
      *
      * @param   arg Das Objekt mit den PrimaryKeys nach denen gesucht werden soll
      * @return  Object mit dem Inhalt des gesuchten Objekts
      */
     protected abstract Object sucheObjekt(Object arg);
 
     /***
      * Methode zum suchen mehrerer Objekte
      *
      * @param   arg Das Objekt mit den Argumenten nach denen gesucht werden soll
      * @return  Collection mit den gefundenen Objekten
      */
     protected abstract Collection sucheObjekte(Object arg);
 
     /***
      * Methode zur Suche aller Objekte
      *
      * @return  Collection mit allen Objekten
      */
     public abstract Collection sucheAlle();
 
     /***
      * Methode zum Aufräumen des Transaktionscaches
      *
      * @return  Wurde der Cache aufgeräumt ??
      */
     public abstract boolean clearCache();
 
     /***
      * Destruktor - wird (vielleicht) vom Garbage Collector aufgerufen
      */
     protected void finalize()
     {
     }
 }