org.sbml.jsbml.ext.layout

Class LayoutModelPlugin

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.ext.AbstractSBasePlugin

org.sbml.jsbml.ext.layout.LayoutModelPlugin

All Implemented Interfaces:

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

public class LayoutModelPlugin
extends AbstractSBasePlugin

The Layout package extends the Model class with the addition of one child element: the listOfLayouts. A Model may contain at most one such list, but the list itself can hold many different Layouts.

Since:

1.0

Author:

Nicolas Rodriguez, Andreas Dräger, Clemens Wrzodek

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LayoutModelPlugin(LayoutModelPlugin elm) Creates a new instance LayoutModelPlugin cloned from the given LayoutModelPlugin.
LayoutModelPlugin(Model model) Creates a new instance LayoutModelPlugin associate it with the given Model.

Method Summary

Modifier and Type	Method and Description
void	add(Layout layout) Adds the given Layout to the listOfLayouts.
void	addLayout(Layout layout) Adds the given Layout to the listOfLayouts.
LayoutModelPlugin	clone() Creates a new instance of SBasePlugin from this SBasePlugin.
Layout	createLayout() Creates a new Layout and adds it to the current list of layouts.
Layout	createLayout(java.lang.String id) Creates a new Layout and adds it to the current list of layouts.
boolean	equals(java.lang.Object obj)
boolean	getAllowsChildren()
SBase	getChildAt(int index)
int	getChildCount()
java.lang.String	getElementNamespace() Returns the XML namespace (URI) of the package extension of this plugin object.
Layout	getLayout(int i)
int	getLayoutCount() Returns the number of Layouts of this LayoutModelPlugin.
ListOf<Layout>	getListOfLayouts()
Model	getModel()
int	getNumLayouts() Returns the number of Layouts of this LayoutModelPlugin.
java.lang.String	getPackageName() Returns the package name of this plugin object.
SBMLDocument	getParent()
SBMLDocument	getParentSBMLObject() Returns the parent SBase object to which this plugin object connected.
java.lang.String	getPrefix() Returns the prefix of the package extension of this plugin object.
java.lang.String	getURI() Gets the URI to which this element belongs to.
int	hashCode()
boolean	isSetListOfLayouts()
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	setListOfLayouts(ListOf<Layout> listOfLayouts) The listOfLayouts element must contain at least one Layout.
boolean	unsetListOfLayouts() Removes the listOfLayouts from this Model and notifies all registered instances of TreeNodeChangeListener.
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.ext.AbstractSBasePlugin

fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, 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, isLeaf, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, toString, userObjectKeySet

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutModelPlugin

public LayoutModelPlugin(LayoutModelPlugin elm)

Creates a new instance LayoutModelPlugin cloned from the given LayoutModelPlugin.

Parameters:

elm - the LayoutModelPlugin we want to clone.

LayoutModelPlugin

public LayoutModelPlugin(Model model)

Creates a new instance LayoutModelPlugin associate it with the given Model.

Parameters:

model - the Model where this LayoutModelPlugin belong.

Method Detail

add

public void add(Layout layout)

Adds the given Layout to the listOfLayouts.

The listOfLayouts is initialized if necessary.

Parameters:

layout - the Layout instance to add.

See Also:

addLayout(Layout)

addLayout

public void addLayout(Layout layout)

Adds the given Layout to the listOfLayouts.

The listOfLayouts is initialized if necessary.

Parameters:

layout - the Layout instance to add.

createLayout

public Layout createLayout()

Creates a new Layout and adds it to the current list of layouts.

Returns:

the new Layout.

createLayout

public Layout createLayout(java.lang.String id)

Creates a new Layout and adds it to the current list of layouts.

Parameters:

id - the id to be set in the new Layout.

Returns:

the new Layout.

hashCode

public int hashCode()

Specified by:

hashCode in interface SBasePlugin

Overrides:

hashCode in class AbstractSBasePlugin

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface SBasePlugin

Overrides:

equals in class AbstractSBasePlugin

getAllowsChildren

public boolean getAllowsChildren()

getChildAt

public SBase getChildAt(int index)

getChildCount

public int getChildCount()

getLayout

public Layout getLayout(int i)

Parameters:

i -

Returns:

getLayoutCount

public int getLayoutCount()

Returns the number of Layouts of this LayoutModelPlugin.

Returns:

the number of Layouts of this LayoutModelPlugin.

getListOfLayouts

public ListOf<Layout> getListOfLayouts()

Returns:

getModel

public Model getModel()

Returns:

getNumLayouts

public int getNumLayouts()

Returns the number of Layouts of this LayoutModelPlugin.

Returns:

the number of Layouts of this LayoutModelPlugin.

Note: this method is kept here as it exist in libSBML.

same as getLayoutCount()

getParent

public SBMLDocument getParent()

Specified by:

getParent in interface javax.swing.tree.TreeNode

Overrides:

getParent in class AbstractTreeNode

getParentSBMLObject

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

Returns:

the parent SBase object to which this plugin object connected.

isSetListOfLayouts

public boolean isSetListOfLayouts()

Returns:

readAttribute

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

Description copied from interface: SBasePlugin

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.

setListOfLayouts

public void setListOfLayouts(ListOf<Layout> listOfLayouts)

The listOfLayouts element must contain at least one Layout.

Parameters:

listOfLayouts -

unsetListOfLayouts

public boolean unsetListOfLayouts()

Removes the listOfLayouts from this Model and notifies all registered instances of TreeNodeChangeListener.

Returns:

true if calling this method lead to a change in this data structure.

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

Overrides:

writeXMLAttributes in class AbstractSBasePlugin

Returns:

a Map containing the XML attributes of this object.

clone

public LayoutModelPlugin 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.

getElementNamespace

public java.lang.String getElementNamespace()

Description copied from interface: SBasePlugin

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

Specified by:

getElementNamespace in interface SBasePlugin

Overrides:

getElementNamespace in class AbstractSBasePlugin

Returns:

the URI of the package extension of this plugin object.

See Also:

SBasePlugin.getURI()

getPackageName

public java.lang.String getPackageName()

Description copied from interface: SBasePlugin

Returns the package name of this plugin object.

Returns:

the package name of this plugin object.

getPrefix

public java.lang.String getPrefix()

Description copied from interface: SBasePlugin

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

Returns:

the prefix of the package extension of this plugin object.

getURI

public java.lang.String getURI()

Description copied from interface: SBasePlugin

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 have the URI 'http://www.sbml.org/sbml/level3/version1/layout/version1/'

Returns:

the URI for this element

See Also:

SBasePlugin.getElementNamespace()