source/mir/entity/AbstractEntity.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.entity;
  31
  32 import java.util.HashMap;
  33 import java.util.Iterator;
  34 import java.util.List;
  35 import java.util.Map;
  36
  37 import mir.config.MirPropertiesConfiguration;
  38 import mir.config.MirPropertiesConfiguration.PropertiesConfigExc;
  39 import mir.log.LoggerWrapper;
  40 import mir.storage.StorageObject;
  41 import mir.storage.StorageObjectExc;
  42 import mir.storage.StorageObjectFailure;
  43
  44 /**
  45  * Base class the entities are derived from. Provides base functionality of
  46  * an entity.
  47  *
  48  * @version $Id: AbstractEntity.java,v 1.8.2.3 2004/11/21 22:07:13 zapata Exp $
  49  */
  50
  51 public class AbstractEntity implements Entity {
  52   protected static MirPropertiesConfiguration configuration = MirPropertiesConfiguration.instance();
  53
  54   protected Map values;
  55   protected StorageObject storageObject;
  56   protected LoggerWrapper logger;
  57
  58   public AbstractEntity() {
  59     logger = new LoggerWrapper("Entity");
  60
  61     values = new HashMap();
  62   }
  63
  64   /**
  65    * Constructor
  66    * @param StorageObject The StorageObject of the Entity.
  67    */
  68   public AbstractEntity(StorageObject StorageObject) {
  69     this();
  70
  71     setStorage(StorageObject);
  72   }
  73
  74   public void setStorage(StorageObject storage) {
  75     this.storageObject = storage;
  76   }
  77
  78   /** {@inheritDoc} */
  79   public void setFieldValues(Map aMap) {
  80     if (aMap!=null) {
  81       Iterator i = aMap.entrySet().iterator();
  82       synchronized(this) {
  83         while (i.hasNext()) {
  84           Map.Entry entry = (Map.Entry) i.next();
  85
  86           setFieldValue( (String) entry.getKey(), (String) entry.getValue());
  87         }
  88       }
  89     }
  90   }
  91
  92   /** {@inheritDoc} */
  93   public String getId() {
  94     return getFieldValue(storageObject.getIdName());
  95   }
  96
  97   /** {@inheritDoc} */
  98   public void setId(String id) {
  99     setFieldValue(storageObject.getIdName(), id);
 100   }
 101
 102   /** {@inheritDoc} */
 103   public String insert() throws StorageObjectExc {
 104     logger.debug("Entity: trying to insert ...");
 105
 106     if (storageObject != null) {
 107       return storageObject.insert(this);
 108     }
 109     else
 110       throw new StorageObjectExc("storageObject == null!");
 111   }
 112
 113   /** {@inheritDoc} */
 114   public void update() throws StorageObjectFailure {
 115     storageObject.update(this);
 116   }
 117
 118   /** {@inheritDoc} */
 119   public String getFieldValue(String aFieldName) {
 120     String returnValue = null;
 121
 122     if (aFieldName != null) {
 123       returnValue = (String) values.get(aFieldName);
 124     }
 125     return returnValue;
 126   }
 127
 128   /** {@inheritDoc} */
 129   public boolean hasFieldValue(String aFieldName) {
 130     return values.containsKey(aFieldName);
 131   }
 132
 133   /**
 134    * Sets the value for a field. Issues a log message if the field name
 135    * supplied was not found in the Entity.
 136    * @param theProp The field name whose value has to be set
 137    * @param theValue The new value of the field
 138    * @exception StorageObjectFailure
 139    */
 140   public void setFieldValue(String theProp, String theValue) throws StorageObjectFailure {
 141     if (hasField(theProp))
 142       values.put(theProp, theValue);
 143     else {
 144       logger.warn("Entity.setFieldValue: Property not found: " + theProp + " (" + theValue + ")");
 145     }
 146   }
 147
 148   /**
 149    * Returns the field names of the Entity
 150    */
 151   public List getFieldNames() throws StorageObjectFailure {
 152     return storageObject.getFieldNames();
 153   }
 154
 155   /** Returns whether fieldName is a valid field name of this Entity.
 156    * @param fieldName
 157    * @return true in case fieldName is a field name, else false.
 158    * @exception StorageObjectFailure
 159    */
 160   public boolean hasField(String fieldName) throws StorageObjectFailure {
 161     return getFieldNames().contains(fieldName);
 162   }
 163 }
 164