Package org.sbml.jsbml.math

Class ASTMinusNode

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.ASTMinusNode

All Implemented Interfaces:

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

public class ASTMinusNode
extends ASTBinaryFunctionNode

An Abstract Syntax Tree (AST) node representing the minus operator

Since:

1.0

Author:

Victor Kofia

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ASTMinusNode	clone()	Clone ASTNode2
ASTNode2Value<?>	compile(ASTNode2Compiler compiler)	Compiles this ASTNode2 and returns the result.
boolean	isAllowableType(ASTNode.Type type)	Returns true iff type is allowed in this ASTNode2
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.AbstractASTNode

getId, getMathMLClass, getParentSBMLObject, getStyle, getType, isSetId, isSetMathMLClass, isSetParentSBMLObject, isSetStyle, isSetType, isStrict, 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, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, toString, userObjectKeySet

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

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

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

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

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

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, getParent, isLeaf

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

Constructor Detail

ASTMinusNode

public ASTMinusNode()

Creates a new ASTMinusNode.

ASTMinusNode

public ASTMinusNode(ASTMinusNode node)

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

Parameters:

node - the ASTMinusNode to be copied.

ASTMinusNode

public ASTMinusNode(ASTNode2 leftChild,
                    ASTNode2 rightChild)

Creates a new ASTMinusNode with two children

Parameters:

leftChild - ASTNode2

rightChild - ASTNode2

Method Detail

clone

public ASTMinusNode 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.

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:

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

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

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.