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:

Serializable, Cloneable, 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

Version:

$Rev$

Author:

Nicolas Rodriguez, Andreas Dräger, Clemens Wrzodek

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ListOf<Layout>	listOfLayouts

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 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()
Layout	createLayout() Creates a new Layout and adds it to the current list of layouts.
Layout	createLayout(String id) Creates a new Layout and adds it to the current list of layouts.
boolean	equals(Object obj)
boolean	getAllowsChildren()
SBase	getChildAt(int index)
int	getChildCount()
String	getElementNamespace()
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.
String	getPackageName()
SBMLDocument	getParent()
SBMLDocument	getParentSBMLObject()
String	getPrefix()
String	getURI()
int	hashCode()
boolean	isSetListOfLayouts()
boolean	readAttribute(String attributeName, String prefix, String value)
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.
Map<String,String>	writeXMLAttributes()

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, isReadingInProgress, 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

listOfLayouts

protected ListOf<Layout> listOfLayouts

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(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(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 TreeNode

Overrides:

getParent in class AbstractTreeNode

getParentSBMLObject

public SBMLDocument getParentSBMLObject()

Specified by:

getParentSBMLObject in interface SBasePlugin

Overrides:

getParentSBMLObject in class AbstractSBasePlugin

isSetListOfLayouts

public boolean isSetListOfLayouts()

Returns:

readAttribute

public boolean readAttribute(String attributeName,
                             String prefix,
                             String value)

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 Map<String,String> writeXMLAttributes()

Specified by:

writeXMLAttributes in interface SBasePlugin

Overrides:

writeXMLAttributes in class AbstractSBasePlugin

clone

public LayoutModelPlugin clone()

Specified by:

clone in interface SBasePlugin

Overrides:

clone in class AbstractSBasePlugin

getElementNamespace

public String getElementNamespace()

Specified by:

getElementNamespace in interface SBasePlugin

Overrides:

getElementNamespace in class AbstractSBasePlugin

getPackageName

public String getPackageName()

getPrefix

public String getPrefix()

getURI

public String getURI()