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