[jboss-cvs] jboss-seam/src/main/org/jboss/seam/faces ...

[Peter Muir]

  User: pmuir   
  Date: 07/09/28 09:54:37

  Modified:    src/main/org/jboss/seam/faces  DataModels.java
  Log:
  Some Javadoc for framework queries
  
  Revision  Changes    Path
  1.4       +11 -1     jboss-seam/src/main/org/jboss/seam/faces/DataModels.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: DataModels.java
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-seam/src/main/org/jboss/seam/faces/DataModels.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -b -r1.3 -r1.4
  --- DataModels.java	21 Jun 2007 05:27:28 -0000	1.3
  +++ DataModels.java	28 Sep 2007 13:54:37 -0000	1.4
  @@ -22,10 +22,11 @@
   import org.jboss.seam.jsf.SetDataModel;
   
   /**
  - * Wraps collections as DataModels. May be overridden
  + * Wraps a collection as a JSF {@link DataModel}. May be overridden
    * and extended if you don't like the built in collections
    * which are supported: list, map, set, array.
    *
  + * @author pmuir
    */
   @Name("org.jboss.seam.faces.dataModels")
   @Install(precedence=BUILT_IN, classDependencies="javax.faces.context.FacesContext")
  @@ -34,6 +35,12 @@
   public class DataModels
   {
      
  +   /**
  +    * Wrap the value in a DataModel
  +    * 
  +    * This implementation supports {@link List}, {@link Map}, {@link Set} and
  +    * arrays
  +    */
      public DataModel getDataModel(Object value)
      {
         if (value instanceof List)
  @@ -58,6 +65,9 @@
         }
      }
      
  +   /**
  +    * Wrap the the Seam Framework {@link Query} in a JSF DataModel
  +    */
      public DataModel getDataModel(Query query)
      {
         return getDataModel( query.getResultList() );