org.sbml.jsbml.ext

Interface SBasePlugin

All Superinterfaces:

Cloneable, Serializable, TreeNode, TreeNodeWithChangeSupport

All Known Implementing Classes:

AbstractFBCSBasePlugin, AbstractRenderPlugin, AbstractSBasePlugin, AbstractSpatialSBasePlugin, ArraysSBasePlugin, CompModelPlugin, CompSBasePlugin, CompSBMLDocumentPlugin, DistribFunctionDefinitionPlugin, DistribSBasePlugin, DynCompartmentPlugin, DynEventPlugin, DynSBasePlugin, FBCModelPlugin, FBCReactionPlugin, FBCSpeciesPlugin, GroupsModelPlugin, LayoutModelPlugin, MultiCompartmentPlugin, MultiModelPlugin, MultiSimpleSpeciesReferencePlugin, MultiSpeciesPlugin, MultiSpeciesReferencePlugin, QualitativeModel, QualModelPlugin, RenderLayoutPlugin, RenderListOfLayoutsPlugin, ReqSBasePlugin, SpatialCompartmentPlugin, SpatialModelPlugin, SpatialParameterPlugin, SpatialReactionPlugin, SpatialSpeciesPlugin

public interface SBasePlugin
extends TreeNodeWithChangeSupport

Defines the methods necessary for an SBase Plugin. When a SBML level 3 is extending one of the core SBML elements with additional attributes or child elements, a SBasePlugin is created to serve as a place holder for there new attributes or elements.

Since:

1.0

Version:

$Rev: 2377 $

Author:

Nicolas Rodriguez

Method Summary

Methods

Modifier and Type	Method and Description
SBasePlugin	clone() Creates a new instance of SBasePlugin from this SBasePlugin.
boolean	equals(Object obj)
String	getElementNamespace() Returns the XML namespace (URI) of the package extension of this plugin object.
SBase	getExtendedSBase() Returns the SBase object that is extended by this plug-in.
int	getLevel()
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 connected.
String	getPrefix() Returns the prefix of the package extension of this plugin object.
SBMLDocument	getSBMLDocument() Returns the parent SBMLDocument of this plugin object.
String	getURI() Gets the URI to which this element belongs to.
int	getVersion()
int	hashCode()
boolean	isSetExtendedSBase() Check whether an extended SBase has been set.
boolean	isSetPackageVersion()
boolean	readAttribute(String attributeName, String prefix, String value) Reads and sets the attribute if it is know from this SBasePlugin.
void	setPackageVersion(int packageVersion)
Map<String,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

SBasePlugin clone()

Creates a new instance of SBasePlugin from this SBasePlugin.

Returns:

a new instance of SBasePlugin from this SBasePlugin.

equals

boolean equals(Object obj)

Overrides:

equals in class Object

Parameters:

obj -

Returns:

getElementNamespace

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.

getExtendedSBase

SBase getExtendedSBase()

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

Returns:

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

getLevel

int getLevel()

Returns:

See Also:

SBase.getLevel()

getPackageName

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

Returns:

the parent SBase object to which this plugin object connected.

getPrefix

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

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 would 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/' Unlike getElementNamespace, this function first returns the URI for this element by looking into the SBMLNamespaces object of the document with the its package name. If not found it will return the result of getElementNamespace

Returns:

the URI for this element

getVersion

int getVersion()

Returns:

See Also:

SBase.getVersion()

hashCode

int hashCode()

Overrides:

hashCode in class Object

Returns:

isSetExtendedSBase

boolean isSetExtendedSBase()

Check whether an extended SBase has been set.

Returns:

isSetPackageVersion

boolean isSetPackageVersion()

Returns:

true if a package version is set, false otherwise.

readAttribute

boolean readAttribute(String attributeName,
                    String prefix,
                    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)

Parameters:

packageVersion - the packageVersion to set

writeXMLAttributes

Map<String,String> writeXMLAttributes()

Returns a Map containing the XML attributes of this object.

Returns:

a Map containing the XML attributes of this object.