svn commit: r631168 - in /myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata: Extractor.java MetaDataInterface.java package-info.java

[sk...@apache.org]

Author: skitching
Date: Tue Feb 26 02:40:21 2008
New Revision: 631168

URL: http://svn.apache.org/viewvc?rev=631168&view=rev
Log:
Add documentation only.

Added:
    myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/package-info.java   (with props)
Modified:
    myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/Extractor.java
    myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/MetaDataInterface.java

Modified: myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/Extractor.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/Extractor.java?rev=631168&r1=631167&r2=631168&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/Extractor.java (original)
+++ myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/Extractor.java Tue Feb 26 02:40:21 2008
@@ -19,12 +19,18 @@
 package org.apache.myfaces.orchestra.dynaForm.metadata;
 
 /**
- * The metadata extractor interface
+ * An interface to a perstence-library-specific adapter class that knows how
+ * to create a MetaData object from the data held by that specific persistence
+ * library.
+ * <p>
+ * TODO: Why is this class returning instances of concrete class MetaData,
+ * rather than the interface? What is the point of the interface if this
+ * class doesn't use it?
  */
 public interface Extractor
 {
 	/**
-	 * get the metadata for the given entity
+	 * Get the metadata for the given entity.
 	 */
 	public void getMetaData(MetaData metaData, Object entity);
 }

Modified: myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/MetaDataInterface.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/MetaDataInterface.java?rev=631168&r1=631167&r2=631168&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/MetaDataInterface.java (original)
+++ myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/MetaDataInterface.java Tue Feb 26 02:40:21 2008
@@ -20,6 +20,10 @@
 
 import java.util.Iterator;
 
+/**
+ * TODO: Rename this class. Having Interface in the name is ugly.
+ *
+ */
 public interface MetaDataInterface
 {
 	/**

Added: myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/package-info.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/package-info.java?rev=631168&view=auto
==============================================================================
--- myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/package-info.java (added)
+++ myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/package-info.java Tue Feb 26 02:40:21 2008
@@ -0,0 +1,13 @@
+/**
+ * This package exposes sufficient information about the properties of
+ * persistent entities for the DynaForm to create the correct JSF input
+ * components for the entity.
+ * <p>
+ * An interface defines what information DynaForm needs. Concrete
+ * implementations of that interface then map that to the metadata held by
+ * whatever underlying persistence library is being used by the application.
+ * <p>
+ * It is even possible to use DynaForm with non-persistent classes, simply by
+ * mapping the interface to the standard JavaBeans introspector.
+ */
+package org.apache.myfaces.orchestra.dynaForm.metadata;
\ No newline at end of file

Propchange: myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/package-info.java
------------------------------------------------------------------------------
    svn:eol-style = native