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:

AbstractASTNode, ASTArithmeticOperatorNode, ASTBinaryFunctionNode, ASTBoolean, ASTCiFunctionNode, ASTCiNumberNode, ASTCnExponentialNode, ASTCnIntegerNode, ASTCnNumberNode, ASTCnRationalNode, ASTCnRealNode, ASTConstantNumber, ASTCSymbolAvogadroNode, ASTCSymbolDelayNode, ASTCSymbolTimeNode, ASTDivideNode, ASTFunction, ASTHyperbolicNode, ASTLambdaFunctionNode, ASTLogarithmNode, ASTLogicalOperatorNode, ASTMinusNode, ASTNumber, ASTPiecewiseFunctionNode, ASTPlusNode, ASTPowerNode, ASTQualifierNode, ASTRelationalOperatorNode, ASTRootNode, ASTTimesNode, ASTTrigonometricNode, ASTUnaryFunctionNode, ASTUnknown

public interface ASTNode2
extends TreeNodeWithChangeSupport

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

Since:

1.0

Version:

$Rev$

Author:

Victor Kofia

Method Summary

Modifier and Type	Method and Description
ASTNode2	clone() Clone ASTNode2
ASTNode2Value<?>	compile(ASTNode2Compiler compiler) Compiles this ASTNode2 and returns the result.
java.lang.String	getId() Get the id of this node
java.lang.String	getMathMLClass() Returns the class of the MathML element represented by this ASTNode2
MathContainer	getParentSBMLObject() Return the parentSBMLObject of this ASTNode2
java.lang.String	getStyle() Return the style of this node
ASTNode.Type	getType() Returns the type of this ASTNode2.
boolean	isAllowableType(ASTNode.Type type) Returns true iff type is allowed in this ASTNode2
boolean	isSetId() Returns true iff id has been set
boolean	isSetMathMLClass() Returns true iff mathMLClass has been set
boolean	isSetParentSBMLObject() Checks if a parent SBML object, i.e., a MathContainer, is set as a parent SBML object for this ASTNode2.
boolean	isSetStyle() Returns true iff style has been set
boolean	isSetType() Returns true iff type has been set
boolean	isStrict() Specifies strictness.
void	setId(java.lang.String id) Set the id of this node
void	setMathMLClass(java.lang.String mathMLClass) Set the class of the MathML element represented by this ASTNode2
void	setParent(javax.swing.tree.TreeNode astNode2)
void	setParentSBMLObject(MathContainer container) Sets the parentSBMLObject to container recursively
void	setStrictness(boolean strict) Set the strictness of this node
void	setStyle(java.lang.String style) Set the style of this node
void	setType(ASTNode.Type type) Set the type of the MathML element represented by this ASTNode2
void	setType(java.lang.String typeStr) Sets the type from a String.
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.
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

ASTNode2 clone()

Clone ASTNode2

Returns:

ASTNode2 node

compile

ASTNode2Value<?> compile(ASTNode2Compiler compiler)

Compiles this ASTNode2 and returns the result.

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.

Throws:

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

getId

java.lang.String getId()

Get the id of this node

Returns:

the id

getMathMLClass

java.lang.String getMathMLClass()

Returns the class of the MathML element represented by this ASTNode2

Returns:

String name

getParentSBMLObject

MathContainer getParentSBMLObject()

Return the parentSBMLObject of this ASTNode2

Returns:

MathContainer container

getStyle

java.lang.String getStyle()

Return the style of this node

Returns:

the style

getType

ASTNode.Type getType()

Returns the type of this ASTNode2.

Returns:

Type type

isAllowableType

boolean isAllowableType(ASTNode.Type type)

Returns true iff type is allowed in this ASTNode2

Parameters:

type -

Returns:

isSetId

boolean isSetId()

Returns true iff id has been set

Returns:

boolean

isSetMathMLClass

boolean isSetMathMLClass()

Returns true iff mathMLClass has been set

Returns:

boolean

isSetParentSBMLObject

boolean isSetParentSBMLObject()

Checks if a parent SBML object, i.e., a MathContainer, is set as a parent SBML object for this ASTNode2.

Returns:

boolean

isSetStyle

boolean isSetStyle()

Returns true iff style has been set

Returns:

boolean

isSetType

boolean isSetType()

Returns true iff type has been set

Returns:

boolean

isStrict

boolean isStrict()

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

Returns:

boolean

setId

void setId(java.lang.String id)

Set the id of this node

Parameters:

id - the id to set

setMathMLClass

void setMathMLClass(java.lang.String mathMLClass)

Set the class of the MathML element represented by this ASTNode2

Parameters:

mathMLClass -

setParent

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

Parameters:

astNode2 - the parent to set

setParentSBMLObject

void setParentSBMLObject(MathContainer container)

Sets the parentSBMLObject to container recursively

Parameters:

container -

setStyle

void setStyle(java.lang.String style)

Set the style of this node

Parameters:

style - the style to set

setType

void setType(java.lang.String typeStr)

Sets the type from a String. This method accepts all the supported mathML elements, the possible types of cn elements or the possible definitionURL of csymbol elements.

Parameters:

typeStr - the type as a String.

setType

void setType(ASTNode.Type type)

Set the type of the MathML element represented by this ASTNode2

Parameters:

type -

toFormula

java.lang.String toFormula()

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.

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

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.

setStrictness

void setStrictness(boolean strict)

Set the strictness of this node

Parameters:

strict -