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 mir.entity.Entity;
  33 import mir.entity.EntityList;
  34 import mir.storage.Database;
  35
  36 import java.util.Map;
  37
  38 /**
  39  * This class provides the base functionality for the derived Module-Classes.
  40  * These classes should provide methods to make more or less complex actions
  41  * on Database and Entity classes. The modules are used by ServletModules.
  42  * Future possibility could be access via Applications.
  43  *
  44  * Abstrakte Klasse, von denen die Modules die Basisfunktionalit?t erben.
  45  * Die Moduleschicht dient dazu, Funktionalitaeten zur Verf?gung zu stellen,
  46  * die von mehreren ServletModulen verwendet werden.
  47  *
  48  */
  49
  50 public class AbstractModule {
  51   protected Database database;
  52
  53   public AbstractModule(Database aDatabase) {
  54     database = aDatabase;
  55   }
  56
  57   /**
  58    * Returns the database object associated with this module
  59    */
  60   public Database getStorageObject () {
  61     return database;
  62   }
  63
  64   public Entity getById (String id) throws ModuleExc, ModuleFailure {
  65     try {
  66       if (database == null)
  67         throw  new ModuleExc("AbstractModule.getById: No Database set!");
  68       Entity entity = database.selectById(id);
  69
  70       if (entity == null)
  71         throw new ModuleExc("AbstractModule.getById: No object for id = " + id);
  72                         return entity;
  73     }
  74     catch (Throwable e) {
  75       throw new ModuleFailure(e);
  76     }
  77   }
  78
  79   public EntityList getByWhereClause (String whereClause, int offset) throws ModuleExc, ModuleFailure {
  80     try {
  81       if (database == null)
  82         throw  new ModuleExc("AbstractModule.getByWhereClause: No Database set!");
  83
  84       return database.selectByWhereClause(whereClause, offset);
  85     }
  86     catch (Throwable e) {
  87       throw new ModuleFailure(e);
  88     }
  89   }
  90
  91   public String add(Map theValues) throws ModuleExc, ModuleFailure {
  92     try {
  93       Entity entity = database.createNewEntity();
  94       entity.setFieldValues(theValues);
  95
  96       return entity.insert();
  97     }
  98     catch (Throwable e) {
  99       throw new ModuleFailure(e);
 100     }
 101   }
 102
 103   public String set (Map theValues) throws ModuleExc, ModuleFailure {
 104     try {
 105       Entity theEntity = database.selectById((String) theValues.get("id"));
 106       if (theEntity == null)
 107         throw new ModuleExc("No object found with id " + theValues.get("id"));
 108       theEntity.setFieldValues(theValues);
 109       theEntity.update();
 110       return theEntity.getId();
 111     }
 112     catch (Throwable e) {
 113       throw new ModuleFailure(e);
 114     }
 115   }
 116
 117   /**
 118    * Deletes a record using an id
 119    * @param idParam
 120    * @exception ModuleExc
 121    * @exception ModuleFailure
 122    */
 123   public void deleteById (String idParam) throws ModuleExc, ModuleFailure {
 124     try {
 125       database.delete(idParam);
 126     }
 127     catch (Throwable e) {
 128       throw new ModuleFailure(e);
 129     }
 130   }
 131 }