org.sbml.jsbml.util

Class TreeNodeAdapter

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.util.TreeNodeAdapter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, TreeNodeWithChangeSupport

public class TreeNodeAdapter
extends AbstractTreeNode

This class is a wrapper element for any Object that should be linked into a tree data structure as represented by AbstractTreeNode, but that might by itself not be an instance of TreeNode, i.e., not compatible with the remaining tree data structure. In analogy to MutableTreeNode we call this Object userObject (see getUserObject() and setUserObject(Object)).

This wrapper distinguishes the following special cases depending on the type of userObject when accessing the i^th child of this TreeNode. The userObject is an instance of

• TreeNode: recursive operations are continued at this element
• Collection: recursion leads to the i^th element in the Iterator
• Map: the key set is sorted (only possible if the keys implement the Comparable interface) and recursion continues at the i^th key.

Since:

0.8

Version:

$Rev$

Author:

Andreas Dräger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID Generated serial version identifier.
private java.lang.Object	userObject The object to be wrapped.

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

Constructor Summary

Constructors

Constructor and Description
TreeNodeAdapter(java.lang.Object userObject, javax.swing.tree.TreeNode parent) Creates a new TreeNode wrapper for the given userObject that will be linked to the given AbstractTreeNode.parent within an exisiting tree.
TreeNodeAdapter(TreeNodeAdapter node) Copy constructor for the given node.

Method Summary

Modifier and Type	Method and Description
javax.swing.tree.TreeNode	clone()
boolean	equals(java.lang.Object object)
boolean	getAllowsChildren()
javax.swing.tree.TreeNode	getChildAt(int childIndex)
int	getChildCount()
java.lang.Object	getUserObject()
int	hashCode()
boolean	isSetUserObject()
boolean	isUserObjectRecursiveDataType() Checks whether or not the user's object has been set (see isSetUserObject()) and if so if it belongs to those elements returned by the method getChildAt(int).
void	setUserObject(java.lang.Object object)
java.lang.String	toString()

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getParent, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, notifyChildChange, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

userObject

private java.lang.Object userObject

The object to be wrapped.

Constructor Detail

TreeNodeAdapter

public TreeNodeAdapter(java.lang.Object userObject,
                       javax.swing.tree.TreeNode parent)

Creates a new TreeNode wrapper for the given userObject that will be linked to the given AbstractTreeNode.parent within an exisiting tree.

Parameters:

userObject - the element to be wrapped in a TreeNode; may be null.

parent - the parent TreeNode of this new node, i.e., the position within an existing tree where to link this new node. May be null.

TreeNodeAdapter

public TreeNodeAdapter(TreeNodeAdapter node)

Copy constructor for the given node. Note that the pointer to the parent will not be cloned.

Parameters:

node -

Method Detail

clone

public javax.swing.tree.TreeNode clone()

Specified by:

clone in class AbstractTreeNode

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class AbstractTreeNode

getAllowsChildren

public boolean getAllowsChildren()

getChildAt

public javax.swing.tree.TreeNode getChildAt(int childIndex)

getChildCount

public int getChildCount()

getUserObject

public java.lang.Object getUserObject()

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractTreeNode

isSetUserObject

public boolean isSetUserObject()

Returns:

isUserObjectRecursiveDataType

public boolean isUserObjectRecursiveDataType()

Checks whether or not the user's object has been set (see isSetUserObject()) and if so if it belongs to those elements returned by the method getChildAt(int).

Returns:

true if the user's object has been defined and belongs to those classes that are returned by the method getChildAt(int).

See Also:

getChildAt(int), isSetUserObject()

setUserObject

public void setUserObject(java.lang.Object object)

Parameters:

object -

toString

public java.lang.String toString()

Overrides:

toString in class AbstractTreeNode