gov.usda.gdpc.gui.dbetree
Class DBElementTreeModel

java.lang.Object
  extended bygov.usda.gdpc.gui.dbetree.DBElementTreeModel
All Implemented Interfaces:
javax.swing.tree.TreeModel

public class DBElementTreeModel
extends java.lang.Object
implements javax.swing.tree.TreeModel

Author:
terryc

Constructor Summary
DBElementTreeModel()
          DBElementTreeModel Constructor.
DBElementTreeModel(HeadNode headNode)
          DBElementTreeModel Constructor.
 
Method Summary
 void add(DBElement element)
          Adds a DBElement to this property node tree.
 void add(java.util.List list)
          Adds a list of DBElements to this property node tree.
 void addNotify(javax.swing.event.TreeModelEvent event)
          This notifies this model that nodes have been added.
 void addTreeModelListener(javax.swing.event.TreeModelListener l)
          Adds given listener to this model.
 java.lang.Object getChild(java.lang.Object parent, int index)
          Gets the child of the given parent at the given index.
 int getChildCount(java.lang.Object parent)
          Gets the number of children for given parent.
 int getIndexOfChild(java.lang.Object parent, java.lang.Object child)
          Gets index of given child for given parent.
 java.util.List getLeafNodes()
          Returns a list leaf nodes for this model.
 java.lang.Object getRoot()
          Gets root node of this model.
 boolean isLeaf(java.lang.Object node)
          Returns whether given node is a leaf node.
 boolean remove(DBElement element)
          Removes all occurances of the given element from this tree.
 void removeAll()
          Removes all branches of this tree leaving only the root node.
 void removeAllNotify()
          This notifies this model that all nodes have been removed.
 void removeNotify(javax.swing.event.TreeModelEvent event)
          This notifies this model that nodes have been removed.
 void removeTreeModelListener(javax.swing.event.TreeModelListener l)
          Removes give listener from this model.
 void valueForPathChanged(javax.swing.tree.TreePath path, java.lang.Object newValue)
          Not used for this model.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DBElementTreeModel

public DBElementTreeModel(HeadNode headNode)
DBElementTreeModel Constructor.


DBElementTreeModel

public DBElementTreeModel()
DBElementTreeModel Constructor.

Method Detail

addTreeModelListener

public void addTreeModelListener(javax.swing.event.TreeModelListener l)
Adds given listener to this model.

Specified by:
addTreeModelListener in interface javax.swing.tree.TreeModel
Parameters:
l - listener

getChild

public java.lang.Object getChild(java.lang.Object parent,
                                 int index)
                          throws java.lang.IndexOutOfBoundsException
Gets the child of the given parent at the given index.

Specified by:
getChild in interface javax.swing.tree.TreeModel
Parameters:
parent - parent
index - index
Returns:
child
Throws:
java.lang.IndexOutOfBoundsException

getChildCount

public int getChildCount(java.lang.Object parent)
Gets the number of children for given parent.

Specified by:
getChildCount in interface javax.swing.tree.TreeModel
Parameters:
parent - parent
Returns:
child count

getIndexOfChild

public int getIndexOfChild(java.lang.Object parent,
                           java.lang.Object child)
Gets index of given child for given parent.

Specified by:
getIndexOfChild in interface javax.swing.tree.TreeModel
Parameters:
parent - parent
child - child
Returns:
index

getRoot

public java.lang.Object getRoot()
Gets root node of this model.

Specified by:
getRoot in interface javax.swing.tree.TreeModel
Returns:
root node

isLeaf

public boolean isLeaf(java.lang.Object node)
Returns whether given node is a leaf node.

Specified by:
isLeaf in interface javax.swing.tree.TreeModel
Parameters:
node - node to check
Returns:
true if node is leaf

getLeafNodes

public java.util.List getLeafNodes()
Returns a list leaf nodes for this model.

Returns:
list of leaf nodes

removeTreeModelListener

public void removeTreeModelListener(javax.swing.event.TreeModelListener l)
Removes give listener from this model.

Specified by:
removeTreeModelListener in interface javax.swing.tree.TreeModel
Parameters:
l - listener

valueForPathChanged

public void valueForPathChanged(javax.swing.tree.TreePath path,
                                java.lang.Object newValue)
Not used for this model.

Specified by:
valueForPathChanged in interface javax.swing.tree.TreeModel

add

public void add(DBElement element)
Adds a DBElement to this property node tree.

Parameters:
element - the element to add.

add

public void add(java.util.List list)
Adds a list of DBElements to this property node tree.

Parameters:
list - the list to add.

remove

public boolean remove(DBElement element)
Removes all occurances of the given element from this tree.

Parameters:
element - element to remove.
Returns:
true if tree changed because of remove.

removeAll

public void removeAll()
Removes all branches of this tree leaving only the root node.


addNotify

public void addNotify(javax.swing.event.TreeModelEvent event)
This notifies this model that nodes have been added. The given event describes which nodes were added.

Parameters:
event - event

removeNotify

public void removeNotify(javax.swing.event.TreeModelEvent event)
This notifies this model that nodes have been removed. The given event describes which nodes were removed.

Parameters:
event - event

removeAllNotify

public void removeAllNotify()
This notifies this model that all nodes have been removed.