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