org.sbml.jsbml.ext

Interface ASTNodePlugin

All Superinterfaces:

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

All Known Implementing Classes:

AbstractASTNodePlugin

public interface ASTNodePlugin
extends TreeNodeWithChangeSupport

Defines the methods necessary for an ASTNode or ASTNode2 Plugin. When a SBML level 3 is extending one of the mathML elements with additional attributes or child elements, a ASTNodePlugin is created to serve as a place holder for these new attributes or elements.

Since:

1.2

Version:

$Rev$

Author:

Nicolas Rodriguez

Method Summary

Modifier and Type	Method and Description
ASTNodePlugin	clone() Creates a new instance of ASTNodePlugin from this ASTNodePlugin.
boolean	equals(java.lang.Object obj)
java.lang.String	getElementNamespace() Returns the XML namespace (URI) of the package extension of this plugin object.
javax.swing.tree.TreeNode	getExtendedASTNode() Returns the object that is extended by this plug-in.
int	getLevel() Returns the SBML level of this plugin object.
java.lang.String	getPackageName() Returns the package name of this plugin object.
int	getPackageVersion() Returns the package version of the package extension of this plugin object.
SBase	getParentSBMLObject() Returns the parent SBase object to which this plugin object is connected.
java.lang.String	getPrefix() Returns the prefix of the package extension of this plugin object.
SBMLDocument	getSBMLDocument() Returns the parent SBMLDocument of this plugin object.
java.lang.String	getURI() Gets the URI to which this element belongs to.
int	getVersion() Returns the SBML version of this plugin object.
int	hashCode()
boolean	isSetExtendedASTNode() Checks whether an extended TreeNode has been set.
boolean	isSetPackageVersion() Returns true if a package version is set, false otherwise.
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Reads and sets the attribute if it is know from this SBasePlugin.
void	setPackageVersion(int packageVersion) Sets the package version.
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes() Returns a Map containing the XML attributes of this object.

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

ASTNodePlugin clone()

Creates a new instance of ASTNodePlugin from this ASTNodePlugin.

Returns:

a new instance of ASTNodePlugin from this ASTNodePlugin.

equals

boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getElementNamespace

java.lang.String getElementNamespace()

Returns the XML namespace (URI) of the package extension of this plugin object.

Returns:

the URI of the package extension of this plugin object.

See Also:

getURI()

getExtendedASTNode

javax.swing.tree.TreeNode getExtendedASTNode()

Returns the object that is extended by this plug-in.

Returns:

the object that is extended by this plug-in.

getLevel

int getLevel()

Returns the SBML level of this plugin object.

Returns:

the SBML level of this plugin object.

See Also:

SBase.getLevel()

getPackageName

java.lang.String getPackageName()

Returns the package name of this plugin object.

Returns:

the package name of this plugin object.

getPackageVersion

int getPackageVersion()

Returns the package version of the package extension of this plugin object.

Returns:

the package version of the package extension of this plugin object.

getParentSBMLObject

SBase getParentSBMLObject()

Returns the parent SBase object to which this plugin object is connected.

Returns:

the parent SBase object to which this plugin object is connected.

getPrefix

java.lang.String getPrefix()

Returns the prefix of the package extension of this plugin object.

Returns:

the prefix of the package extension of this plugin object.

getSBMLDocument

SBMLDocument getSBMLDocument()

Returns the parent SBMLDocument of this plugin object.

Returns:

the parent SBMLDocument object of this plugin object.

getURI

java.lang.String getURI()

Gets the URI to which this element belongs to. For example, all elements that belong to SBML Level 3 Version 1 Core must have the URI 'http://www.sbml.org/sbml/level3/version1/core'; all elements that belong to Layout Extension Version 1 for SBML Level 3 Version 1 Core must would have the URI 'http://www.sbml.org/sbml/level3/version1/layout/version1/'.

Returns:

the URI for this element

See Also:

getElementNamespace()

getVersion

int getVersion()

Returns the SBML version of this plugin object.

Returns:

the SBML version of this plugin object.

See Also:

SBase.getVersion()

hashCode

int hashCode()

Overrides:

hashCode in class java.lang.Object

isSetExtendedASTNode

boolean isSetExtendedASTNode()

Checks whether an extended TreeNode has been set.

Returns:

true if an extended TreeNode has been set.

isSetPackageVersion

boolean isSetPackageVersion()

Returns true if a package version is set, false otherwise.

Returns:

true if a package version is set, false otherwise.

readAttribute

boolean readAttribute(java.lang.String attributeName,
                      java.lang.String prefix,
                      java.lang.String value)

Reads and sets the attribute if it is know from this SBasePlugin.

Parameters:

attributeName - localName of the XML attribute

prefix - prefix of the XML attribute

value - value of the XML attribute

Returns:

true if the attribute has been successfully read.

setPackageVersion

void setPackageVersion(int packageVersion)

Sets the package version.

Parameters:

packageVersion - the packageVersion to set

writeXMLAttributes

java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()

Returns a Map containing the XML attributes of this object.

Returns:

a Map containing the XML attributes of this object.