/*
- * Copyright (C) 2001, 2002 The Mir-coders group
+ * Copyright (C) 2001, 2002 The Mir-coders group
*
* This file is part of Mir.
*
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* In addition, as a special exception, The Mir-coders gives permission to link
- * the code of this program with the com.oreilly.servlet library, any library
- * licensed under the Apache Software License, The Sun (tm) Java Advanced
- * Imaging library (JAI), The Sun JIMI library (or with modified versions of
- * the above that use the same license as the above), and distribute linked
- * combinations including the two. You must obey the GNU General Public
- * License in all respects for all of the code used other than the above
- * mentioned libraries. If you modify this file, you may extend this exception
- * to your version of the file, but you are not obligated to do so. If you do
- * not wish to do so, delete this exception statement from your version.
+ * the code of this program with any library licensed under the Apache Software License,
+ * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
+ * (or with modified versions of the above that use the same license as the above),
+ * and distribute linked combinations including the two. You must obey the
+ * GNU General Public License in all respects for all of the code used other than
+ * the above mentioned libraries. If you modify this file, you may extend this
+ * exception to your version of the file, but you are not obligated to do so.
+ * If you do not wish to do so, delete this exception statement from your version.
*/
-
-/**
- * Base class the entities are derived from. Provides base functionality of
- * an entity. Entities are used to represent rows of a database table.<p>
- */
-
package mir.entity;
import java.util.HashMap;
+import java.util.Iterator;
import java.util.List;
import java.util.Map;
import mir.config.MirPropertiesConfiguration;
import mir.config.MirPropertiesConfiguration.PropertiesConfigExc;
import mir.log.LoggerWrapper;
-import mir.misc.StringUtil;
import mir.storage.StorageObject;
import mir.storage.StorageObjectExc;
import mir.storage.StorageObjectFailure;
-import freemarker.template.SimpleScalar;
-import freemarker.template.TemplateHashModel;
-import freemarker.template.TemplateModel;
-import freemarker.template.TemplateModelException;
-import freemarker.template.TemplateModelRoot;
/**
- * Base Class of Entities
- * Interfacing TemplateHashModel and TemplateModelRoot to be freemarker compliant
+ * Base class the entities are derived from. Provides base functionality of
+ * an entity. Entities are used to represent rows of a database table.<p>
*
- * @version $Id: Entity.java,v 1.19 2003/04/09 02:06:06 zapata Exp $
+ * @version $Id: Entity.java,v 1.21.2.5 2003/10/23 14:55:28 rk Exp $
* @author rk
*
*/
-public class Entity implements TemplateHashModel, TemplateModelRoot
+public class Entity
{
protected static MirPropertiesConfiguration configuration;
- private boolean changed;
- protected Map theValuesHash; // tablekey / value
+// protected Map theValuesHash; // tablekey / value
+ protected Map values;
protected StorageObject theStorageObject;
protected List streamedInput = null;
protected LoggerWrapper logger;
public Entity() {
logger = new LoggerWrapper("Entity");
- this.changed = false;
+ values = new HashMap();
}
/**
* Constructor
* @param StorageObject The StorageObject of the Entity.
*/
+
public Entity(StorageObject StorageObject) {
this();
+
setStorage(StorageObject);
}
- /*
- * Sets the StorageObject of the Entity.
+ /**
+ *
+ * @param storage
*/
+
public void setStorage(StorageObject storage) {
this.theStorageObject = storage;
}
/**
- * Sets the values of the Entity.
- * @param theStringValues Map containing the new values of the Entity
+ * Sets the values of the Entity. (Only to be called by the Storage Object)
+ *
+ * @param aMap Map containing the new values of the Entity
*/
- public void setValues(Map theStringValues) {
- /** @todo should be synchronized */
- if (theStringValues != null) {
- theValuesHash = new HashMap();
- theValuesHash.putAll(theStringValues);
- }
- else
- logger.warn("Entity.setValues called with null Map");
- }
+ public void setValues(Map aMap) {
+ if (aMap!=null) {
+ Iterator i = aMap.entrySet().iterator();
+ synchronized(this) {
+ while (i.hasNext()) {
+ Map.Entry entry = (Map.Entry) i.next();
- /**
- * Returns whether the content of the Entity has changed.
- * @return true wenn ja, sonst false
- */
- public boolean changed() {
- return changed;
+ setValueForProperty( (String) entry.getKey(), (String) entry.getValue());
+ }
+ }
+ }
}
/**
}
/**
- * Defines the primary key of the Entity
+ * Defines the primary key of the Entity (only to be set by the StorageObject)
* @param id
*/
public void setId(String id) {
- theValuesHash.put(theStorageObject.getIdName(), id);
+ setValueForProperty(theStorageObject.getIdName(), id);
}
/**
*/
public String getValue(String field) {
String returnValue = null;
+
if (field != null) {
- if (field.equals("webdb_create_formatted")) {
- if (hasValueForField("webdb_create"))
- returnValue = StringUtil.dateToReadableDate(getValue("webdb_create"));
- }
- else if (field.equals("webdb_lastchange_formatted")) {
- if (hasValueForField("webdb_lastchange"))
- returnValue = StringUtil.dateToReadableDate(getValue(
- "webdb_lastchange"));
- }
- else
- returnValue = (String) theValuesHash.get(field);
+ returnValue = (String) values.get(field);
}
return returnValue;
}
public boolean hasValueForField(String field) {
- if (theValuesHash != null)
- return theValuesHash.containsKey(field);
- return false;
+ return values.containsKey(field);
}
/**
*/
public String insert() throws StorageObjectExc {
logger.debug("Entity: trying to insert ...");
+
if (theStorageObject != null) {
- return theStorageObject.insert( (Entity)this);
+ return theStorageObject.insert(this);
}
else
throw new StorageObjectExc("theStorageObject == null!");
* @exception StorageObjectException
*/
public void update() throws StorageObjectFailure {
- theStorageObject.update( (Entity)this);
+ theStorageObject.update(this);
}
/**
* @param theValue The new value of the field
* @exception StorageObjectException
*/
- public void setValueForProperty(String theProp, String theValue) throws
- StorageObjectFailure {
- this.changed = true;
- if (isField(theProp))
- theValuesHash.put(theProp, theValue);
- else {
- logger.warn("Entity.setValueForProperty: Property not found: " + theProp + " (" + theValue + ")");
+ public void setValueForProperty(String theProp, String theValue) throws StorageObjectFailure {
+ try {
+ if (isField(theProp))
+ values.put(theProp, theValue);
+ else {
+ logger.warn("Entity.setValueForProperty: Property not found: " + theProp + " (" + theValue + ")");
+ }
}
+ catch (Throwable t) {
+ logger.error("Entity.setValueForProperty: " + t.toString());
+ t.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));
+ throw new StorageObjectFailure(t);
+ }
}
/**
return theStorageObject.getLabels();
}
- /**
- * Returns a Map with all values of the Entity.
- * @return Map with field name as key and the corresponding values
- *
- * @deprecated This method is deprecated and will be deleted in the next release.
- * Entity interfaces freemarker.template.TemplateHashModel now and can
- * be used in the same way as SimpleHash.
- */
- public Map getValues() {
- logger.warn("using deprecated Entity.getValues() - a waste of resources");
- return theValuesHash;
- }
/**
* Returns an ArrayList with all database fields that can
return theStorageObject.getFields().contains(fieldName);
}
- protected void throwStorageObjectFailure(Throwable e, String wo) throws
- StorageObjectFailure {
+ protected void throwStorageObjectFailure(Throwable e, String wo) throws StorageObjectFailure {
logger.error(e.toString() + " function: " + wo);
e.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));
throw new StorageObjectFailure("Storage Object Exception in entity", e);
}
-
- // Now implements freemarkers TemplateHashModel
- // two methods have to be overridden:
- // 1. public boolean isEmpty() throws TemplateModelException
- // 2. public TemplateModel get(java.lang.String key) throws TemplateModelException
-
- public boolean isEmpty() throws TemplateModelException {
- return (theValuesHash == null || theValuesHash.isEmpty()) ? true : false;
- }
-
- public TemplateModel get(java.lang.String key) throws TemplateModelException {
- return new SimpleScalar(getValue(key));
- }
-
- public void put(java.lang.String key, TemplateModel model) {
- // putting should only take place via setValue and is limited to the
- // database fields associated with the entity. no additional freemarker
- // stuff will be available via Entity.
- logger.warn("put is called on entity! - the values will be lost!");
- }
-
- public void remove(java.lang.String key) {
- // do we need this?
- }
-
- //////////////////////////////////////////////////////////////////////////////////
}
projects / mir.git / blobdiff