source/mir/module/AbstractModule.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.module;
  31
  32 import java.util.Map;
  33 import java.sql.SQLException;
  34
  35 import mir.entity.Entity;
  36 import mir.entity.EntityList;
  37 import mir.storage.StorageObject;
  38
  39
  40 /**
  41  * This class provides the base functionality for the derived Module-Classes.
  42  * These classes should provide methods to make more or less complex actions
  43  * on Database and Entity classes. The modules are used by ServletModules.
  44  * Future possibility could be access via Applications.
  45  *
  46  * Abstrakte Klasse, von denen die Modules die Basisfunktionalit?t erben.
  47  * Die Moduleschicht dient dazu, Funktionalitaeten zur Verf?gung zu stellen,
  48  * die von mehreren ServletModulen verwendet werden.
  49  *
  50  */
  51
  52 public class AbstractModule {
  53   protected StorageObject storage;
  54
  55   public void setStorage(StorageObject storage) {
  56     this.storage = storage;
  57   }
  58
  59   /**
  60    * Liefert das Standard-StorageObject zur?ck, mit dem das Module assoziiert ist.
  61    * @return Standard-StorageObject
  62    */
  63   public StorageObject getStorageObject () {
  64     return storage;
  65   }
  66
  67   public Entity getById (String id) throws ModuleExc, ModuleFailure {
  68     try {
  69       if (storage == null)
  70         throw  new ModuleExc("AbstractModule.getById: No StorageObject set!");
  71       Entity entity = storage.selectById(id);
  72
  73       if (entity == null)
  74         throw new ModuleExc("AbstractModule.getById: No object for id = " + id);
  75       else
  76         return entity;
  77     }
  78     catch (Throwable e) {
  79       throw new ModuleFailure(e);
  80     }
  81   }
  82
  83   public EntityList getByWhereClause (String whereClause, int offset) throws ModuleExc, ModuleFailure {
  84     try {
  85       if (storage == null)
  86         throw  new ModuleExc("AbstractModule.getByWhereClause: No StorageObject set!");
  87
  88       return storage.selectByWhereClause(whereClause, offset);
  89     }
  90     catch (Throwable e) {
  91       throw new ModuleFailure(e);
  92     }
  93   }
  94
  95   /**
  96    *    * Standardfunktion, um einen Datensatz via StorageObject einzuf?gen
  97    * @param theValues Hash mit Spalte/Wert-Paaren
  98    * @return Id des eingef?gten Objekts
  99    * @exception ModuleExc
 100    * @exception ModuleFailure
 101    */
 102   public String add (Map theValues) throws ModuleExc, ModuleFailure {
 103     try {
 104       Entity theEntity = (Entity)storage.getEntityClass().newInstance();
 105       theEntity.setStorage(storage);
 106       theEntity.setFieldValues(theValues);
 107       return theEntity.insert();
 108     }
 109     catch (Throwable e) {
 110       throw new ModuleFailure(e);
 111     }
 112   }
 113
 114   /**
 115    * This function creates an Entity without yet storing it in the database
 116    */
 117   public Entity createNew() throws ModuleExc, ModuleFailure {
 118     try {
 119       Entity result = (Entity)storage.getEntityClass().newInstance();
 120       result.setStorage(storage);
 121
 122       return result;
 123     }
 124     catch (Throwable e) {
 125       throw new ModuleFailure(e);
 126     }
 127   }
 128
 129   /**
 130    * Standardfunktion, um einen Datensatz via StorageObject zu aktualisieren
 131    * @param theValues Hash mit Spalte/Wert-Paaren
 132    * @return Id des eingef?gten Objekts
 133    * @exception ModuleExc
 134    * @exception ModuleFailure
 135    */
 136   public String set (Map theValues) throws ModuleExc, ModuleFailure {
 137     try {
 138       Entity theEntity = storage.selectById((String)theValues.get("id"));
 139       if (theEntity == null)
 140         throw new ModuleExc("No object found with id " + theValues.get("id"));
 141       theEntity.setFieldValues(theValues);
 142       theEntity.update();
 143       return theEntity.getId();
 144     }
 145     catch (Throwable e) {
 146       throw new ModuleFailure(e);
 147     }
 148   }
 149
 150   /**
 151    * Deletes a record using an id
 152    * @param idParam
 153    * @exception ModuleExc
 154    * @exception ModuleFailure
 155    */
 156   public void deleteById (String idParam) throws ModuleExc, ModuleFailure {
 157     try {
 158       storage.delete(idParam);
 159     }
 160     catch (Throwable e) {
 161       throw new ModuleFailure(e);
 162     }
 163   }
 164
 165   /**
 166    * returns the number of rows
 167    */
 168   public int getSize(String where) throws ModuleExc, ModuleFailure {
 169     try {
 170       return storage.getSize(where);
 171     }
 172     catch (SQLException e) {
 173       throw new ModuleFailure("Can't retrieve number of entities: " + e.toString(), e);
 174     }
 175   }
 176
 177 }