-/*
- * put your module comment here
+/**
+ * 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;
+package mir.entity;
import java.lang.*;
+import java.io.*;
import java.util.*;
+import java.sql.*;
+
+import freemarker.template.*;
+
import mir.storage.*;
+import mir.misc.*;
/**
- * Interface-Definition für Entities
+ * Base Class of Entities
+ * Interfacing TemplateHashModel and TemplateModelRoot to be freemarker compliant
+ *
+ * @version $Revision: 1.8 $ $Date: 2002/06/28 22:56:37 $
+ * @author $Author: mh $
+ *
+ * $Log: Entity.java,v $
+ * Revision 1.8 2002/06/28 22:56:37 mh
+ * fix so that webdb_lastchange appears in contentlist.template as it should
+ *
+ * Revision 1.7 2002/06/28 20:35:38 mh
+ * use some cvs macros/id's
+ *
+ *
*/
-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;
+public class Entity implements TemplateHashModel, TemplateModelRoot
+{
+ private boolean changed;
+ protected HashMap theValuesHash; // tablekey / value
+ protected StorageObject theStorageObject;
+ protected static Logfile theLog;
+ protected ArrayList streamedInput=null;
+ private static int instances = 0;
+ static {
+ theLog = Logfile.getInstance(MirConfig.getProp("Home") + MirConfig.getProp("Entity.Logfile"));
+ }
+
+ public Entity() {
+
+ this.changed = false;
+ instances++;
+ Integer i = new Integer(instances);
+ //System.err.println("New abstract entity instance: "+i.toString());
+ }
+
+ /**
+ * Constructor
+ * @param StorageObject The StorageObject of the Entity.
+ */
+ public Entity (StorageObject StorageObject) {
+ this();
+ setStorage(StorageObject);
+ }
+
+ /*
+ * Sets the StorageObject of the Entity.
+ */
+ public void setStorage (StorageObject storage) {
+ this.theStorageObject = storage;
+ }
+
+ /**
+ * Sets the values of the Entity.
+ * @param theStringValues HashMap containing the new values of the Entity
+ */
+
+ public void setValues(HashMap theStringValues)
+ {
+ /** @todo should be synchronized */
+ if (theStringValues!=null) {
+ theValuesHash = new HashMap();
+ String aKey;
+ Set set = theStringValues.keySet();
+ Iterator it = set.iterator();
+ int size = set.size();
+ for (int i = 0; i < size; i++) {
+ aKey = (String)it.next();
+ theValuesHash.put(aKey, (String)theStringValues.get(aKey));
+ }
+ }
+ else theLog.printWarning("Entity.setValues called with null HashMap");
+ }
+
+ /**
+ * Returns whether the content of the Entity has changed.
+ * @return true wenn ja, sonst false
+ */
+ public boolean changed () {
+ return changed;
+ }
+
+ /**
+ * Returns the primary key of the Entity.
+ * @return String Id
+ */
+ public String getId () {
+ return (String)getValue(theStorageObject.getIdName());
+ }
+
+ /**
+ * Defines the primary key of the Entity
+ * @param id
+ */
+ public void setId (String id) {
+ theValuesHash.put(theStorageObject.getIdName(), id);
+ }
+
+ /**
+ * Returns the value of a field by field name.
+ * @param field The name of the field
+ * @return value of the field
+ */
+ 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 if (field.equals("webdb_create_dc"))
+ {
+ if (hasValueForField("webdb_create"))
+ returnValue=StringUtil.webdbdateToDCDate(getValue("webdb_create"));
+ }
+ else
+ returnValue = (String)theValuesHash.get(field);
+ }
+ return returnValue;
+ }
+
+ public boolean hasValueForField(String field)
+ {
+ if (theValuesHash!=null)
+ return theValuesHash.containsKey(field);
+ return false;
+ }
+
+ /**
+ * Insers Entity into the database via StorageObject
+ * @return Primary Key of the Entity
+ * @exception StorageObjectException
+ */
+ public String insert () throws StorageObjectException {
+ theLog.printDebugInfo("Entity: trying to insert ...");
+ if (theStorageObject != null) {
+ return theStorageObject.insert((Entity)this);
+ }
+ else
+ throw new StorageObjectException("Kein StorageObject gesetzt!");
+ }
+
+ /**
+ * Saves changes of this Entity to the database
+ * @exception StorageObjectException
+ */
+ public void update () throws StorageObjectException {
+ theStorageObject.update((Entity)this);
+ }
+
+ /**
+ * Sets the value for a field. Issues a log message if the field name
+ * supplied was not found in the Entity.
+ * @param theProp The field name whose value has to be set
+ * @param theValue The new value of the field
+ * @exception StorageObjectException
+ */
+ public void setValueForProperty (String theProp, String theValue)
+ throws StorageObjectException {
+ this.changed = true;
+ if (isField(theProp))
+ theValuesHash.put(theProp, theValue);
+ else {
+ theLog.printWarning("Property not found: " + theProp+theValue);
+ }
+
+ }
+
+ /**
+ * Returns the field names of the Entity as ArrayListe.
+ * @return ArrayList with field names
+ * @exception StorageObjectException is throuwn if database access was impossible
+ */
+ public ArrayList getFields () throws StorageObjectException {
+ return theStorageObject.getFields();
+ }
+
+ /**
+ * Returns an int[] with the types of the fields
+ * @return int[] that contains the types of the fields
+ * @exception StorageObjectException
+ */
+ public int[] getTypes () throws StorageObjectException {
+ return theStorageObject.getTypes();
+ }
+
+ /**
+ * Returns an ArrayList with field names
+ * @return List with field names
+ * @exception StorageObjectException
+ */
+ public ArrayList getLabels () throws StorageObjectException {
+ return theStorageObject.getLabels();
+ }
+
+ /**
+ * Returns a Hashmap with all values of the Entity.
+ * @return HashMap 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 HashMap getValues() {
+ theLog.printWarning("## using deprecated Entity.getValues() - a waste of resources");
+ return theValuesHash;
+ }
+
+ /**
+ * Returns an ArrayList with all database fields that can
+ * be evaluated as streamedInput.
+ * Could be automated by the types (blob, etc.)
+ * Until now to be created manually in the inheriting class
+ *
+ * Liefert einen ArrayList mit allen Datenbankfeldern, die
+ * als streamedInput ausgelesen werden muessen.
+ * Waere automatisierbar ueber die types (blob, etc.)
+ * Bisher manuell anzulegen in der erbenden Klasse
+ */
+
+ public ArrayList streamedInput() {
+ return streamedInput;
+ }
+
+ /** Returns whether fieldName is a valid field name of this Entity.
+ * @param fieldName
+ * @return true in case fieldName is a field name, else false.
+ * @exception StorageObjectException
+ */
+ public boolean isField (String fieldName) throws StorageObjectException {
+ return theStorageObject.getFields().contains(fieldName);
+ }
+
+ /** Returns the number of instances of this Entity
+ * @return int The number of instances
+ */
+ public int getInstances() {
+ return instances;
+ }
+
+ protected void throwStorageObjectException (Exception e, String wo) throws StorageObjectException {
+ theLog.printError( e.toString() + " Funktion: "+ wo);
+ throw new StorageObjectException("Storage Object Exception in entity" +e.toString());
+ }
+
+ /**
+ * Frees an instance
+ */
+ /*public void finalize () {
+ instances--;
+ Integer i = new Integer(instances);
+ System.err.println("Removing abstract entity instance: "+i.toString());
+ try {
+ super.finalize();
+ } catch (Throwable t) {
+ System.err.println(t.toString());
+ }
+ }*/
+
+
+ // 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.
+ theLog.printWarning("### 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