org.sbml.jsbml.math

Class ASTBinaryFunctionNode

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.math.AbstractASTNode

org.sbml.jsbml.math.ASTFunction

org.sbml.jsbml.math.ASTBinaryFunctionNode

All Implemented Interfaces:

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

Direct Known Subclasses:

ASTCSymbolDelayNode, ASTDivideNode, ASTLogarithmNode, ASTMinusNode, ASTPlusNode, ASTPowerNode, ASTRootNode, ASTTimesNode

public class ASTBinaryFunctionNode
extends ASTFunction

An Abstract Syntax Tree (AST) node representing a function with two parameters

Since:

1.0

Version:

$Rev$

Author:

Victor Kofia

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static org.apache.log4j.Logger	logger A Logger for this class.
private static long	serialVersionUID

Fields inherited from class org.sbml.jsbml.math.ASTFunction

listOfNodes

Fields inherited from class org.sbml.jsbml.math.AbstractASTNode

id, mathMLClass, parentSBMLObject, strict, style, type

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

Constructor Summary

Constructors

Constructor and Description
ASTBinaryFunctionNode() Creates a new ASTBinaryFunctionNode.
ASTBinaryFunctionNode(ASTBinaryFunctionNode node) Copy constructor; Creates a deep copy of the given ASTBinaryFunctionNode.
ASTBinaryFunctionNode(ASTNode2 leftChild, ASTNode2 rightChild) Creates a new ASTBinaryFunctionNode with the specified children.

Method Summary

Modifier and Type	Method and Description
void	addChild(ASTNode2 child) Adds a child to this node.
ASTBinaryFunctionNode	clone() Clone ASTNode2
ASTNode2	getChildAt(int childIndex)
ASTNode2	getLeftChild() Get the left child of this ASTBinaryFunctionNode
ASTNode2	getRightChild() Get the right child of this ASTBinaryFunctionNode
void	insertChild(int n, ASTNode2 newChild) Inserts the given ASTNode2 at point n in the list of children of this ASTNode2.
boolean	isSetLeftChild() Return true iff left child has been set
boolean	isSetRightChild() Return true iff right child has been set
void	prependChild(ASTNode2 child) Adds the given node as a child of this ASTBinaryFunctionNode.
boolean	removeChild(int n) Removes child n of this ASTFunction.
void	setLeftChild(ASTNode2 child) Set the left child of this ASTBinaryFunctionNode
void	setRightChild(ASTNode2 child) Set the right child of this ASTBinaryFunctionNode
void	swapChildren(ASTFunction that) Swaps the children of this ASTFunction with the children of that ASTFunction.

Methods inherited from class org.sbml.jsbml.math.ASTFunction

compile, equals, findReferencedCallableSBases, getAllowsChildren, getChildCount, getChildren, getListOfNodes, getListOfNodes, getName, hashCode, hasUnits, isAllowableType, isSetList, isSetName, replaceChild, setName, setParentSBMLObject

Methods inherited from class org.sbml.jsbml.math.AbstractASTNode

getId, getMathMLClass, getParentSBMLObject, getStyle, getType, isSetId, isSetMathMLClass, isSetParentSBMLObject, isSetStyle, isSetType, isStrict, processValue, setId, setMathMLClass, setParent, setStrictness, setStyle, setType, setType, toFormula, toLaTeX, toMathML, unsetParentSBMLObject

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, toString, userObjectKeySet

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sbml.jsbml.math.ASTNode2

toString

Methods inherited from interface org.sbml.jsbml.util.TreeNodeWithChangeSupport

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, getParent, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

logger

private static final org.apache.log4j.Logger logger

A Logger for this class.

Constructor Detail

ASTBinaryFunctionNode

public ASTBinaryFunctionNode()

Creates a new ASTBinaryFunctionNode.

ASTBinaryFunctionNode

public ASTBinaryFunctionNode(ASTBinaryFunctionNode node)

Copy constructor; Creates a deep copy of the given ASTBinaryFunctionNode.

Parameters:

node - the ASTBinaryFunctionNode to be copied.

ASTBinaryFunctionNode

public ASTBinaryFunctionNode(ASTNode2 leftChild,
                             ASTNode2 rightChild)

Creates a new ASTBinaryFunctionNode with the specified children.

Parameters:

leftChild -

rightChild -

Method Detail

addChild

public void addChild(ASTNode2 child)

Adds a child to this node.

Overrides:

addChild in class ASTFunction

Parameters:

child - the node to add as child.

Throws:

java.lang.NullPointerException - if the child is null

java.lang.IndexOutOfBoundsException - if strictness is set to true and max child limit has been exceeded

clone

public ASTBinaryFunctionNode clone()

Description copied from interface: ASTNode2

Clone ASTNode2

Specified by:

clone in interface ASTNode2

Overrides:

clone in class ASTFunction

Returns:

ASTNode2 node

getChildAt

public ASTNode2 getChildAt(int childIndex)

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class ASTFunction

Throws:

java.lang.IndexOutOfBoundsException - if strictness is set to true and max child limit has been exceeded

getLeftChild

public ASTNode2 getLeftChild()

Get the left child of this ASTBinaryFunctionNode

Returns:

ASTNode2 leftChild

getRightChild

public ASTNode2 getRightChild()

Get the right child of this ASTBinaryFunctionNode

Returns:

ASTNode2 rightChild

insertChild

public void insertChild(int n,
                        ASTNode2 newChild)

Inserts the given ASTNode2 at point n in the list of children of this ASTNode2. Inserting a child within an ASTNode2 may result in an inaccurate representation.

Overrides:

insertChild in class ASTFunction

Parameters:

n - long the index of the ASTNode2 being added

newChild - ASTNode2 to insert as the n^th child

Throws:

java.lang.NullPointerException - if the child is null

java.lang.IndexOutOfBoundsException - if strictness is set to true and max child limit has been exceeded

isSetLeftChild

public boolean isSetLeftChild()

Return true iff left child has been set

Returns:

boolean

isSetRightChild

public boolean isSetRightChild()

Return true iff right child has been set

Returns:

boolean

prependChild

public void prependChild(ASTNode2 child)

Adds the given node as a child of this ASTBinaryFunctionNode. This method adds child nodes from right to left.

Overrides:

prependChild in class ASTFunction

Parameters:

child - an ASTNode2

Throws:

java.lang.NullPointerException - if the child is null

java.lang.IndexOutOfBoundsException - if strictness is set to true and max child limit has been exceeded

removeChild

public boolean removeChild(int n)

Description copied from class: ASTFunction

Removes child n of this ASTFunction. Removing a child from an ASTFunction may result in an inaccurate representation.

Overrides:

removeChild in class ASTFunction

Parameters:

n - the index of the child to remove

Returns:

boolean indicating the success or failure of the operation

setLeftChild

public void setLeftChild(ASTNode2 child)

Set the left child of this ASTBinaryFunctionNode

Parameters:

child - ASTNode2

setRightChild

public void setRightChild(ASTNode2 child)

Set the right child of this ASTBinaryFunctionNode

Parameters:

child - ASTNode2

swapChildren

public void swapChildren(ASTFunction that)

Swaps the children of this ASTFunction with the children of that ASTFunction.

Unfortunately, when swapping child nodes, we have to recursively traverse the entire subtrees in order to make sure that all pointers to the parent SBML object are correct. However, this must only be done if the parent SBML object of that differs from the one surrounding this node.

In any case, the pointer from each sub-node to its parent must be changed. In contrast to other SBML elements, ASTFunctions have sub-nodes as direct children, i.e., there is no child called 'ListOfNodes'. The setParent method is also not recursive.

However, this might cause many calls to listeners.

Overrides:

swapChildren in class ASTFunction

Parameters:

that - the other node whose children should be used to replace this node's children

Throws:

java.lang.IndexOutOfBoundsException - if strictness is set to true and max child limit has been exceeded