Changeset 865 for vanHelsing/trunk/gui/src/de/dass_it/vanhelsing/gui/TreeNavigation.java

Timestamp:

Apr 20, 2010, 5:21:42 PM (14 years ago)

Author:

tobias

Message:

comments added
all methods of the wsdl file implemented

File:

• vanHelsing/trunk/gui/src/de/dass_it/vanhelsing/gui/TreeNavigation.java (modified) (7 diffs)

vanHelsing/trunk/gui/src/de/dass_it/vanhelsing/gui/TreeNavigation.java

@@ -12 +12 @@
 import de.dass_it.www.vanhelsing.VanHelsingStub.*;
 
-/*
+/**
  * Helper class to encapsulate all procedures 
  * to work with the tree structure.
+ * @author tgoecke
  */
 public class TreeNavigation extends BeanUtil {
         private DefaultTreeModel tree;
         //private Logger logger = Logger.getLogger(this.getClass());
+        /**
+         * @param root  root node of the tree to be created
+         * @param nodes         list of names (resource types) used to create header nodes
+         * @param title         argument currently not used.
+         * @return tree         returns a data tree to be used by a view bean
+         */
         public DefaultTreeModel createTree(DefaultMutableTreeNode root, 
                         String[] nodes, String title){
@@ -43 +50 @@
                 return tree;
         }
-        
+        /**
+         * adds a node to the given parent node, of resource type string and label value title
+         * @param parent        parent node of the created node
+         * @param type          resource type of the created node
+         * @param title         label value of the created type
+         * @return      node    the created node
+         */
         public DefaultMutableTreeNode addNode(DefaultMutableTreeNode parent, String type, String title){
                 DefaultMutableTreeNode node = new DefaultMutableTreeNode();
@@ -84 +97 @@
                 return null;
         }
+        /**
+         * adds a node to the given parent node of resourcetype type which contains the values of the ResourceInfo() object
+         * @param parent        parent node of the created node
+         * @param type  resource type of the created node
+         * @param ri    the data object which is used to update the node UserObject
+         * @return node         the created node
+         */
         public DefaultMutableTreeNode addNode(DefaultMutableTreeNode parent, String type, ResourceInfo ri){
                 DefaultMutableTreeNode node = new DefaultMutableTreeNode();
@@ -142 +162 @@
                 return null;
         }
+        /**
+         * adds a node to the given parent node of resourcetype type which contains the values of the ResourceAttributeType[]
+         * @param parent        parent node of the created node
+         * @param type  resource type of the created node
+         * @param ra    a list of key value pairs returned by the web service access methods
+         * @return node         the updated parent node
+         */
         public DefaultMutableTreeNode addNode(DefaultMutableTreeNode parent, String type, ResourceAttributeType[] ra){
 
@@ -193 +220 @@
                                 }
                         }
-                                
-                        
-                                
-                        
                         //Value-Wert aus Key: Value zusammenbauen 
                         
@@ -217 +240 @@
                 return null;
         }
+        /**
+         * returns the first node whose UserObject attribute resId matches the given id or null if no node is found
+         * @param id    resId value of the node
+         * @param tree  tree object which contains the node
+         * @return      matching node or null if no mathcing node is found
+         */
         public DefaultMutableTreeNode getNode(String id, DefaultTreeModel tree){
                 DefaultMutableTreeNode root;
@@ -234 +263 @@
                 return null;
         }
+        /**
+         * returns the UserObject of a node whose resId attribute matches id
+         */
         public UserObjectItem getNodeObject(String id, DefaultTreeModel tree){
                 DefaultMutableTreeNode node = getNode(id, tree);