public class LayoutModelPlugin extends SBasePlugin
Constructor and Description |
---|
LayoutModelPlugin(LayoutModelPlugin orig)
Copy constructor.
|
LayoutModelPlugin(java.lang.String uri,
java.lang.String prefix,
LayoutPkgNamespaces layoutns)
Creates a new
LayoutModelPlugin object using the given parameters. |
Modifier and Type | Method and Description |
---|---|
int |
addLayout(Layout layout)
Adds a copy of the layout object to the list of layouts.
|
SBasePlugin |
cloneObject()
Creates and returns a deep copy of this
LayoutModelPlugin object. |
Layout |
createLayout()
Creates a new layout object and adds it to the list of layout objects
and returns it.
|
void |
delete()
Explicitly deletes the underlying native object.
|
Layout |
getLayout(long index)
Returns the layout object that belongs to the given index.
|
Layout |
getLayout(java.lang.String sid)
Returns the layout object with the given
sid attribute. |
ListOfLayouts |
getListOfLayouts()
Returns the
ListOfLayouts object for this Model . |
int |
getNumLayouts()
Returns the number of layout objects.
|
Layout |
removeLayout(long n)
|
getElementByMetaId, getElementBySId, getElementNamespace, getLevel, getListOfAllElements, getListOfAllElements, getPackageName, getPackageVersion, getParentSBMLObject, getPrefix, getSBMLDocument, getURI, getVersion, isValidTypeForList, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, setElementNamespace
public LayoutModelPlugin(java.lang.String uri, java.lang.String prefix, LayoutPkgNamespaces layoutns)
LayoutModelPlugin
object using the given parameters.
In the XML representation of an SBML document, XML namespaces are used to
identify the origin of each XML construct used. XML namespaces are
identified by their unique resource identifiers (URIs). The core SBML
specifications stipulate the namespaces that must be used for core SBML
constructs for example, all XML elements that belong to SBML Level 3
Version 1 Core must be placed in the XML namespace identified by the URI
'http://www.sbml.org/sbml/level3/version1/core'
. Individual
SBML Level 3 packages define their own XML namespaces for example,
all elements belonging to the SBML Level 3 Layout Version 1
package must be placed in the XML namespace
'http://www.sbml.org/sbml/level3/version1/layout/version1/'
.
The SBMLNamespaces
object encapsulates SBML Level/Version/namespaces
information. It is used to communicate the SBML Level, Version, and (in
Level 3) packages used in addition to SBML Level 3 Core. A
common approach to using libSBML's SBMLNamespaces
facilities is to create an
SBMLNamespaces
object somewhere in a program once, then hand that object
as needed to object constructors that accept SBMLNamespaces
as arguments.
uri
- the URI of the SBML Level 3 package implemented by
this libSBML package extension.
prefix
- the XML namespace prefix being used for the package.
layoutns
- the namespaces object for the package.public LayoutModelPlugin(LayoutModelPlugin orig)
SBase
object.
orig
- the instance to copy.public void delete()
In general, application software will not need to call this method directly. The Java language binding for libSBML is implemented as a language wrapper that provides a Java interface to libSBML's underlying C++/C code. Some of the Java methods return objects that are linked to objects created not by Java code, but by C++ code. The Java objects wrapped around them will be deleted when the garbage collector invokes the corresponding C++ finalize()
methods for the objects. The finalize()
methods in turn call the LayoutModelPlugin.delete()
method on the libSBML object.
This method is exposed in case calling programs want to ensure that the underlying object is freed immediately, and not at some arbitrary time determined by the Java garbage collector. In normal usage, callers do not need to invoke LayoutModelPlugin.delete()
themselves.
delete
 in class SBasePlugin
public SBasePlugin cloneObject()
LayoutModelPlugin
object.
cloneObject
 in class SBasePlugin
LayoutModelPlugin
object.public ListOfLayouts getListOfLayouts()
ListOfLayouts
object for this Model
.
ListOfLayouts
object for this Model
.public Layout getLayout(long index)
null
is returned.
index
- the index of list of layout objects.
Layout
object that belongs to the given index. null
is returned if the index is invalid.public Layout getLayout(java.lang.String sid)
sid
attribute. If the
id is invalid, null
is returned.
sid
- the id attribute of the layout object.
Layout
object with the given sid
attribute. null
is returned if the given sid
is invalid.public int addLayout(Layout layout)
layout
- the layout object to be added.
public Layout createLayout()
public Layout removeLayout(long n)
public int getNumLayouts()