org.sbml.jsbml.util

Interface TreeNodeWithChangeSupport

All Superinterfaces:

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

All Known Subinterfaces:

Assignment, ASTCSymbolBaseNode, ASTCSymbolNode, ASTNode2, ASTNodePlugin, CallableSBase, CompartmentalizedSBase, MathContainer, NamedSBase, NamedSBaseWithDerivedUnit, Quantity, SBase, SBasePlugin, SBaseWithDerivedUnit, SBaseWithUnit, UniqueNamedSBase, Variable

All Known Implementing Classes:

AbstractASTNode, AbstractASTNodePlugin, AbstractMathContainer, AbstractNamedSBase, AbstractNamedSBaseWithUnit, AbstractSBase, AbstractSBasePlugin, AbstractTreeNode, AlgebraicRule, Annotation, AnnotationElement, AssignmentRule, ASTArithmeticOperatorNode, ASTBinaryFunctionNode, ASTBoolean, ASTCiFunctionNode, ASTCiNumberNode, ASTCnExponentialNode, ASTCnIntegerNode, ASTCnNumberNode, ASTCnRationalNode, ASTCnRealNode, ASTConstantNumber, ASTCSymbolAvogadroNode, ASTCSymbolDelayNode, ASTCSymbolTimeNode, ASTDivideNode, ASTFunction, ASTHyperbolicNode, ASTLambdaFunctionNode, ASTLogarithmNode, ASTLogicalOperatorNode, ASTMinusNode, ASTNode, ASTNumber, ASTPiecewiseFunctionNode, ASTPlusNode, ASTPowerNode, ASTQualifierNode, ASTRelationalOperatorNode, ASTRootNode, ASTTimesNode, ASTTrigonometricNode, ASTUnaryFunctionNode, ASTUnknown, Compartment, CompartmentType, Constraint, Creator, CVTerm, Delay, Event, EventAssignment, ExplicitRule, FunctionDefinition, History, InitialAssignment, KineticLaw, ListOf, ListOfWithName, LocalParameter, Model, ModifierSpeciesReference, Parameter, Priority, QuantityWithUnit, RateRule, Reaction, Rule, SBMLDocument, SBMLLevel1Rule, SimpleSpeciesReference, Species, SpeciesReference, SpeciesType, StoichiometryMath, Symbol, TreeNodeAdapter, Trigger, Unit, UnitDefinition, XMLNode, XMLToken

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

This interface extends the regular recursively defined TreeNode by adding methods to keep track of changes within the tree, such as adding/removing, or exchanging of child nodes or the change of any other attributes.

Since:

0.8

Version:

$Rev$

Author:

Andreas Dräger

Method Summary

Modifier and Type	Method and Description
boolean	addAllChangeListeners(java.util.Collection<TreeNodeChangeListener> listeners) Adds recursively all given TreeNodeChangeListener instances to this element.
boolean	addAllChangeListeners(java.util.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.
void	clearUserObjects() Removes all of the mappings from the map of user objects (optional operation).
boolean	containsUserObjectKey(java.lang.Object key)
java.util.List<? extends javax.swing.tree.TreeNode>	filter(Filter filter) Filters this tree data structure recursively and returns a list of all TreeNodes that are accepted by the Filter.
java.util.List<? extends javax.swing.tree.TreeNode>	filter(Filter filter, boolean retainInternalNodes) Filters this tree data structure recursively and returns a list of all TreeNodes that are accepted by the Filter.
java.util.List<? extends javax.swing.tree.TreeNode>	filter(Filter filter, boolean retainInternalNodes, boolean prune) Filters this tree data structure recursively and returns a list of all TreeNodes 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(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue) All TreeNodeChangeListeners are informed about the change in this TreeNodeWithChangeSupport.
java.util.List<TreeNodeChangeListener>	getListOfTreeNodeChangeListeners() Returns all TreeNodeChangeListeners that are assigned to this element.
javax.swing.tree.TreeNode	getRoot()
int	getTreeNodeChangeListenerCount()
java.lang.Object	getUserObject(java.lang.Object key)
boolean	isRoot() Opposite of isSetParent().
boolean	isSetParent()
boolean	isSetUserObjects() Checks whether any user-defined key-value pairs have been attached to this object.
void	putUserObject(java.lang.Object key, java.lang.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() Removes itself from its parent.
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.
java.lang.Object	removeUserObject(java.lang.Object key)
java.util.Set<java.lang.Object>	userObjectKeySet()

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Method Detail

addAllChangeListeners

boolean addAllChangeListeners(java.util.Collection<TreeNodeChangeListener> listeners)

Adds recursively all given TreeNodeChangeListener instances to this element.

Parameters:

listeners - the set of listeners to add

Returns:

true if the set of listeners is added with success.

addTreeNodeChangeListener

void addTreeNodeChangeListener(TreeNodeChangeListener listener)

Adds recursively a listener to the TreeNodeWithChangeSupport object and all of its sub-elements. Calling this method is effectively identical to the call addTreeNodeChangeListener(TreeNodeChangeListener, boolean) where recursively = true.

Parameters:

listener - the listener to add

See Also:

addTreeNodeChangeListener(TreeNodeChangeListener, boolean)

addTreeNodeChangeListener

void addTreeNodeChangeListener(TreeNodeChangeListener listener,
                               boolean recursive)

Adds a listener to this TreeNodeWithChangeSupport object and optionally also to all of its child nodes.

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:

addTreeNodeChangeListener(TreeNodeChangeListener)

clearUserObjects

void clearUserObjects()

Removes all of the mappings from the map of user objects (optional operation). The map will be empty after this call returns.

See Also:

Map#clear()

containsUserObjectKey

boolean containsUserObjectKey(java.lang.Object key)

Parameters:

key -

Returns:

See Also:

Map#containsKey(java.lang.Object)

filter

java.util.List<? extends javax.swing.tree.TreeNode> filter(Filter filter)

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.

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:

filter(Filter, boolean)

filter

java.util.List<? extends javax.swing.tree.TreeNode> filter(Filter filter,
                                                           boolean retainInternalNodes)

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.

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:

filter(Filter)

filter

java.util.List<? extends javax.swing.tree.TreeNode> filter(Filter filter,
                                                           boolean retainInternalNodes,
                                                           boolean prune)

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.

Parameters:

filter -

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:

filter(Filter, boolean)

fireNodeAddedEvent

void fireNodeAddedEvent()

All TreeNodeChangeListener instances linked to this TreeNode are informed about the adding of this Object to an owning parent Object.

fireNodeRemovedEvent

void fireNodeRemovedEvent()

All TreeNodeChangeListener instances linked to this TreeNode are informed about the deletion of this TreeNode from a parent Object.

firePropertyChange

void firePropertyChange(java.lang.String propertyName,
                        java.lang.Object oldValue,
                        java.lang.Object newValue)

All TreeNodeChangeListeners are informed about the change in this 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..

getListOfTreeNodeChangeListeners

java.util.List<TreeNodeChangeListener> getListOfTreeNodeChangeListeners()

Returns all TreeNodeChangeListeners that are assigned to this element.

Returns:

all TreeNodeChangeListeners that are assigned to this element.

getRoot

javax.swing.tree.TreeNode getRoot()

Returns:

A TreeNode without parent, which is the top-most ancestor of this node.

getTreeNodeChangeListenerCount

int getTreeNodeChangeListenerCount()

Returns:

the number of TreeNodeChangeListeners currently assigned to this TreeNodeWithChangeSupport

getUserObject

java.lang.Object getUserObject(java.lang.Object key)

Parameters:

key -

Returns:

the userObject

isRoot

boolean isRoot()

Opposite of isSetParent(). Returns true if this AbstractTreeNode is the root node of a tree, false otherwise.

Returns:

true if this AbstractTreeNode is the root node of a tree, false otherwise.

See Also:

isSetParent()

isSetParent

boolean isSetParent()

Returns:

isSetUserObjects

boolean isSetUserObjects()

Checks whether any user-defined key-value pairs have been attached to this object.

Returns:

true if at least one user-defined key-value pair has been attached to this object.

putUserObject

void putUserObject(java.lang.Object key,
                   java.lang.Object userObject)

Parameters:

key - some user-defined key under which the given userObject can be found.

userObject - the userObject to set

removeAllTreeNodeChangeListeners

void removeAllTreeNodeChangeListeners()

Removes all tree node change listeners from this element.

removeAllTreeNodeChangeListeners

void removeAllTreeNodeChangeListeners(boolean recursive)

Removes all tree node change listeners recursively from this element.

Parameters:

recursive -

removeFromParent

boolean removeFromParent()

Removes itself from its parent. This will remove the element from its parent and remove the pointer from the element to its parent. If the element is a member of a List, it is simply cleared. Will fail (and not delete itself) if it has no parent object. This function will work for all objects whose parent is of type List and most instances of TreeNode.

Returns:

false if this element is a root node, true otherwise.

removeTreeNodeChangeListener

void removeTreeNodeChangeListener(TreeNodeChangeListener listener)

Removes recursively the given change listener from this element. A call to this method is equivalent to calling removeTreeNodeChangeListener(TreeNodeChangeListener, boolean) where the second argument is true.

Parameters:

listener - the listener to remove.

See Also:

removeTreeNodeChangeListener(TreeNodeChangeListener, boolean)

removeTreeNodeChangeListener

void removeTreeNodeChangeListener(TreeNodeChangeListener listener,
                                  boolean recursive)

Removes the given change listener from this element.

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:

removeTreeNodeChangeListener(TreeNodeChangeListener)

removeUserObject

java.lang.Object removeUserObject(java.lang.Object key)

Parameters:

key -

Returns:

userObjectKeySet

java.util.Set<java.lang.Object> userObjectKeySet()

Returns:

See Also:

Map#keySet()

addAllChangeListeners

boolean addAllChangeListeners(java.util.Collection<TreeNodeChangeListener> listeners,
                              boolean recursive)

Parameters:

listeners -

recursive -

Returns: