Package org.sbml.jsbml.ext.dyn

Class DynCompartmentPlugin

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.ext.AbstractSBasePlugin

org.sbml.jsbml.ext.dyn.DynSBasePlugin

org.sbml.jsbml.ext.dyn.DynCompartmentPlugin

All Implemented Interfaces:

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

public class DynCompartmentPlugin
extends DynSBasePlugin

Since:

1.0

Author:

Harold Gómez

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ListOf<SpatialComponent>	listOfSpatialComponents	List of spatial components which describe compartment in space

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

elementNamespace, extendedSBase, packageVersion

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, resourceBundle

Constructor Summary

Constructors

Constructor	Description
DynCompartmentPlugin()	Empty constructor
DynCompartmentPlugin(Compartment compartment)	Constructor
DynCompartmentPlugin(DynCompartmentPlugin dynCompartmentPlugin)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	addSpatialComponent(SpatialComponent spatialComponent)	Adds a new SpatialComponent to the ListOfSpatialComponents.
DynCompartmentPlugin	clone()
SpatialComponent	createSpatialComponent()	Creates a new SpatialComponent element and adds it to the listOfSpatialComponents list
SpatialComponent	createSpatialComponent(java.lang.String id)	Creates a new SpatialComponent element and adds it to the getListOfSpatialComponents()
boolean	equals(java.lang.Object obj)
boolean	getAllowsChildren()
javax.swing.tree.TreeNode	getChildAt(int childIndex)
int	getChildCount()
ListOf<SpatialComponent>	getListOfSpatialComponents()	Returns the value of listOfSpatialComponents
int	hashCode()
void	initDefaults()	Initializes custom Class attributes
boolean	isSetListOfSpatialComponents()	Returns whether listOfSpatialComponents is set
void	removeSpatialComponent(int i)	Removes the ith element from the ListOfSpatialComponents
boolean	removeSpatialComponent(SpatialComponent spatialComponent)	Removes an element from the ListOfSpatialComponents
void	setListOfSpatialComponents(ListOf<SpatialComponent> listOfSpatialComponents)	Sets the value of listOfSpatialComponents
boolean	unsetListOfSpatialComponents()	Unsets the variable listOfSpatialComponents

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

fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getElementNamespace, getExtendedSBase, getLevel, getPackageVersion, getSBMLDocument, getVersion, isSetExtendedSBase, isSetPackageVersion, removeFromParent, setExtendedSBase, setNamespace, setPackageVersion

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, isCloningInProgress, isInvalidSBMLAllowed, isLeaf, isReadingInProgress, isRoot, isSetParent, isSetUserObjects, notifyChildChange, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, toString, userObjectKeySet

Methods inherited from class org.sbml.jsbml.ext.dyn.DynSBasePlugin

getCBOTerm, getPackageName, getParent, getParentSBMLObject, getPrefix, getURI, isSetCBOTerm, readAttribute, setCBOTerm, unsetCBOTerm, writeXMLAttributes

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, isLeaf

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

Field Detail

listOfSpatialComponents

protected ListOf<SpatialComponent> listOfSpatialComponents

List of spatial components which describe compartment in space

Constructor Detail

DynCompartmentPlugin

public DynCompartmentPlugin()

Empty constructor

DynCompartmentPlugin

public DynCompartmentPlugin(Compartment compartment)

Constructor

Parameters:

compartment -

DynCompartmentPlugin

public DynCompartmentPlugin(DynCompartmentPlugin dynCompartmentPlugin)

Constructor

Parameters:

dynCompartmentPlugin -

Method Detail

initDefaults

public void initDefaults()

Initializes custom Class attributes

Overrides:

initDefaults in class DynSBasePlugin

getListOfSpatialComponents

public ListOf<SpatialComponent> getListOfSpatialComponents()

Returns the value of listOfSpatialComponents

Returns:

the value of listOfSpatialComponents

isSetListOfSpatialComponents

public boolean isSetListOfSpatialComponents()

Returns whether listOfSpatialComponents is set

Returns:

whether listOfSpatialComponents is set

setListOfSpatialComponents

public void setListOfSpatialComponents(ListOf<SpatialComponent> listOfSpatialComponents)

Sets the value of listOfSpatialComponents

Parameters:

listOfSpatialComponents -

unsetListOfSpatialComponents

public boolean unsetListOfSpatialComponents()

Unsets the variable listOfSpatialComponents

Returns:

true, if listOfSpatialComponents was set before, otherwise false

createSpatialComponent

public SpatialComponent createSpatialComponent()

Creates a new SpatialComponent element and adds it to the listOfSpatialComponents list

Returns:

createSpatialComponent

public SpatialComponent createSpatialComponent(java.lang.String id)

Creates a new SpatialComponent element and adds it to the getListOfSpatialComponents()

Parameters:

id -

Returns:

a new SpatialComponent element

addSpatialComponent

public boolean addSpatialComponent(SpatialComponent spatialComponent)

Adds a new SpatialComponent to the ListOfSpatialComponents. The ListOfSpatialComponents is initialized if necessary.

Parameters:

spatialComponent - the element to add to the list

Returns:

true (as specified by Collection.add(E))

removeSpatialComponent

public void removeSpatialComponent(int i)

Removes the ith element from the ListOfSpatialComponents

Parameters:

i -

removeSpatialComponent

public boolean removeSpatialComponent(SpatialComponent spatialComponent)

Removes an element from the ListOfSpatialComponents

Parameters:

spatialComponent - the element to be removed from the list

Returns:

true if the list contained the specified element

See Also:

List.remove(Object)

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface SBasePlugin

Overrides:

equals in class DynSBasePlugin

hashCode

public int hashCode()

Specified by:

hashCode in interface SBasePlugin

Overrides:

hashCode in class DynSBasePlugin

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface javax.swing.tree.TreeNode

Overrides:

getAllowsChildren in class DynSBasePlugin

getChildAt

public javax.swing.tree.TreeNode getChildAt(int childIndex)

Specified by:

getChildAt in interface javax.swing.tree.TreeNode

Overrides:

getChildAt in class DynSBasePlugin

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface javax.swing.tree.TreeNode

Overrides:

getChildCount in class DynSBasePlugin

clone

public DynCompartmentPlugin clone()

Specified by:

clone in interface SBasePlugin

Overrides:

clone in class DynSBasePlugin