org.sbml.jsbml.math

Class ASTRootNode

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.math.AbstractASTNode

org.sbml.jsbml.math.ASTFunction

org.sbml.jsbml.math.ASTBinaryFunctionNode

org.sbml.jsbml.math.ASTRootNode

All Implemented Interfaces:

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

public class ASTRootNode
extends ASTBinaryFunctionNode

An Abstract Syntax Tree (AST) node representing a root function

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
ASTRootNode() Creates a new ASTRootNode.
ASTRootNode(ASTNode2 radicand) Creates a new ASTRootNode with the specified radicand and a root exponent of 2.
ASTRootNode(ASTNode2 rootExponent, ASTNode2 radicand) Creates a new ASTRootNode with the specified radicand and rootExponent.
ASTRootNode(ASTRootNode node) Copy constructor; Creates a deep copy of the given ASTRootNode.

Method Summary

Modifier and Type	Method and Description
ASTRootNode	clone() Clone ASTNode2
ASTNode2Value<?>	compile(ASTNode2Compiler compiler) Compiles this ASTNode2 and returns the result.
ASTNode2	getRadicand() Return the radicand of this ASTRootNode
ASTNode2	getRootExponent() Return the root exponent of this ASTRootNode
boolean	isAllowableType(ASTNode.Type type) Returns true iff type is allowed in this ASTNode2
boolean	isSetLeftChild() Return true iff left child has been set
boolean	isSetRightChild() Return true iff right child has been set
void	setRadicand(ASTNode2 radicand) Set the radicand of this ASTRootNode
void	setRootExponent(ASTNode2 rootExponent) Set the root exponent of this ASTRootNode
java.lang.String	toFormula() Converts this ASTNode2 to a text string using a specific syntax for mathematical formulas.
java.lang.String	toLaTeX() Converts this node recursively into a LaTeX formatted String.
java.lang.String	toMathML() Converts this node recursively into a MathML string that corresponds to the subset of MathML defined in the SBML specification.

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

addChild, getChildAt, getLeftChild, getRightChild, insertChild, prependChild, removeChild, setLeftChild, setRightChild, swapChildren

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

equals, findReferencedCallableSBases, getAllowsChildren, getChildCount, getChildren, getListOfNodes, getListOfNodes, getName, hashCode, hasUnits, 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, 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

ASTRootNode

public ASTRootNode()

Creates a new ASTRootNode.

ASTRootNode

public ASTRootNode(ASTNode2 radicand)

Creates a new ASTRootNode with the specified radicand and a root exponent of 2.

Parameters:

radicand - ASTNode2

ASTRootNode

public ASTRootNode(ASTNode2 rootExponent,
                   ASTNode2 radicand)

Creates a new ASTRootNode with the specified radicand and rootExponent.

Parameters:

rootExponent - ASTNode2

radicand - ASTNode2

ASTRootNode

public ASTRootNode(ASTRootNode node)

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

Parameters:

node - the ASTRootNode to be copied.

Method Detail

clone

public ASTRootNode clone()

Description copied from interface: ASTNode2

Clone ASTNode2

Specified by:

clone in interface ASTNode2

Overrides:

clone in class ASTBinaryFunctionNode

Returns:

ASTNode2 node

compile

public ASTNode2Value<?> compile(ASTNode2Compiler compiler)

Description copied from interface: ASTNode2

Compiles this ASTNode2 and returns the result.

Specified by:

compile in interface ASTNode2

Overrides:

compile in class ASTFunction

Parameters:

compiler - An instance of an ASTNode2Compiler that provides methods to translate this ASTNode2 into something different.

Returns:

Some value wrapped in an ASTNode2Value. The content of the wrapper depends on the ASTNode2Compiler used to create it. However, this ASTNode2 will ensure that level and version are set appropriately according to this node's parent SBML object.

getRadicand

public ASTNode2 getRadicand()

Return the radicand of this ASTRootNode

Returns:

radicand ASTNode2

getRootExponent

public ASTNode2 getRootExponent()

Return the root exponent of this ASTRootNode

Returns:

rootExponent ASTNode2

isAllowableType

public boolean isAllowableType(ASTNode.Type type)

Description copied from interface: ASTNode2

Returns true iff type is allowed in this ASTNode2

Specified by:

isAllowableType in interface ASTNode2

Overrides:

isAllowableType in class ASTFunction

Returns:

isSetLeftChild

public boolean isSetLeftChild()

Description copied from class: ASTBinaryFunctionNode

Return true iff left child has been set

Overrides:

isSetLeftChild in class ASTBinaryFunctionNode

Returns:

boolean

isSetRightChild

public boolean isSetRightChild()

Description copied from class: ASTBinaryFunctionNode

Return true iff right child has been set

Overrides:

isSetRightChild in class ASTBinaryFunctionNode

Returns:

boolean

setRadicand

public void setRadicand(ASTNode2 radicand)

Set the radicand of this ASTRootNode

Parameters:

radicand - ASTNode2

setRootExponent

public void setRootExponent(ASTNode2 rootExponent)

Set the root exponent of this ASTRootNode

Parameters:

rootExponent - ASTNode2

toFormula

public java.lang.String toFormula()
                           throws SBMLException

Description copied from interface: ASTNode2

Converts this ASTNode2 to a text string using a specific syntax for mathematical formulas.

The text-string form of mathematical formulas produced by formulaToString() and read by parseFormula() are simple C-inspired infix notation taken from SBML Level 1. A formula in this text-string form therefore can be handed to a program that understands SBML Level 1 mathematical expressions, or used as part of a formula translation system. The syntax is described in detail in the documentation for ASTNode.

Specified by:

toFormula in interface ASTNode2

Overrides:

toFormula in class AbstractASTNode

Returns:

the formula from the given AST as an SBML Level 1 text-string mathematical formula. The caller owns the returned string and is responsible for freeing it when it is no longer needed. null is returned if the given argument is null.

Throws:

SBMLException - if there is a problem in the ASTNode2 tree.

toLaTeX

public java.lang.String toLaTeX()
                         throws SBMLException

Description copied from interface: ASTNode2

Converts this node recursively into a LaTeX formatted String.

Specified by:

toLaTeX in interface ASTNode2

Overrides:

toLaTeX in class AbstractASTNode

Returns:

A String representing the LaTeX code necessary to write the formula corresponding to this node in a document.

Throws:

SBMLException - if there is a problem in the AbstractASTNode tree.

toMathML

public java.lang.String toMathML()

Description copied from interface: ASTNode2

Converts this node recursively into a MathML string that corresponds to the subset of MathML defined in the SBML specification.

Specified by:

toMathML in interface ASTNode2

Overrides:

toMathML in class AbstractASTNode

Returns:

the representation of this node in MathML.