com.raritantechnologies.utils.tree
Class TreeRoot

java.lang.Object
  extended bycom.raritantechnologies.utils.tree.TreeNode
      extended bycom.raritantechnologies.utils.tree.TreeRoot
Direct Known Subclasses:
DieselpointTaxonomyTree, ProfileTree, TaxonomyTree, TaxonomyTree, TaxonomyTreeRefresh

public class TreeRoot
extends TreeNode

Subclass of TreeNode - represents the root node of a tree object.


Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Field Summary
 
Fields inherited from class com.raritantechnologies.utils.tree.TreeNode
activeNode, children, maxCount, name, needsUpdate, nodeCount, nodeID, openState, parent
 
Constructor Summary
TreeRoot()
           
 
Method Summary
 void addNode(TreeNode treeNode)
           
 void addNode(TreeNode treeNode, boolean useNodePathMap)
           
 void addTree(TreeRoot anotherTree, java.lang.String atPath, java.lang.String separator, boolean copyAll)
          Adds a copy of a tree to this tree.
 TreeRoot copyTree()
           
 TreeNode getNode(java.lang.Object node_id)
           
 TreeNode getNode(java.lang.Object node_id, boolean includeRoot)
           
 TreeNode getNodeForPath(java.lang.String treePath, java.lang.String separator, boolean initSeparator)
           
 TreeNode getNodeForPath(java.lang.String treePath, java.lang.String separator, boolean initSeparator, boolean useRootPath)
           
 java.lang.String getNodeID()
          returns nodeIDValue if set, else returns the path
 java.util.Iterator getNodes()
           
 java.util.Iterator getNodes(boolean includeRoot)
           
 java.util.Iterator getNodes(boolean includeRoot, int maxLevel)
           
 java.lang.String getPath(java.lang.String separator, boolean initSeparator)
           
 java.lang.String getPathNoRoot(java.lang.String separator, boolean initSeparator)
           
 java.lang.String getRootID()
           
protected  TreeNode getRootNode()
           
 java.util.List getUpdateNodes()
          returns the list of TreeNodes that need updating.
 boolean hasNode(java.lang.Object node_id)
           
 boolean isOpen()
           
 boolean isVisible()
           
 void mergeTree(TreeRoot anotherTree, java.lang.String atPath, java.lang.String separator)
          Merge a copy of a tree with this tree.
 boolean needsUpdate()
          overrides TreeNode.needsUpdate( ).
 void openTree()
           
 void openTree(int toLevel)
           
 void removeNode(TreeNode treeNode)
           
 void removeNode(TreeNode treeNode, boolean useNodePathMap)
           
 void removePath(java.lang.String treePath, java.lang.String separator)
           
 void removePath(java.lang.String treePath, java.lang.String separator, boolean removeParents)
           
 void removePath(java.lang.String treePath, java.lang.String separator, boolean removeParents, boolean useRootPath)
           
 void setActiveNodeID(java.lang.Object nodeID)
           
protected  void setParent(TreeNode smTreeNode)
           
 TreeRoot subtractTree(TreeRoot another)
          Subtracts nodes from another tree that match the paths in this tree.
 TreeRoot subtractTree(TreeRoot another, boolean includeRootNode)
           
 
Methods inherited from class com.raritantechnologies.utils.tree.TreeNode
addAttribute, addChildNode, addChildNode, addParent, addResult, convertToResult, copyNode, copyNode, copyNodeAttributes, copyNodeCount, copyNodeOnly, createAttributesResult, deleteChildNodes, findNode, getActiveNode, getAllParentAttributes, getAllParentAttributes, getAllParentAttributes, getAllSubAttributes, getAllSubAttributes, getAllSubAttributes, getAncestorPaths, getAncestors, getAncestors, getAttribute, getAttributeNames, getAttributeSet, getAttributeSet, getAttributeSet, getAttributeValues, getAttributeValues, getChildNode, getChildren, getChildrenCount, getDescendents, getDescendents, getDescendents, getLevel, getName, getNameCount, getNestedResultSet, getNestedResultSet, getNodeCount, getNodeIDValue, getParent, getParents, getPaths, getPathsNoRoot, getPatternStringValue, getResultSet, getSiblings, getSiblings, getTreeRoot, hasAttributeValue, hasChildren, hasMultipleParents, hasMultipleValues, haveChildNode, isRoot, removeAttribute, removeChildNode, setActiveNode, setAttribute, setMaxCount, setName, setNeedsUpdate, setNodeCount, setNodeID, setOpenState, setResultSet, sortChildren, toggleState
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TreeRoot

public TreeRoot()
Method Detail

getPathNoRoot

public java.lang.String getPathNoRoot(java.lang.String separator,
                                      boolean initSeparator)
Overrides:
getPathNoRoot in class TreeNode

getPath

public java.lang.String getPath(java.lang.String separator,
                                boolean initSeparator)
Overrides:
getPath in class TreeNode

getNodes

public java.util.Iterator getNodes()

getNodes

public java.util.Iterator getNodes(boolean includeRoot)

getNodes

public java.util.Iterator getNodes(boolean includeRoot,
                                   int maxLevel)

getNode

public TreeNode getNode(java.lang.Object node_id)

getNode

public TreeNode getNode(java.lang.Object node_id,
                        boolean includeRoot)

setActiveNodeID

public void setActiveNodeID(java.lang.Object nodeID)
Overrides:
setActiveNodeID in class TreeNode

getNodeID

public java.lang.String getNodeID()
Description copied from class: TreeNode
returns nodeIDValue if set, else returns the path

Overrides:
getNodeID in class TreeNode

getRootID

public java.lang.String getRootID()

isVisible

public boolean isVisible()
Overrides:
isVisible in class TreeNode

isOpen

public boolean isOpen()
Overrides:
isOpen in class TreeNode

openTree

public void openTree()

openTree

public void openTree(int toLevel)

addNode

public void addNode(TreeNode treeNode)

addNode

public void addNode(TreeNode treeNode,
                    boolean useNodePathMap)

removeNode

public void removeNode(TreeNode treeNode)

removeNode

public void removeNode(TreeNode treeNode,
                       boolean useNodePathMap)

hasNode

public boolean hasNode(java.lang.Object node_id)

getNodeForPath

public TreeNode getNodeForPath(java.lang.String treePath,
                               java.lang.String separator,
                               boolean initSeparator)

getNodeForPath

public TreeNode getNodeForPath(java.lang.String treePath,
                               java.lang.String separator,
                               boolean initSeparator,
                               boolean useRootPath)

removePath

public void removePath(java.lang.String treePath,
                       java.lang.String separator)

removePath

public void removePath(java.lang.String treePath,
                       java.lang.String separator,
                       boolean removeParents)

removePath

public void removePath(java.lang.String treePath,
                       java.lang.String separator,
                       boolean removeParents,
                       boolean useRootPath)

getUpdateNodes

public java.util.List getUpdateNodes()
returns the list of TreeNodes that need updating.


needsUpdate

public boolean needsUpdate()
overrides TreeNode.needsUpdate( ). returns true if this or any descendent node needs to be updated.

Overrides:
needsUpdate in class TreeNode

copyTree

public TreeRoot copyTree()

subtractTree

public TreeRoot subtractTree(TreeRoot another)
Subtracts nodes from another tree that match the paths in this tree.


subtractTree

public TreeRoot subtractTree(TreeRoot another,
                             boolean includeRootNode)

addTree

public void addTree(TreeRoot anotherTree,
                    java.lang.String atPath,
                    java.lang.String separator,
                    boolean copyAll)
Adds a copy of a tree to this tree.


mergeTree

public void mergeTree(TreeRoot anotherTree,
                      java.lang.String atPath,
                      java.lang.String separator)
Merge a copy of a tree with this tree.


getRootNode

protected TreeNode getRootNode()
Overrides:
getRootNode in class TreeNode

setParent

protected void setParent(TreeNode smTreeNode)
Overrides:
setParent in class TreeNode