org.sbml.jsbml.math

Interface ASTNode2

All Superinterfaces:

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

All Known Subinterfaces:

ASTCSymbolBaseNode, ASTCSymbolNode

All Known Implementing Classes:

AbstractASTCSymbolNode, AbstractASTNode, ASTArithmeticNode, ASTBinaryFunctionNode, ASTCiFunctionNode, ASTCiNumberNode, ASTCnExponentialNode, ASTCnIntegerNode, ASTCnNumberNode, ASTCnRationalNode, ASTCnRealNode, ASTConstantNumber, ASTCSymbolAvogadroNode, ASTCSymbolDelayNode, ASTCSymbolTimeNode, ASTDivideFunction, ASTFunction, ASTHyperbolicNode, ASTLambdaFunctionNode, ASTLogarithmNode, ASTLogicalOperatorNode, ASTNumber, ASTPiecewiseFunctionNode, ASTPowerNode, ASTQualifierNode, ASTRelationNode, ASTSqrtNode, ASTTimesNode, ASTTrigonometricNode, ASTUnaryFunctionNode

public interface ASTNode2
extends TreeNodeWithChangeSupport

A node in the Abstract Syntax Tree (AST) representation of a mathematical expression.

Since:

1.0

Version:

$Rev: 1823 $

Author:

Victor Kofia

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.tree.TreeNode	clone() Clone ASTNode2
ASTNodeValue	compile(AbstractASTNodeCompiler compiler) Compiles this ASTNode2 and returns the result.
MathContainer	getParentSBMLObject() Sets the parentSBMLObject to container recursively
ASTNode.Type	getType() Returns the type of this ASTNode2.
boolean	isStrict() Specifies strictness.
void	setParent(javax.swing.tree.TreeNode astNode2)
void	setParentSBMLObject(MathContainer container) Sets the parentSBMLObject to container recursively
java.lang.String	toFormula() Converts this AbstractASTNode 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.
java.lang.String	toString()
void	unsetParentSBMLObject() Unsets the parentSBMLObject to null recursively.

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, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Method Detail

clone

javax.swing.tree.TreeNode clone()

Clone ASTNode2

Returns:

TreeNode node

compile

ASTNodeValue compile(AbstractASTNodeCompiler compiler)

Compiles this ASTNode2 and returns the result.

Parameters:

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

Returns:

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

Throws:

SBMLException - Thrown if an error occurs during the compilation process.

getParentSBMLObject

MathContainer getParentSBMLObject()

Sets the parentSBMLObject to container recursively

Returns:

MathContainer container

getType

ASTNode.Type getType()

Returns the type of this ASTNode2.

Returns:

Type type

isStrict

boolean isStrict()

Specifies strictness. When true, ASTUnaryFunctionNode and ASTBinaryFunctionNode nodes can only contain the specified # of children. When false, there is a bit of leeway (i.e., ASTUnaryFunctionNode can contain more than one child) (not recommended).

Returns:

boolean

setParent

void setParent(javax.swing.tree.TreeNode astNode2)

Parameters:

parent - the parent to set

setParentSBMLObject

void setParentSBMLObject(MathContainer container)

Sets the parentSBMLObject to container recursively

Parameters:

MathContainer - container

toFormula

java.lang.String toFormula()

Converts this AbstractASTNode 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.

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 AbstractASTNode tree.

toLaTeX

java.lang.String toLaTeX()

Converts this node recursively into a LaTeX formatted String.

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

java.lang.String toMathML()

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

Returns:

the representation of this node in MathML.

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

unsetParentSBMLObject

void unsetParentSBMLObject()

Unsets the parentSBMLObject to null recursively.

Parameters:

{@link - ASTNode2} node