source/mir/module/AbstractModule.java

   1 /*
   2  * Copyright (C) 2001-2006 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  * and distribute linked combinations including the two.  You must obey the
  23  * GNU General Public License in all respects for all of the code used other than
  24  * the above mentioned libraries.  If you modify this file, you may extend this
  25  * exception to your version of the file, but you are not obligated to do so.
  26  * If you do not wish to do so, delete this exception statement from your version.
  27  */
  28
  29 package  mir.module;
  30
  31 import mir.entity.Entity;
  32 import mir.entity.EntityList;
  33 import mir.storage.Database;
  34 import mir.storage.DatabaseExc;
  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 anId) throws ModuleFailure, EntityNotFoundExc {
  65       if (database == null) {
  66         throw  new ModuleFailure("AbstractModule.getById: No Database set!");
  67       }
  68
  69       try {
  70         Entity result = database.selectById(anId);
  71
  72         if (result == null) {
  73           throw new EntityNotFoundExc("AbstractModule.getById: No object for id = " + anId);
  74         }
  75
  76         return result;
  77       }
  78       catch (DatabaseExc e) {
  79         throw new ModuleFailure("Database exception while retrieving entity with id " + anId);
  80       }
  81   }
  82
  83   public EntityList getByWhereClause (String whereClause, int offset) throws ModuleExc, ModuleFailure {
  84     try {
  85       if (database == null)
  86         throw  new ModuleExc("AbstractModule.getByWhereClause: No Database set!");
  87
  88       return database.selectByWhereClause(whereClause, offset);
  89     }
  90     catch (Throwable e) {
  91       throw new ModuleFailure(e);
  92     }
  93   }
  94
  95   public String add(Map theValues) throws ModuleExc, ModuleFailure {
  96     try {
  97       Entity entity = database.createNewEntity();
  98       entity.setFieldValues(theValues);
  99
 100       return entity.insert();
 101     }
 102     catch (Throwable e) {
 103       throw new ModuleFailure(e);
 104     }
 105   }
 106
 107   public String set (Map theValues) throws ModuleExc, ModuleFailure {
 108     try {
 109       Entity theEntity = database.selectById((String) theValues.get("id"));
 110       if (theEntity == null)
 111         throw new ModuleExc("No object found with id " + theValues.get("id"));
 112       theEntity.setFieldValues(theValues);
 113       theEntity.update();
 114       return theEntity.getId();
 115     }
 116     catch (Throwable e) {
 117       throw new ModuleFailure(e);
 118     }
 119   }
 120
 121   /**
 122    * Deletes a record using an id
 123    * @param idParam
 124    * @exception ModuleExc
 125    * @exception ModuleFailure
 126    */
 127   public void deleteById (String idParam) throws ModuleExc, ModuleFailure {
 128     try {
 129       database.delete(idParam);
 130     }
 131     catch (Throwable e) {
 132       throw new ModuleFailure(e);
 133     }
 134   }
 135 }