From: grok <grok>
Date: Thu, 28 Jul 2005 21:44:01 +0000 (+0000)
Subject: adding doc
X-Git-Tag: LATEST_MERGED_1_1~128
X-Git-Url: http://erislabs.net/gitweb/?p=mir.git;a=commitdiff_plain;h=97488204d3bc9d251b525a70b2cf0c70956a3484

adding doc
---

diff --git a/source/mir/bundle/Bundle.java b/source/mir/bundle/Bundle.java
index cec44e49..3e46b85b 100755
--- a/source/mir/bundle/Bundle.java
+++ b/source/mir/bundle/Bundle.java
@@ -31,6 +31,10 @@ package mir.bundle;
 
 import java.util.List;
 
+/**
+ * bundles are key/value pairs in a text file, used for config 
+ * and internationalization
+ */
 public interface Bundle {
   public String getValue(String aKey, List anArguments);
 }
diff --git a/source/mir/entity/Entity.java b/source/mir/entity/Entity.java
index eb4b8b1b..498d9722 100755
--- a/source/mir/entity/Entity.java
+++ b/source/mir/entity/Entity.java
@@ -39,7 +39,7 @@ import mir.storage.DatabaseFailure;
  * An <code>Entity</code> represents a persistent data object, typically
  *   stored in a database.<p>
  *
- * @version $Id: Entity.java,v 1.21.2.12 2005/03/26 11:26:23 zapata Exp $
+ * @version $Id: Entity.java,v 1.21.2.13 2005/07/28 21:44:01 grok Exp $
  */
 
 public interface Entity {
@@ -64,7 +64,7 @@ public interface Entity {
   public void setId(String id);
 
   /**
-   * Insers Entity into the database via Database
+   * Inserts Entity into the database via Database
    * @return Primary Key of the Entity
    * @exception DatabaseExc
    */
diff --git a/source/mir/entity/adapter/EntityAdapter.java b/source/mir/entity/adapter/EntityAdapter.java
index 4314dc8d..2fff4d20 100755
--- a/source/mir/entity/adapter/EntityAdapter.java
+++ b/source/mir/entity/adapter/EntityAdapter.java
@@ -39,6 +39,16 @@ import java.util.Set;
 import mir.entity.Entity;
 import mir.util.CachingRewindableIterator;
 
+/** An EntityAdapter is a wrapper around an Entity meant to add
+ * missing functionality. It provides "calculated fields" 
+ * which mir installations can extend reasonably easilly.
+ * "calculated fields" compute values that are not directly present
+ * in the db table. For example:  
+ * a field to have the number of comments associated with an article;
+ * a field to get the list of hidden comments associated with an article;
+ * etc.
+ * <p>This whole framework is meant to be replaced by hibernate</p>
+ */
 public class EntityAdapter implements Map {
   private Entity entity;
   private EntityAdapterDefinition definition;