[richfaces-svn-commits] JBoss Rich Faces SVN: r2822 - trunk/framework/api/src/main/java/org/richfaces/model.

[richfaces-svn-commits at lists.jboss.org]

Author: nbelaevski
Date: 2007-09-08 09:24:14 -0400 (Sat, 08 Sep 2007)
New Revision: 2822

Modified:
   trunk/framework/api/src/main/java/org/richfaces/model/AbstractTreeDataModel.java
   trunk/framework/api/src/main/java/org/richfaces/model/LastElementAware.java
   trunk/framework/api/src/main/java/org/richfaces/model/ListRowKey.java
   trunk/framework/api/src/main/java/org/richfaces/model/MapDataModel.java
   trunk/framework/api/src/main/java/org/richfaces/model/SequenceDataModel.java
   trunk/framework/api/src/main/java/org/richfaces/model/StackingTreeModel.java
   trunk/framework/api/src/main/java/org/richfaces/model/StackingTreeModelDataProvider.java
   trunk/framework/api/src/main/java/org/richfaces/model/StackingTreeModelProvider.java
   trunk/framework/api/src/main/java/org/richfaces/model/TreeDataModel.java
   trunk/framework/api/src/main/java/org/richfaces/model/TreeModelVisualComponentProvider.java
   trunk/framework/api/src/main/java/org/richfaces/model/TreeNode.java
   trunk/framework/api/src/main/java/org/richfaces/model/TreeNodeImpl.java
   trunk/framework/api/src/main/java/org/richfaces/model/TreeRange.java
   trunk/framework/api/src/main/java/org/richfaces/model/VisualStackingTreeModel.java
Log:
http://jira.jboss.com/jira/browse/RF-856

Modified: trunk/framework/api/src/main/java/org/richfaces/model/AbstractTreeDataModel.java
===================================================================
--- trunk/framework/api/src/main/java/org/richfaces/model/AbstractTreeDataModel.java	2007-09-08 00:40:01 UTC (rev 2821)
+++ trunk/framework/api/src/main/java/org/richfaces/model/AbstractTreeDataModel.java	2007-09-08 13:24:14 UTC (rev 2822)
@@ -31,8 +31,8 @@
 import org.ajax4jsf.model.Range;
 
 /**
+ * Base class for all tree data models
  * @author Nick Belaevski - nbelaevski at exadel.com created 07.12.2006
- * Base class for all tree data models
  */
 public abstract class AbstractTreeDataModel extends ExtendedDataModel {
 	public final static char SEPARATOR = NamingContainer.SEPARATOR_CHAR;

Modified: trunk/framework/api/src/main/java/org/richfaces/model/LastElementAware.java
===================================================================
--- trunk/framework/api/src/main/java/org/richfaces/model/LastElementAware.java	2007-09-08 00:40:01 UTC (rev 2821)
+++ trunk/framework/api/src/main/java/org/richfaces/model/LastElementAware.java	2007-09-08 13:24:14 UTC (rev 2822)
@@ -22,12 +22,12 @@
 package org.richfaces.model;
 
 /**
- * @author Konstantin Mishin
- *
  * {@link org.ajax4jsf.ajax.repeat.UIDataAdaptor.ComponentVisitor} instances can implement this interface in order to
  * be notified of last element occurence at the current tree level. {@link #setLastElement()}
  * method is invoked before visiting last element and {@link #resetLastElement()} is called after
  * visiting last element. 
+ * 
+ * @author Konstantin Mishin
  */
 public interface LastElementAware {
 	

Modified: trunk/framework/api/src/main/java/org/richfaces/model/ListRowKey.java
===================================================================
--- trunk/framework/api/src/main/java/org/richfaces/model/ListRowKey.java	2007-09-08 00:40:01 UTC (rev 2821)
+++ trunk/framework/api/src/main/java/org/richfaces/model/ListRowKey.java	2007-09-08 13:24:14 UTC (rev 2822)
@@ -26,9 +26,10 @@
 import java.util.List;
 
 /**
+ * Default {@link TreeRowKey} implementation based on {@link ArrayList}
+ * created 17.11.2006
+ * 
  * @author Nick Belaevski - nbelaevski at exadel.com
- * created 17.11.2006
- * Default {@link TreeRowKey} implementation based on {@link ArrayList}
  */
 public class ListRowKey extends TreeRowKey {
 

Modified: trunk/framework/api/src/main/java/org/richfaces/model/MapDataModel.java
===================================================================
--- trunk/framework/api/src/main/java/org/richfaces/model/MapDataModel.java	2007-09-08 00:40:01 UTC (rev 2821)
+++ trunk/framework/api/src/main/java/org/richfaces/model/MapDataModel.java	2007-09-08 13:24:14 UTC (rev 2822)
@@ -20,8 +20,9 @@
 import org.w3c.dom.Node;
 
 /**
+ * That is intended for internal use
+ * 
  * @author Nick Belaevski mailto:nbelaevski at exadel.com created 30.07.2007
- * 
  */
 public class MapDataModel extends ExtendedDataModel {
 

Modified: trunk/framework/api/src/main/java/org/richfaces/model/SequenceDataModel.java
===================================================================
--- trunk/framework/api/src/main/java/org/richfaces/model/SequenceDataModel.java	2007-09-08 00:40:01 UTC (rev 2821)
+++ trunk/framework/api/src/main/java/org/richfaces/model/SequenceDataModel.java	2007-09-08 13:24:14 UTC (rev 2822)
@@ -18,6 +18,8 @@
 import org.w3c.dom.NodeList;
 
 /**
+ * That is intended for internal use
+ * 
  * @author Nick Belaevski
  *         mailto:nbelaevski at exadel.com
  *         created 30.07.2007

Modified: trunk/framework/api/src/main/java/org/richfaces/model/StackingTreeModel.java
===================================================================
--- trunk/framework/api/src/main/java/org/richfaces/model/StackingTreeModel.java	2007-09-08 00:40:01 UTC (rev 2821)
+++ trunk/framework/api/src/main/java/org/richfaces/model/StackingTreeModel.java	2007-09-08 13:24:14 UTC (rev 2822)
@@ -20,6 +20,8 @@
 import org.w3c.dom.NamedNodeMap;
 
 /**
+ * That is intended for internal use
+ * 
  * @author Nick Belaevski mailto:nbelaevski at exadel.com created 25.07.2007
  * 
  */

Modified: trunk/framework/api/src/main/java/org/richfaces/model/StackingTreeModelDataProvider.java
===================================================================
--- trunk/framework/api/src/main/java/org/richfaces/model/StackingTreeModelDataProvider.java	2007-09-08 00:40:01 UTC (rev 2821)
+++ trunk/framework/api/src/main/java/org/richfaces/model/StackingTreeModelDataProvider.java	2007-09-08 13:24:14 UTC (rev 2822)
@@ -4,6 +4,8 @@
 package org.richfaces.model;
 
 /**
+ * That is intended for internal use
+ * 
  * @author Nick Belaevski
  *         mailto:nbelaevski at exadel.com
  *         created 30.07.2007

Modified: trunk/framework/api/src/main/java/org/richfaces/model/StackingTreeModelProvider.java
===================================================================
--- trunk/framework/api/src/main/java/org/richfaces/model/StackingTreeModelProvider.java	2007-09-08 00:40:01 UTC (rev 2821)
+++ trunk/framework/api/src/main/java/org/richfaces/model/StackingTreeModelProvider.java	2007-09-08 13:24:14 UTC (rev 2822)
@@ -10,6 +10,8 @@
 
 
 /**
+ * That is intended for internal use
+ * 
  * @author Nick Belaevski mailto:nbelaevski at exadel.com created 25.07.2007
  * 
  */

Modified: trunk/framework/api/src/main/java/org/richfaces/model/TreeDataModel.java
===================================================================
--- trunk/framework/api/src/main/java/org/richfaces/model/TreeDataModel.java	2007-09-08 00:40:01 UTC (rev 2821)
+++ trunk/framework/api/src/main/java/org/richfaces/model/TreeDataModel.java	2007-09-08 13:24:14 UTC (rev 2822)
@@ -31,6 +31,8 @@
 import org.ajax4jsf.model.Range;
 
 /**
+ * That is intended for internal use
+ * 
  * @author Nick Belaevski - nbelaevski at exadel.com created 16.11.2006
  * 
  */

Modified: trunk/framework/api/src/main/java/org/richfaces/model/TreeModelVisualComponentProvider.java
===================================================================
--- trunk/framework/api/src/main/java/org/richfaces/model/TreeModelVisualComponentProvider.java	2007-09-08 00:40:01 UTC (rev 2821)
+++ trunk/framework/api/src/main/java/org/richfaces/model/TreeModelVisualComponentProvider.java	2007-09-08 13:24:14 UTC (rev 2822)
@@ -6,6 +6,8 @@
 import javax.faces.component.UIComponent;
 
 /**
+ * That is intended for internal use
+ * 
  * @author Nick Belaevski
  *         mailto:nbelaevski at exadel.com
  *         created 29.07.2007

Modified: trunk/framework/api/src/main/java/org/richfaces/model/TreeNode.java
===================================================================
--- trunk/framework/api/src/main/java/org/richfaces/model/TreeNode.java	2007-09-08 00:40:01 UTC (rev 2821)
+++ trunk/framework/api/src/main/java/org/richfaces/model/TreeNode.java	2007-09-08 13:24:14 UTC (rev 2822)
@@ -27,9 +27,10 @@
 
 
 /**
+ * Interface representing tree ADT nodes
+ * created 16.11.2006
+ * 
  * @author Nick Belaevski - nbelaevski at exadel.com
- * created 16.11.2006
- * Interface representing tree ADT nodes
  */
 public interface TreeNode extends Serializable{
 	

Modified: trunk/framework/api/src/main/java/org/richfaces/model/TreeNodeImpl.java
===================================================================
--- trunk/framework/api/src/main/java/org/richfaces/model/TreeNodeImpl.java	2007-09-08 00:40:01 UTC (rev 2821)
+++ trunk/framework/api/src/main/java/org/richfaces/model/TreeNodeImpl.java	2007-09-08 13:24:14 UTC (rev 2822)
@@ -26,10 +26,11 @@
 import java.util.Map;
 
 /**
- * @author Nick Belaevski - nbelaevski at exadel.com
- * created 16.11.2006
  * Default {@link TreeNode} implementation based on {@link LinkedHashMap} to preserve 
  * elements ordering
+ * created 16.11.2006
+ * 
+ * @author Nick Belaevski - nbelaevski at exadel.com
  */
 public class TreeNodeImpl implements TreeNode {
 	

Modified: trunk/framework/api/src/main/java/org/richfaces/model/TreeRange.java
===================================================================
--- trunk/framework/api/src/main/java/org/richfaces/model/TreeRange.java	2007-09-08 00:40:01 UTC (rev 2821)
+++ trunk/framework/api/src/main/java/org/richfaces/model/TreeRange.java	2007-09-08 13:24:14 UTC (rev 2822)
@@ -24,11 +24,27 @@
 import org.ajax4jsf.model.Range;
 
 /**
- * @author Nick Belaevski - nbelaevski at exadel.com
+ * {@link Range} implmentation variant for {@link AbstractTreeDataModel}
+ * 
  * created 23.11.2006
  * 
+ * @author Nick Belaevski - nbelaevski at exadel.com
+ * 
  */
 public interface TreeRange extends Range {
+
+	/**
+	 * Returns <code>true</code> if node with that rowKey should be processed.
+	 * If <code>false</code> is returned, then skips processing child nodes also.
+	 * @param rowKey {@link TreeRowKey} key instance
+	 * @return <code>true</code> or <code>false</code>
+	 */
 	public boolean processNode(TreeRowKey rowKey);
+
+	/**
+	 * Returns <code>true</code> if children of the node with that rowKey should be processed
+	 * @param rowKey {@link TreeRowKey} key instance
+	 * @return <code>true</code> or <code>false</code>
+	 */
 	public boolean processChildren(TreeRowKey rowKey);
 }

Modified: trunk/framework/api/src/main/java/org/richfaces/model/VisualStackingTreeModel.java
===================================================================
--- trunk/framework/api/src/main/java/org/richfaces/model/VisualStackingTreeModel.java	2007-09-08 00:40:01 UTC (rev 2821)
+++ trunk/framework/api/src/main/java/org/richfaces/model/VisualStackingTreeModel.java	2007-09-08 13:24:14 UTC (rev 2822)
@@ -6,6 +6,8 @@
 import javax.faces.component.UIComponent;
 
 /**
+ * That is intended for internal use
+ * 
  * @author Nick Belaevski
  *         mailto:nbelaevski at exadel.com
  *         created 15.08.2007