org.sbml.jsbml.ext

Class AbstractSBasePlugin

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.ext.AbstractSBasePlugin

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractRenderPlugin, AbstractSpatialSBasePlugin, ArraysSBasePlugin, CompSBasePlugin, FBCModelPlugin, FBCSpeciesPlugin, GroupsModelPlugin, LayoutModelPlugin, MultiEventAssignment, MultiInitialAssignment, MultiModel, MultiReaction, MultiRule, MultiSpecies, MultiSpeciesReference, QualModelPlugin, ReqSBasePlugin

public abstract class AbstractSBasePlugin
extends AbstractTreeNode
implements SBasePlugin

Since:

1.0

Version:

$Rev: 1960 $

Author:

Andreas Dräger, Florian Mittag

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected SBase	extendedSBase
protected int	packageVersion
private static long	serialVersionUID Generated serial version identifier.

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
AbstractSBasePlugin()
AbstractSBasePlugin(AbstractSBasePlugin plugin) This method will need to be further tested
AbstractSBasePlugin(SBase extendedSBase)

Method Summary

Methods

Modifier and Type	Method and Description
abstract AbstractSBasePlugin	clone() Creates a new instance of SBasePlugin from this SBasePlugin.
boolean	equals(java.lang.Object object)
void	fireNodeAddedEvent() All TreeNodeChangeListener instances linked to this TreeNode are informed about the adding of this Object to an owning parent Object.
void	fireNodeRemovedEvent() All TreeNodeChangeListener instances linked to this TreeNode are informed about the deletion of this TreeNode from a parent Object.
void	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue) All TreeNodeChangeListeners are informed about the change in this TreeNodeWithChangeSupport.
SBase	getExtendedSBase() Returns the SBase object that is extended by this plug-in.
int	getLevel()
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.
SBMLDocument	getSBMLDocument() Returns the parent SBMLDocument of this plugin object.
int	getVersion()
int	hashCode()
boolean	isSetExtendedSBase() Check whether an extended SBase has been set.
boolean	removeFromParent() This method is designed to be overridden for non-independent child nodes
void	setExtendedSBase(SBase extendedSBase) Sets the extended SBase.
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes() Returns a Map containing the XML attributes of this object.

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getParent, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isLeaf, isRoot, isSetParent, isSetUserObjects, notifyChildChange, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, toString, userObjectKeySet

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.ext.SBasePlugin

getElementNamespace, getPackageName, getPrefix, getURI, readAttribute

Methods inherited from interface org.sbml.jsbml.util.TreeNodeWithChangeSupport

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

extendedSBase

protected SBase extendedSBase

packageVersion

protected int packageVersion

Constructor Detail

AbstractSBasePlugin

public AbstractSBasePlugin()

AbstractSBasePlugin

public AbstractSBasePlugin(SBase extendedSBase)

Parameters:

extendedSBase -

AbstractSBasePlugin

public AbstractSBasePlugin(AbstractSBasePlugin plugin)

This method will need to be further tested

Parameters:

plugin -

Method Detail

getLevel

public int getLevel()

Specified by:

getLevel in interface SBasePlugin

Returns:

See Also:

SBase.getLevel()

getVersion

public int getVersion()

Specified by:

getVersion in interface SBasePlugin

Returns:

See Also:

SBase.getVersion()

getExtendedSBase

public SBase getExtendedSBase()

Description copied from interface: SBasePlugin

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

Specified by:

getExtendedSBase in interface SBasePlugin

Returns:

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

clone

public abstract AbstractSBasePlugin clone()

Description copied from interface: SBasePlugin

Creates a new instance of SBasePlugin from this SBasePlugin.

Specified by:

clone in interface SBasePlugin

Specified by:

clone in class AbstractTreeNode

Returns:

a new instance of SBasePlugin from this SBasePlugin.

equals

public boolean equals(java.lang.Object object)

Specified by:

equals in interface SBasePlugin

Overrides:

equals in class AbstractTreeNode

isSetExtendedSBase

public boolean isSetExtendedSBase()

Description copied from interface: SBasePlugin

Check whether an extended SBase has been set.

Specified by:

isSetExtendedSBase in interface SBasePlugin

Returns:

hashCode

public int hashCode()

Specified by:

hashCode in interface SBasePlugin

Overrides:

hashCode in class AbstractTreeNode

getPackageVersion

public int getPackageVersion()

Description copied from interface: SBasePlugin

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

Specified by:

getPackageVersion in interface SBasePlugin

Returns:

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

getParentSBMLObject

public SBase getParentSBMLObject()

Description copied from interface: SBasePlugin

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

Specified by:

getParentSBMLObject in interface SBasePlugin

Returns:

the parent SBase object to which this plugin object connected.

getSBMLDocument

public SBMLDocument getSBMLDocument()

Description copied from interface: SBasePlugin

Returns the parent SBMLDocument of this plugin object.

Specified by:

getSBMLDocument in interface SBasePlugin

Returns:

the parent SBMLDocument object of this plugin object.

fireNodeAddedEvent

public void fireNodeAddedEvent()

Description copied from interface: TreeNodeWithChangeSupport

All TreeNodeChangeListener instances linked to this TreeNode are informed about the adding of this Object to an owning parent Object.

Specified by:

fireNodeAddedEvent in interface TreeNodeWithChangeSupport

Overrides:

fireNodeAddedEvent in class AbstractTreeNode

fireNodeRemovedEvent

public void fireNodeRemovedEvent()

Description copied from interface: TreeNodeWithChangeSupport

All TreeNodeChangeListener instances linked to this TreeNode are informed about the deletion of this TreeNode from a parent Object.

Specified by:

fireNodeRemovedEvent in interface TreeNodeWithChangeSupport

Overrides:

fireNodeRemovedEvent in class AbstractTreeNode

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                      java.lang.Object oldValue,
                      java.lang.Object newValue)

Description copied from interface: TreeNodeWithChangeSupport

All TreeNodeChangeListeners are informed about the change in this TreeNodeWithChangeSupport.

Specified by:

firePropertyChange in interface TreeNodeWithChangeSupport

Overrides:

firePropertyChange in class AbstractTreeNode

Parameters:

propertyName - Tells the TreeNodeChangeListener the name of the property whose value has been changed.

oldValue - This is the value before the change.

newValue - This gives the new value that is now the new value for the given property..

setExtendedSBase

public void setExtendedSBase(SBase extendedSBase)

Sets the extended SBase.

This method should not be called in general but it is necessary to use it after cloning an SBasePlugin to be able to set properly the new parent/extended SBase.

Parameters:

extendedSBase -

removeFromParent

public boolean removeFromParent()

Description copied from class: AbstractTreeNode

This method is designed to be overridden for non-independent child nodes

Specified by:

removeFromParent in interface TreeNodeWithChangeSupport

Overrides:

removeFromParent in class AbstractTreeNode

Returns:

false if this element is a root node, true otherwise.

See Also:

TreeNodeWithChangeSupport.removeFromParent()

writeXMLAttributes

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

Description copied from interface: SBasePlugin

Returns a Map containing the XML attributes of this object.

Specified by:

writeXMLAttributes in interface SBasePlugin

Returns:

a Map containing the XML attributes of this object.