-/*
- * put your module comment here
- */
-
-
-package mir.entity;
-
-import java.lang.*;
-import java.util.*;
-import mir.storage.*;
-
-/**
- * Interface-Definition für Entities
- */
-
-public interface Entity {
-
- /**
- * Eine Entity muss setStorage implementieren, mit der eine Entity mit einem
- * StorageObject assoziiert wird.
- *
- * @param st
- */
- public abstract void setStorage (StorageObject st);
-
-
-
- /**
- * Eine Entity muss setValues implementieren, mit der die Werte der Entity gesetzt werden
- * können.
- *
- * @param ht
- */
- public abstract void setValues(HashMap ht);
-
-
-
- /**
- * Eine Entity muss getValues implementieren, mit der die Werte der Entity
- * als HashMap zurueckgeliefert werden
- * @return Werte der Entity
- */
- public abstract HashMap getValues();
-
-
-
- /**
- * Eine Entity muss getFields implementieren, mit der die Feldnamen der
- * Entity zurueckgegeben werden.
- * @return ArrayList der Feldnamen
- * @exception StorageObjectException
- */
- public abstract ArrayList getFields () throws StorageObjectException;
-
-
-
- /**
- * Eine Entity muss getTypes implementieren, mit der die Feldtype der
- * Entity zurueckgegeben werden.
- * @return int[] der Feldtypen
- * @exception StorageObjectException
- */
- public abstract int[] getTypes () throws StorageObjectException;
-
-
-
- /**
- * Eine Entity muss getLabels implementieren, mit der die Feldnamen der
- * Entity zurueckgegeben werden.
- * @return ArrayList der Feldnamen
- * @exception StorageObjectException
- */
- public abstract ArrayList getLabels () throws StorageObjectException;
-
-
-
- /**
- * Eine Entity muss getId implementieren, um den Primaerschuessel der
- * Entity zurueckgeliefert zu bekommen.
- *
- * @return Primary-Key der Entity
- */
- public abstract String getId();
-
-
-
- /**
- * Eine Entity muss setId implementieren, um den Primaerschuessel der
- * Entity zu setzen
- *
- * @param str
- */
- public abstract void setId(String str);
-
-
- /**
- * Eine Entity muss getValue implementieren, um den Wert eines
- * Feldes zurueckzugeben
- *
- * @param field
- * @return Wert von Feld field
- */
- public abstract String getValue (String field);
-
-
-
- /**
- * Einfügen der Entity in StorageObject
- *
- * @return Primary-Key der eingefügten Entity
- * @exception StorageObjectException
- */
- public abstract String insert () throws StorageObjectException;
-
-
-
- /**
- * Aktualisieren der Entity via StorageObject
- * @exception StorageObjectException
- */
- public abstract void update () throws StorageObjectException;
-
-
-
- /**
- * ArrayListe mit Feldern, die einer Sonderbehandlung bedürfen (blobs)
- * @return Liste der Feldnamen
- */
- public abstract ArrayList streamedInput ();
-
-
- public abstract void setValueForProperty (String theProp, String theValue) throws StorageObjectException;
-
-
-}
-
-
-
-
+/*\r
+ * Copyright (C) 2001, 2002 The Mir-coders group\r
+ *\r
+ * This file is part of Mir.\r
+ *\r
+ * Mir is free software; you can redistribute it and/or modify\r
+ * it under the terms of the GNU General Public License as published by\r
+ * the Free Software Foundation; either version 2 of the License, or\r
+ * (at your option) any later version.\r
+ *\r
+ * Mir is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License\r
+ * along with Mir; if not, write to the Free Software\r
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA\r
+ *\r
+ * In addition, as a special exception, The Mir-coders gives permission to link\r
+ * the code of this program with the com.oreilly.servlet library, any library\r
+ * licensed under the Apache Software License, The Sun (tm) Java Advanced\r
+ * Imaging library (JAI), The Sun JIMI library (or with modified versions of\r
+ * the above that use the same license as the above), and distribute linked\r
+ * combinations including the two. You must obey the GNU General Public\r
+ * License in all respects for all of the code used other than the above\r
+ * mentioned libraries. If you modify this file, you may extend this exception\r
+ * to your version of the file, but you are not obligated to do so. If you do\r
+ * not wish to do so, delete this exception statement from your version.\r
+ */\r
+\r
+/**\r
+ * Base class the entities are derived from. Provides base functionality of\r
+ * an entity. Entities are used to represent rows of a database table.<p>\r
+ */\r
+\r
+package mir.entity;\r
+\r
+import java.util.HashMap;\r
+import java.util.List;\r
+import java.util.Map;\r
+\r
+import mir.config.MirPropertiesConfiguration;\r
+import mir.config.MirPropertiesConfiguration.PropertiesConfigExc;\r
+import mir.log.LoggerWrapper;\r
+import mir.misc.StringUtil;\r
+import mir.storage.StorageObject;\r
+import mir.storage.StorageObjectExc;\r
+import mir.storage.StorageObjectFailure;\r
+import freemarker.template.SimpleScalar;\r
+import freemarker.template.TemplateHashModel;\r
+import freemarker.template.TemplateModel;\r
+import freemarker.template.TemplateModelException;\r
+import freemarker.template.TemplateModelRoot;\r
+\r
+/**\r
+ * Base Class of Entities\r
+ * Interfacing TemplateHashModel and TemplateModelRoot to be freemarker compliant\r
+ *\r
+ * @version $Id: Entity.java,v 1.18 2003/03/05 19:23:14 idfx Exp $\r
+ * @author rk\r
+ *\r
+ */\r
+\r
+public class Entity implements TemplateHashModel, TemplateModelRoot\r
+{\r
+ protected static MirPropertiesConfiguration configuration;\r
+\r
+ private boolean changed;\r
+ protected Map theValuesHash; // tablekey / value\r
+ protected StorageObject theStorageObject;\r
+ protected List streamedInput = null;\r
+ protected LoggerWrapper logger;\r
+\r
+ static {\r
+ try {\r
+ configuration = MirPropertiesConfiguration.instance();\r
+ }\r
+ catch (PropertiesConfigExc e) {\r
+ throw new RuntimeException(e.getMessage());\r
+ }\r
+ }\r
+\r
+ public Entity() {\r
+ logger = new LoggerWrapper("Entity");\r
+\r
+ this.changed = false;\r
+ }\r
+\r
+ /**\r
+ * Constructor\r
+ * @param StorageObject The StorageObject of the Entity.\r
+ */\r
+ public Entity(StorageObject StorageObject) {\r
+ this();\r
+ setStorage(StorageObject);\r
+ }\r
+\r
+ /*\r
+ * Sets the StorageObject of the Entity.\r
+ */\r
+ public void setStorage(StorageObject storage) {\r
+ this.theStorageObject = storage;\r
+ }\r
+\r
+ /**\r
+ * Sets the values of the Entity.\r
+ * @param theStringValues Map containing the new values of the Entity\r
+ */\r
+\r
+ public void setValues(Map theStringValues) {\r
+ /** @todo should be synchronized */\r
+ if (theStringValues != null) {\r
+ theValuesHash = new HashMap();\r
+ theValuesHash.putAll(theStringValues);\r
+ }\r
+ else\r
+ logger.warn("Entity.setValues called with null Map");\r
+ }\r
+\r
+ /**\r
+ * Returns whether the content of the Entity has changed.\r
+ * @return true wenn ja, sonst false\r
+ */\r
+ public boolean changed() {\r
+ return changed;\r
+ }\r
+\r
+ /**\r
+ * Returns the primary key of the Entity.\r
+ * @return String Id\r
+ */\r
+ public String getId() {\r
+ return (String) getValue(theStorageObject.getIdName());\r
+ }\r
+\r
+ /**\r
+ * Defines the primary key of the Entity\r
+ * @param id\r
+ */\r
+ public void setId(String id) {\r
+ theValuesHash.put(theStorageObject.getIdName(), id);\r
+ }\r
+\r
+ /**\r
+ * Returns the value of a field by field name.\r
+ * @param field The name of the field\r
+ * @return value of the field\r
+ */\r
+ public String getValue(String field) {\r
+ String returnValue = null;\r
+ if (field != null) {\r
+ if (field.equals("webdb_create_formatted")) {\r
+ if (hasValueForField("webdb_create"))\r
+ returnValue = StringUtil.dateToReadableDate(getValue("webdb_create"));\r
+ }\r
+ else if (field.equals("webdb_lastchange_formatted")) {\r
+ if (hasValueForField("webdb_lastchange"))\r
+ returnValue = StringUtil.dateToReadableDate(getValue(\r
+ "webdb_lastchange"));\r
+ }\r
+ else\r
+ returnValue = (String) theValuesHash.get(field);\r
+ }\r
+ return returnValue;\r
+ }\r
+\r
+ public boolean hasValueForField(String field) {\r
+ if (theValuesHash != null)\r
+ return theValuesHash.containsKey(field);\r
+ return false;\r
+ }\r
+\r
+ /**\r
+ * Insers Entity into the database via StorageObject\r
+ * @return Primary Key of the Entity\r
+ * @exception StorageObjectException\r
+ */\r
+ public String insert() throws StorageObjectExc {\r
+ logger.debug("Entity: trying to insert ...");\r
+ if (theStorageObject != null) {\r
+ return theStorageObject.insert( (Entity)this);\r
+ }\r
+ else\r
+ throw new StorageObjectExc("theStorageObject == null!");\r
+ }\r
+\r
+ /**\r
+ * Saves changes of this Entity to the database\r
+ * @exception StorageObjectException\r
+ */\r
+ public void update() throws StorageObjectFailure {\r
+ theStorageObject.update( (Entity)this);\r
+ }\r
+\r
+ /**\r
+ * Sets the value for a field. Issues a log message if the field name\r
+ * supplied was not found in the Entity.\r
+ * @param theProp The field name whose value has to be set\r
+ * @param theValue The new value of the field\r
+ * @exception StorageObjectException\r
+ */\r
+ public void setValueForProperty(String theProp, String theValue) throws\r
+ StorageObjectFailure {\r
+ this.changed = true;\r
+ if (isField(theProp))\r
+ theValuesHash.put(theProp, theValue);\r
+ else {\r
+ logger.warn("Entity.setValueForProperty: Property not found: " + theProp + " (" + theValue + ")");\r
+ }\r
+\r
+ }\r
+\r
+ /**\r
+ * Returns the field names of the Entity as ArrayListe.\r
+ * @return ArrayList with field names\r
+ * @exception StorageObjectException is throuwn if database access was impossible\r
+ */\r
+ public List getFields() throws StorageObjectFailure {\r
+ return theStorageObject.getFields();\r
+ }\r
+\r
+ /**\r
+ * Returns an int[] with the types of the fields\r
+ * @return int[] that contains the types of the fields\r
+ * @exception StorageObjectException\r
+ */\r
+ public int[] getTypes() throws StorageObjectFailure {\r
+ return theStorageObject.getTypes();\r
+ }\r
+\r
+ /**\r
+ * Returns an ArrayList with field names\r
+ * @return List with field names\r
+ * @exception StorageObjectException\r
+ */\r
+ public List getLabels() throws StorageObjectFailure {\r
+ return theStorageObject.getLabels();\r
+ }\r
+\r
+ /**\r
+ * Returns a Map with all values of the Entity.\r
+ * @return Map with field name as key and the corresponding values\r
+ *\r
+ * @deprecated This method is deprecated and will be deleted in the next release.\r
+ * Entity interfaces freemarker.template.TemplateHashModel now and can\r
+ * be used in the same way as SimpleHash.\r
+ */\r
+ public Map getValues() {\r
+ logger.warn("using deprecated Entity.getValues() - a waste of resources");\r
+ return theValuesHash;\r
+ }\r
+\r
+ /**\r
+ * Returns an ArrayList with all database fields that can\r
+ * be evaluated as streamedInput.\r
+ * Could be automated by the types (blob, etc.)\r
+ * Until now to be created manually in the inheriting class\r
+ *\r
+ * Liefert einen ArrayList mit allen Datenbankfeldern, die\r
+ * als streamedInput ausgelesen werden muessen.\r
+ * Waere automatisierbar ueber die types (blob, etc.)\r
+ * Bisher manuell anzulegen in der erbenden Klasse\r
+ */\r
+\r
+ public List streamedInput() {\r
+ return streamedInput;\r
+ }\r
+\r
+ /** Returns whether fieldName is a valid field name of this Entity.\r
+ * @param fieldName\r
+ * @return true in case fieldName is a field name, else false.\r
+ * @exception StorageObjectException\r
+ */\r
+ public boolean isField(String fieldName) throws StorageObjectFailure {\r
+ return theStorageObject.getFields().contains(fieldName);\r
+ }\r
+\r
+ protected void throwStorageObjectFailure(Throwable e, String wo) throws\r
+ StorageObjectFailure {\r
+ logger.error(e.toString() + " function: " + wo);\r
+ e.printStackTrace(logger.asPrintWriter(LoggerWrapper.DEBUG_MESSAGE));\r
+\r
+ throw new StorageObjectFailure("Storage Object Exception in entity", e);\r
+ }\r
+\r
+ // Now implements freemarkers TemplateHashModel\r
+ // two methods have to be overridden:\r
+ // 1. public boolean isEmpty() throws TemplateModelException\r
+ // 2. public TemplateModel get(java.lang.String key) throws TemplateModelException\r
+\r
+ public boolean isEmpty() throws TemplateModelException {\r
+ return (theValuesHash == null || theValuesHash.isEmpty()) ? true : false;\r
+ }\r
+\r
+ public TemplateModel get(java.lang.String key) throws TemplateModelException {\r
+ return new SimpleScalar(getValue(key));\r
+ }\r
+\r
+ public void put(java.lang.String key, TemplateModel model) {\r
+ // putting should only take place via setValue and is limited to the\r
+ // database fields associated with the entity. no additional freemarker\r
+ // stuff will be available via Entity.\r
+ logger.warn("put is called on entity! - the values will be lost!");\r
+ }\r
+\r
+ public void remove(java.lang.String key) {\r
+ // do we need this?\r
+ }\r
+\r
+ //////////////////////////////////////////////////////////////////////////////////\r
+}\r
+\r
projects / mir.git / blobdiff