You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by sk...@apache.org on 2008/02/27 15:16:05 UTC

svn commit: r631597 - in /myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata: Extractor.java impl/jsf/AbstractJsfExtractor.java

Author: skitching
Date: Wed Feb 27 06:16:02 2008
New Revision: 631597

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

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/impl/jsf/AbstractJsfExtractor.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=631597&r1=631596&r2=631597&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 Wed Feb 27 06:16:02 2008
@@ -30,7 +30,13 @@
 public interface Extractor
 {
 	/**
-	 * Get the metadata for the given entity.
+	 * Get metadata information from the given entity and add it to the
+	 * provided MetaData object.
+	 * <p>
+	 * Any information is added to the existing info (if any) in the provided
+	 * MetaData instance. If information conflicts with existing data, then the
+	 * new data overwrites the old data. A chain of Extractors can therefore
+	 * be used (in the correct order) to control exactly what metadata applies.
 	 */
 	public void getMetaData(MetaData metaData, Object entity);
 }

Modified: myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/impl/jsf/AbstractJsfExtractor.java
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/impl/jsf/AbstractJsfExtractor.java?rev=631597&r1=631596&r2=631597&view=diff
==============================================================================
--- myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/impl/jsf/AbstractJsfExtractor.java (original)
+++ myfaces/orchestra/trunk/core15/src/main/java/org/apache/myfaces/orchestra/dynaForm/metadata/impl/jsf/AbstractJsfExtractor.java Wed Feb 27 06:16:02 2008
@@ -27,8 +27,12 @@
 import java.util.Iterator;
 
 /**
- * Extract metadata from jsf form.<br />
- * This will read all facets with "ff_" name prefix
+ * Extract metadata from a DynaForm UIComponent.
+ * <p>
+ * This looks for child DynaConfig components attached to the DynaForm and merges
+ * any overrides they declare with the current values of a MetaData object. This
+ * allows basic information about an entity to be determined by other means, then
+ * for any components attached to the DynaForm component to override those settings.
  */
 public abstract class AbstractJsfExtractor implements Extractor
 {
@@ -36,6 +40,12 @@
 	{
 	}
 
+	/**
+	 * Copy metadata overrides attached to a DynaForm UIComponent into an 
+	 * existing MetaData instance.
+	 * <p>
+	 * The specified entity must be an instance of DynaForm (a JSF UIComponent).
+	 */
 	public void getMetaData(MetaData metaData, Object entity)
 	{
 		if (!(entity instanceof DynaForm))