org.sbml.jsbml.ext.spatial

Class SpatialCompartmentPlugin

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.ext.AbstractSBasePlugin

org.sbml.jsbml.ext.spatial.AbstractSpatialSBasePlugin

org.sbml.jsbml.ext.spatial.SpatialCompartmentPlugin

All Implemented Interfaces:

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

public class SpatialCompartmentPlugin
extends AbstractSpatialSBasePlugin

Since:

1.0

Version:

$Rev: 1724 $

Author:

Alex Thomas, Andreas Dräger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private CompartmentMapping	compartmentMapping
private static long	serialVersionUID Generated serial version identifier.

Fields inherited from class org.sbml.jsbml.ext.AbstractSBasePlugin

extendedSBase, packageVersion

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
SpatialCompartmentPlugin()
SpatialCompartmentPlugin(Compartment compartment)
SpatialCompartmentPlugin(SpatialCompartmentPlugin spatialCompartmentPlugin)

Method Summary

Methods

Modifier and Type	Method and Description
SpatialCompartmentPlugin	clone() Creates a new instance of SBasePlugin from this SBasePlugin.
boolean	getAllowsChildren()
CompartmentMapping	getChildAt(int index)
int	getChildCount()
CompartmentMapping	getCompartmentMapping() Returns the value of compartmentMapping
Compartment	getExtendedSBase() Returns the SBase object that is extended by this plug-in.
ListOf<Compartment>	getParent()
ListOf<Compartment>	getParentSBMLObject() Returns the parent SBase object to which this plugin object connected.
boolean	isSetCompartmentMapping() Returns whether compartmentMapping is set
void	setCompartmentMapping(CompartmentMapping compartmentMapping) Sets the value of compartmentMapping
boolean	unsetCompartmentMapping() Unsets the variable compartmentMapping

Methods inherited from class org.sbml.jsbml.ext.spatial.AbstractSpatialSBasePlugin

getElementNamespace, getModel, getPackageName, getPrefix, getURI, readAttribute, writeXMLAttributes

Methods inherited from class org.sbml.jsbml.ext.AbstractSBasePlugin

equals, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getLevel, getPackageVersion, getSBMLDocument, getVersion, hashCode, isSetExtendedSBase, removeFromParent, setExtendedSBase

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, 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.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, getIndex, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

compartmentMapping

private CompartmentMapping compartmentMapping

Constructor Detail

SpatialCompartmentPlugin

public SpatialCompartmentPlugin()

SpatialCompartmentPlugin

public SpatialCompartmentPlugin(Compartment compartment)

Parameters:

compartment -

SpatialCompartmentPlugin

public SpatialCompartmentPlugin(SpatialCompartmentPlugin spatialCompartmentPlugin)

Parameters:

spatialCompartmentPlugin -

Method Detail

getParent

public ListOf<Compartment> getParent()

Specified by:

getParent in interface javax.swing.tree.TreeNode

Overrides:

getParent in class AbstractSpatialSBasePlugin

getParentSBMLObject

public ListOf<Compartment> getParentSBMLObject()

Description copied from interface: SBasePlugin

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

Specified by:

getParentSBMLObject in interface SBasePlugin

Overrides:

getParentSBMLObject in class AbstractSpatialSBasePlugin

Returns:

the parent SBase object to which this plugin object connected.

getExtendedSBase

public Compartment getExtendedSBase()

Description copied from interface: SBasePlugin

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

Specified by:

getExtendedSBase in interface SBasePlugin

Overrides:

getExtendedSBase in class AbstractSBasePlugin

Returns:

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

clone

public SpatialCompartmentPlugin 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 AbstractSBasePlugin

Returns:

a new instance of SBasePlugin from this SBasePlugin.

getCompartmentMapping

public CompartmentMapping getCompartmentMapping()

Returns the value of compartmentMapping

Returns:

the value of compartmentMapping

isSetCompartmentMapping

public boolean isSetCompartmentMapping()

Returns whether compartmentMapping is set

Returns:

whether compartmentMapping is set

setCompartmentMapping

public void setCompartmentMapping(CompartmentMapping compartmentMapping)

Sets the value of compartmentMapping

unsetCompartmentMapping

public boolean unsetCompartmentMapping()

Unsets the variable compartmentMapping

Returns:

true, if compartmentMapping was set before, otherwise false

getAllowsChildren

public boolean getAllowsChildren()

getChildCount

public int getChildCount()

getChildAt

public CompartmentMapping getChildAt(int index)