AbstractTreeNode (JSBML 1.1 API Specification)

java.lang.Object
- org.sbml.jsbml.AbstractTreeNode

All Implemented Interfaces:

Serializable, Cloneable, TreeNode, TreeNodeWithChangeSupport

Direct Known Subclasses:

AbstractASTNode, AbstractSBase, AbstractSBasePlugin, AnnotationElement, ASTNode, TreeNodeAdapter, XMLToken
```
public abstract class AbstractTreeNode
extends Object
implements TreeNodeWithChangeSupport
```
A basic implementation of the TreeNode interface.

Since:

0.8

Version:

$Rev: 2377 $

Author:

Andreas Dräger

See Also:
Serialized Form
Last modified:

11.07.2011

Field Summary

Fields
Modifier and Type Field and Description

static String UNKNOWN_ATTRIBUTES

static String UNKNOWN_ELEMENTS

Fields
Modifier and Type	Field and Description
`static String`	`UNKNOWN_ATTRIBUTES`
`static String`	`UNKNOWN_ELEMENTS`

Constructor Summary

Constructors
Constructor and Description
`AbstractTreeNode()` Creates an empty `AbstractTreeNode` without child nodes and an empty list of `TreeNodeChangeListener`s.
`AbstractTreeNode(TreeNode node)` Constructor for cloning.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`addAllChangeListeners(Collection<TreeNodeChangeListener> listeners)` Adds recursively all given `TreeNodeChangeListener` instances to this element.
`boolean`	`addAllChangeListeners(Collection<TreeNodeChangeListener> listeners, boolean recursive)`
`void`	`addTreeNodeChangeListener(TreeNodeChangeListener listener)` Adds recursively a listener to the `TreeNodeWithChangeSupport` object and all of its sub-elements.
`void`	`addTreeNodeChangeListener(TreeNodeChangeListener listener, boolean recursive)` Adds a listener to this `TreeNodeWithChangeSupport` object and optionally also to all of its child nodes.
`Enumeration<TreeNode>`	`children()`
`void`	`clearUserObjects()` Removes all of the mappings from the map of user objects (optional operation).
`abstract TreeNode`	`clone()`
`boolean`	`containsUserObjectKey(Object key)`
`boolean`	`equals(Object object)`
`List<? extends TreeNode>`	`filter(Filter filter)` Filters this tree data structure recursively and returns a list of all `TreeNode`s that are accepted by the `Filter`.
`List<? extends TreeNode>`	`filter(Filter filter, boolean retainInternalNodes)` Filters this tree data structure recursively and returns a list of all `TreeNode`s that are accepted by the `Filter`.
`List<? extends TreeNode>`	`filter(Filter filter, boolean retainInternalNodes, boolean prune)` Filters this tree data structure recursively and returns a list of all `TreeNode`s that are accepted by the `Filter`.
`void`	`fireNodeAddedEvent()` All `TreeNodeChangeListener` instances linked to this `TreeNode` are informed about the adding of this `Object` to an owning parent `Object`.
`void`	`fireNodeRemovedEvent()` All `TreeNodeChangeListener` instances linked to this `TreeNode` are informed about the deletion of this `TreeNode` from a parent `Object`.
`void`	`firePropertyChange(String propertyName, Object oldValue, Object newValue)` All `TreeNodeChangeListener`s are informed about the change in this `TreeNodeWithChangeSupport`.
`int`	`getIndex(TreeNode node)`
`List<TreeNodeChangeListener>`	`getListOfTreeNodeChangeListeners()` Returns all `TreeNodeChangeListener`s that are assigned to this element.
`int`	`getNumChildren()` Returns the number of child elements of this `TreeNode`.
`TreeNode`	`getParent()`
`TreeNode`	`getRoot()`
`int`	`getTreeNodeChangeListenerCount()`
`Object`	`getUserObject(Object key)`
`int`	`hashCode()`
`static int`	`indexOf(TreeNode parent, TreeNode child)` Searches the given child in the list of sub-nodes of the parent element.
`boolean`	`isLeaf()`
`boolean`	`isRoot()` Opposite of `TreeNodeWithChangeSupport.isSetParent()`.
`boolean`	`isSetParent()`
`boolean`	`isSetUserObjects()` Checks whether any user-defined key-value pairs have been attached to this object.
`void`	`putUserObject(Object key, Object userObject)`
`void`	`removeAllTreeNodeChangeListeners()` Removes all tree node change listeners from this element.
`void`	`removeAllTreeNodeChangeListeners(boolean recursive)` Removes all tree node change listeners recursively from this element.
`boolean`	`removeFromParent()` This method is designed to be overridden for non-independent child nodes
`void`	`removeTreeNodeChangeListener(TreeNodeChangeListener listener)` Removes recursively the given change listener from this element.
`void`	`removeTreeNodeChangeListener(TreeNodeChangeListener listener, boolean recursive)` Removes the given change listener from this element.
`Object`	`removeUserObject(Object key)`
`void`	`setParent(TreeNode parent)`
`String`	`toString()`
`Set<Object>`	`userObjectKeySet()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.swing.tree.TreeNode
getAllowsChildren, getChildAt, getChildCount

- Field Detail
  - UNKNOWN_ATTRIBUTES
```
public static final String UNKNOWN_ATTRIBUTES
```
    See Also:
    Constant Field Values
  - UNKNOWN_ELEMENTS
```
public static final String UNKNOWN_ELEMENTS
```
    See Also:
    Constant Field Values
- Constructor Detail
  - AbstractTreeNode
```
public AbstractTreeNode()
```
    Creates an empty AbstractTreeNode without child nodes and an empty list of TreeNodeChangeListeners. The pointer to the parent of this node is set to null.
  - AbstractTreeNode
```
public AbstractTreeNode(TreeNode node)
```
    Constructor for cloning. AbstractTreeNode has two properties: parent and listOfListeners. Both of them are not cloned by this method, for two reasons:
    - The parent is not cloned and is left as null because the new AbstractTreeNode will get a parent set as soon as it is added/linked again to a Model. Note that only the top-level element of the cloned sub-tree will have a null value as its parent. All sub-element will point to their correct parent element.
    - listOfListeners is needed in all other setXX() methods. Cloning these might lead to strange and unexpected behavior, because when doing a deep cloning, the listeners of the old object would suddenly be informed about all value changes within this new object. Since we do cloning, all values of all child elements have to be touched, i.e., all listeners would be informed many times, but each time receive the identical value as it was before. Since it is totally unclear of which type listeners are, a deep cloning of these is not possible.
    Therefore, it is necessary to keep in mind that the parent of the clone will be null and that you have to care by yourself if you are using TreeNodeChangeListeners.
    Parameters:
    node - The original TreeNode to be cloned.
- Method Detail
  - indexOf
```
public static int indexOf(TreeNode parent,
          TreeNode child)
```
    Searches the given child in the list of sub-nodes of the parent element.
    
    Parameters:
    parent -
    child -
    
    Returns:
    the index of the child in the parent's list of children or -1 if no such child can be found.
  - addAllChangeListeners
```
public boolean addAllChangeListeners(Collection<TreeNodeChangeListener> listeners)
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    Adds recursively all given TreeNodeChangeListener instances to this element.
    
    Specified by:
    
    addAllChangeListeners in interface TreeNodeWithChangeSupport
    
    Parameters:
    listeners - the set of listeners to add
    
    Returns:
    true if the set of listeners is added with success.
  - addAllChangeListeners
```
public boolean addAllChangeListeners(Collection<TreeNodeChangeListener> listeners,
                            boolean recursive)
```
    Specified by:
    
    addAllChangeListeners in interface TreeNodeWithChangeSupport
    
    Returns:
  - addTreeNodeChangeListener
```
public void addTreeNodeChangeListener(TreeNodeChangeListener listener)
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    Adds recursively a listener to the TreeNodeWithChangeSupport object and all of its sub-elements. Calling this method is effectively identical to the call TreeNodeWithChangeSupport.addTreeNodeChangeListener(TreeNodeChangeListener, boolean) where recursively = true.
    
    Specified by:
    
    addTreeNodeChangeListener in interface TreeNodeWithChangeSupport
    
    Parameters:
    listener - the listener to add
    See Also:
    TreeNodeWithChangeSupport.addTreeNodeChangeListener(TreeNodeChangeListener, boolean)
  - addTreeNodeChangeListener
```
public void addTreeNodeChangeListener(TreeNodeChangeListener listener,
                             boolean recursive)
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    Adds a listener to this TreeNodeWithChangeSupport object and optionally also to all of its child nodes.
    
    Specified by:
    
    addTreeNodeChangeListener in interface TreeNodeWithChangeSupport
    
    Parameters:
    listener - the listener to add
    recursive - if true the given listener will be added to this node and also recursively to all of its child nodes. If false, the listener will only be added to the current node.
    See Also:
    TreeNodeWithChangeSupport.addTreeNodeChangeListener(TreeNodeChangeListener)
  - children
```
public Enumeration<TreeNode> children()
```
    Specified by:
    
    children in interface TreeNode
  - clearUserObjects
```
public void clearUserObjects()
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    Removes all of the mappings from the map of user objects (optional operation). The map will be empty after this call returns.
    
    Specified by:
    
    clearUserObjects in interface TreeNodeWithChangeSupport
    
    See Also:
    Map.clear()
  - clone
```
public abstract TreeNode clone()
```
    Overrides:
    
    clone in class Object
  - containsUserObjectKey
```
public boolean containsUserObjectKey(Object key)
```
    Specified by:
    
    containsUserObjectKey in interface TreeNodeWithChangeSupport
    
    Returns:
    See Also:
    Map.containsKey(java.lang.Object)
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - filter
```
public List<? extends TreeNode> filter(Filter filter)
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    Filters this tree data structure recursively and returns a list of all TreeNodes that are accepted by the Filter. Although internal nodes that do not satisfy the filter criterion by themselves are not contained in the resulting list, the recursion continues at their children.
    
    Specified by:
    
    filter in interface TreeNodeWithChangeSupport
    
    Parameters:
    filter - A criterion to select a sub-set of nodes of this tree.
    
    Returns:
    A List of TreeNodes that do all satisfy the criterion of the given Filter.
    See Also:
    TreeNodeWithChangeSupport.filter(Filter, boolean)
  - filter
```
public List<? extends TreeNode> filter(Filter filter,
                              boolean retainInternalNodes)
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    Filters this tree data structure recursively and returns a list of all TreeNodes that are accepted by the Filter. The second argument decides whether or not internal nodes that do not by themselves satisfy the filter criterion should still be retained in the result list.
    
    Specified by:
    
    filter in interface TreeNodeWithChangeSupport
    
    Parameters:
    filter - A criterion to select a sub-set of nodes of this tree.
    retainInternalNodes - Decides if internal nodes should also be included in the resulting List if they do not by themselves satisfy the Filter but if these do have child elements that do so. This might be useful in order to obtain a complete tree path to interesting sub-elements.
    
    Returns:
    A List representing a subset of TreeNodes that satisfy the Filter's criterion, or whose child nodes do so.
    See Also:
    TreeNodeWithChangeSupport.filter(Filter)
  - filter
```
public List<? extends TreeNode> filter(Filter filter,
                              boolean retainInternalNodes,
                              boolean prune)
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    Filters this tree data structure recursively and returns a list of all TreeNodes that are accepted by the Filter. The two boolean switches let you decide if internal nodes that do not by themselves satisfy the filter criterion should be retained in the list, and if the recursion should be aborted as soon as the first hit is discovered.
    
    Specified by:
    
    filter in interface TreeNodeWithChangeSupport
    
    retainInternalNodes - decides whether or not internal nodes should be added to the list of results even though these might not by themselves satisfy the filter's criterion, but whose children do. This feature can be useful, e.g., in order to keep the full tree path to nodes of interest
    prune - if this argument is true, the recursive search is aborted upon the discovery of the first hit.
    
    Returns:
    A List representing a subset of TreeNodes that satisfy the Filter's criterion, or whose child nodes do so.
    See Also:
    TreeNodeWithChangeSupport.filter(Filter, boolean)
  - fireNodeAddedEvent
```
public void fireNodeAddedEvent()
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    All TreeNodeChangeListener instances linked to this TreeNode are informed about the adding of this Object to an owning parent Object.
    
    Specified by:
    
    fireNodeAddedEvent in interface TreeNodeWithChangeSupport
  - fireNodeRemovedEvent
```
public void fireNodeRemovedEvent()
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    All TreeNodeChangeListener instances linked to this TreeNode are informed about the deletion of this TreeNode from a parent Object.
    
    Specified by:
    
    fireNodeRemovedEvent in interface TreeNodeWithChangeSupport
  - firePropertyChange
```
public void firePropertyChange(String propertyName,
                      Object oldValue,
                      Object newValue)
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    All TreeNodeChangeListeners are informed about the change in this TreeNodeWithChangeSupport.
    
    Specified by:
    
    firePropertyChange in interface TreeNodeWithChangeSupport
    
    Parameters:
    propertyName - Tells the TreeNodeChangeListener the name of the property whose value has been changed.
    oldValue - This is the value before the change.
    newValue - This gives the new value that is now the new value for the given property..
  - getIndex
```
public int getIndex(TreeNode node)
```
    Specified by:
    
    getIndex in interface TreeNode
  - getListOfTreeNodeChangeListeners
```
public List<TreeNodeChangeListener> getListOfTreeNodeChangeListeners()
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    Returns all TreeNodeChangeListeners that are assigned to this element.
    
    Specified by:
    
    getListOfTreeNodeChangeListeners in interface TreeNodeWithChangeSupport
    
    Returns:
    all TreeNodeChangeListeners that are assigned to this element.
  - getNumChildren
```
public int getNumChildren()
```
    Returns the number of child elements of this TreeNode.
    
    Returns:
    the number of children TreeNodes the receiver contains.
    Note: this method is kept here as it exist in libSBML.
    
    you could use TreeNode.getChildCount()
  - getParent
```
public TreeNode getParent()
```
    Specified by:
    
    getParent in interface TreeNode
  - getRoot
```
public TreeNode getRoot()
```
    Specified by:
    
    getRoot in interface TreeNodeWithChangeSupport
    
    Returns:
    A TreeNode without parent, which is the top-most ancestor of this node.
  - getTreeNodeChangeListenerCount
```
public int getTreeNodeChangeListenerCount()
```
    Specified by:
    
    getTreeNodeChangeListenerCount in interface TreeNodeWithChangeSupport
    
    Returns:
    the number of TreeNodeChangeListeners currently assigned to this TreeNodeWithChangeSupport
  - getUserObject
```
public Object getUserObject(Object key)
```
    Specified by:
    
    getUserObject in interface TreeNodeWithChangeSupport
    
    Returns:
    the userObject
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - isLeaf
```
public boolean isLeaf()
```
    Specified by:
    
    isLeaf in interface TreeNode
  - isRoot
```
public boolean isRoot()
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    Opposite of TreeNodeWithChangeSupport.isSetParent(). Returns true if this AbstractTreeNode is the root node of a tree, false otherwise.
    
    Specified by:
    
    isRoot in interface TreeNodeWithChangeSupport
    
    Returns:
    true if this AbstractTreeNode is the root node of a tree, false otherwise.
    See Also:
    TreeNodeWithChangeSupport.isSetParent()
  - isSetParent
```
public boolean isSetParent()
```
    Specified by:
    
    isSetParent in interface TreeNodeWithChangeSupport
    
    Returns:
  - isSetUserObjects
```
public boolean isSetUserObjects()
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    Checks whether any user-defined key-value pairs have been attached to this object.
    
    Specified by:
    
    isSetUserObjects in interface TreeNodeWithChangeSupport
    
    Returns:
    true if at least one user-defined key-value pair has been attached to this object.
  - putUserObject
```
public void putUserObject(Object key,
                 Object userObject)
```
    Specified by:
    
    putUserObject in interface TreeNodeWithChangeSupport
    
    Parameters:
    key - some user-defined key under which the given userObject can be found.
    userObject - the userObject to set
  - removeAllTreeNodeChangeListeners
```
public void removeAllTreeNodeChangeListeners()
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    Removes all tree node change listeners from this element.
    
    Specified by:
    
    removeAllTreeNodeChangeListeners in interface TreeNodeWithChangeSupport
  - removeFromParent
```
public boolean removeFromParent()
```
    This method is designed to be overridden for non-independent child nodes
    
    Specified by:
    
    removeFromParent in interface TreeNodeWithChangeSupport
    
    Returns:
    false if this element is a root node, true otherwise.
    See Also:
    TreeNodeWithChangeSupport.removeFromParent()
  - removeTreeNodeChangeListener
```
public void removeTreeNodeChangeListener(TreeNodeChangeListener listener)
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    Removes recursively the given change listener from this element. A call to this method is equivalent to calling TreeNodeWithChangeSupport.removeTreeNodeChangeListener(TreeNodeChangeListener, boolean) where the second argument is true.
    
    Specified by:
    
    removeTreeNodeChangeListener in interface TreeNodeWithChangeSupport
    
    Parameters:
    listener - the listener to remove.
    See Also:
    TreeNodeWithChangeSupport.removeTreeNodeChangeListener(TreeNodeChangeListener, boolean)
  - removeAllTreeNodeChangeListeners
```
public void removeAllTreeNodeChangeListeners(boolean recursive)
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    Removes all tree node change listeners recursively from this element.
    
    Specified by:
    
    removeAllTreeNodeChangeListeners in interface TreeNodeWithChangeSupport
  - removeTreeNodeChangeListener
```
public void removeTreeNodeChangeListener(TreeNodeChangeListener listener,
                                boolean recursive)
```
    Description copied from interface: TreeNodeWithChangeSupport
    
    Removes the given change listener from this element.
    
    Specified by:
    
    removeTreeNodeChangeListener in interface TreeNodeWithChangeSupport
    
    Parameters:
    listener - the listener to remove.
    recursive - switch to decide whether or not the given listener should be removed in a recursive manner.
    See Also:
    TreeNodeWithChangeSupport.removeTreeNodeChangeListener(TreeNodeChangeListener)
  - removeUserObject
```
public Object removeUserObject(Object key)
```
    Specified by:
    
    removeUserObject in interface TreeNodeWithChangeSupport
    
    Returns:
  - setParent
```
public void setParent(TreeNode parent)
```
    Parameters:
    parent - the parent to set
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - userObjectKeySet
```
public Set<Object> userObjectKeySet()
```
    Specified by:
    
    userObjectKeySet in interface TreeNodeWithChangeSupport
    
    Returns:
    See Also:
    Map.keySet()

Class AbstractTreeNode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface javax.swing.tree.TreeNode

Field Detail

UNKNOWN_ATTRIBUTES

UNKNOWN_ELEMENTS

Constructor Detail

AbstractTreeNode

AbstractTreeNode

Method Detail

indexOf

addAllChangeListeners

addAllChangeListeners

addTreeNodeChangeListener

addTreeNodeChangeListener

children

clearUserObjects

clone

containsUserObjectKey

equals

filter

filter

filter

fireNodeAddedEvent

fireNodeRemovedEvent

firePropertyChange

getIndex

getListOfTreeNodeChangeListeners

getNumChildren

getParent

getRoot

getTreeNodeChangeListenerCount

getUserObject

hashCode

isLeaf

isRoot

isSetParent

isSetUserObjects

putUserObject

removeAllTreeNodeChangeListeners

removeFromParent

removeTreeNodeChangeListener

removeAllTreeNodeChangeListeners

removeTreeNodeChangeListener

removeUserObject

setParent

toString

userObjectKeySet