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.sql.SQLException;
  33 import java.util.Map;
  34
  35 import mir.entity.Entity;
  36 import mir.entity.EntityList;
  37 import mir.storage.Database;
  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 Database database;
  54
  55   public AbstractModule(Database aDatabase) {
  56     database = aDatabase;
  57   }
  58
  59   /**
  60    * Returns the database object associated with this module
  61    */
  62   public Database getStorageObject () {
  63     return database;
  64   }
  65
  66   public Entity getById (String id) throws ModuleExc, ModuleFailure {
  67     try {
  68       if (database == null)
  69         throw  new ModuleExc("AbstractModule.getById: No Database set!");
  70       Entity entity = database.selectById(id);
  71
  72       if (entity == null)
  73         throw new ModuleExc("AbstractModule.getById: No object for id = " + id);
  74                         return entity;
  75     }
  76     catch (Throwable e) {
  77       throw new ModuleFailure(e);
  78     }
  79   }
  80
  81   public EntityList getByWhereClause (String whereClause, int offset) throws ModuleExc, ModuleFailure {
  82     try {
  83       if (database == null)
  84         throw  new ModuleExc("AbstractModule.getByWhereClause: No Database set!");
  85
  86       return database.selectByWhereClause(whereClause, offset);
  87     }
  88     catch (Throwable e) {
  89       throw new ModuleFailure(e);
  90     }
  91   }
  92
  93   /**
  94    *    * Standardfunktion, um einen Datensatz via Database einzuf?gen
  95    * @param theValues Hash mit Spalte/Wert-Paaren
  96    * @return Id des eingef?gten Objekts
  97    * @exception ModuleExc
  98    * @exception ModuleFailure
  99    */
 100   public String add(Map theValues) throws ModuleExc, ModuleFailure {
 101     try {
 102       Entity entity = database.createNewEntity();
 103       entity.setFieldValues(theValues);
 104
 105       return entity.insert();
 106     }
 107     catch (Throwable e) {
 108       throw new ModuleFailure(e);
 109     }
 110   }
 111
 112   /**
 113    * Standardfunktion, um einen Datensatz via Database zu aktualisieren
 114    * @param theValues Hash mit Spalte/Wert-Paaren
 115    * @return Id des eingef?gten Objekts
 116    * @exception ModuleExc
 117    * @exception ModuleFailure
 118    */
 119   public String set (Map theValues) throws ModuleExc, ModuleFailure {
 120     try {
 121       Entity theEntity = database.selectById((String) theValues.get("id"));
 122       if (theEntity == null)
 123         throw new ModuleExc("No object found with id " + theValues.get("id"));
 124       theEntity.setFieldValues(theValues);
 125       theEntity.update();
 126       return theEntity.getId();
 127     }
 128     catch (Throwable e) {
 129       throw new ModuleFailure(e);
 130     }
 131   }
 132
 133   /**
 134    * Deletes a record using an id
 135    * @param idParam
 136    * @exception ModuleExc
 137    * @exception ModuleFailure
 138    */
 139   public void deleteById (String idParam) throws ModuleExc, ModuleFailure {
 140     try {
 141       database.delete(idParam);
 142     }
 143     catch (Throwable e) {
 144       throw new ModuleFailure(e);
 145     }
 146   }
 147
 148   /**
 149    * returns the number of rows
 150    */
 151   public int getSize(String where) throws ModuleExc, ModuleFailure {
 152     try {
 153       return database.getSize(where);
 154     }
 155     catch (SQLException e) {
 156       throw new ModuleFailure("Can't retrieve number of entities: " + e.toString(), e);
 157     }
 158   }
 159
 160 }