public class LayoutExtension extends SBMLExtension
Constructor and Description |
---|
LayoutExtension()
Constructor
|
LayoutExtension(LayoutExtension arg0)
Copy constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addL2Namespaces(XMLNamespaces xmlns)
adds all L2 Extension namespaces to the namespace list.
|
LayoutExtension |
cloneObject()
Creates and returns a deep copy of this
LayoutExtension object. |
void |
delete()
Explicitly deletes the underlying native object.
|
SBase |
DowncastSBase(long cPtr,
boolean owner)
SBMLExtension derived classes must override this method
|
SBasePlugin |
DowncastSBasePlugin(long cPtr,
boolean owner)
SBMLExtension derived classes must override this method
|
void |
enableL2NamespaceForDocument(SBMLDocument doc)
Adds the L2 Namespace to the document and enables the extension.
|
static long |
getDefaultLevel()
Returns the default SBML Level this extension.
|
static long |
getDefaultPackageVersion()
Returns the default SBML version this extension.
|
static long |
getDefaultVersion()
Returns the default SBML Version this extension.
|
long |
getLevel(java.lang.String uri)
Returns the SBML Level for the given URI of this package.
|
java.lang.String |
getName()
Returns the name of this package ('layout')
|
static java.lang.String |
getPackageName()
Returns the package name of this extension.
|
long |
getPackageVersion(java.lang.String uri)
Returns the package version for the given URI of this package.
|
SBMLNamespaces |
getSBMLExtensionNamespaces(java.lang.String uri)
Returns an
LayoutPkgNamespaces object. |
java.lang.String |
getStringFromTypeCode(int typeCode)
Takes a type code of the &ldquolayout&rdquo package and returns a string
describing the code.
|
java.lang.String |
getURI(long sbmlLevel,
long sbmlVersion,
long pkgVersion)
Returns the namespace URI corresponding to the combination of the given
SBML Level, Version, and package version.
|
long |
getVersion(java.lang.String uri)
Returns the SBML Version for the given URI of this package.
|
static java.lang.String |
getXmlnsL2()   |
static java.lang.String |
getXmlnsL3V1V1()
Returns URI of supported versions of this package.
|
static java.lang.String |
getXmlnsXSI()   |
boolean |
isInUse(SBMLDocument doc)
Determines whether this extension is being used by the given
SBMLDocument |
void |
removeL2Namespaces(XMLNamespaces xmlns)
Removes the L2 Namespace from a document.
|
getCategory, getErrorIdOffset, getMessage, getNumOfSBasePlugins, getNumOfSupportedPackageURI, getSeverity, getShortMessage, getSupportedPackageURI, isEnabled, isSupported, setEnabled
public LayoutExtension()
public LayoutExtension(LayoutExtension arg0)
public void addL2Namespaces(XMLNamespaces xmlns)
This method should be overridden by all extensions that want to serialize to an L2 annotation.
addL2Namespaces
 in class SBMLExtension
public LayoutExtension cloneObject()
LayoutExtension
object.
cloneObject
 in class SBMLExtension
LayoutExtension
objectpublic 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 LayoutExtension.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 LayoutExtension.delete()
themselves.
delete
 in class SBMLExtension
public SBase DowncastSBase(long cPtr, boolean owner)
DowncastSBase
 in class SBMLExtension
public SBasePlugin DowncastSBasePlugin(long cPtr, boolean owner)
SBMLExtension
DowncastSBasePlugin
 in class SBMLExtension
public void enableL2NamespaceForDocument(SBMLDocument doc)
If the extension supports serialization to SBML L2 Annotations, this method should be overrridden, so it will be activated.
enableL2NamespaceForDocument
 in class SBMLExtension
public static long getDefaultLevel()
public static long getDefaultPackageVersion()
public static long getDefaultVersion()
public long getLevel(java.lang.String uri)
getLevel
 in class SBMLExtension
uri
- the string of URI that represents one of versions of the
&ldquolayout&rdquo package
0
if
the given URI is invalid.public java.lang.String getName()
getName
 in class SBMLExtension
public static java.lang.String getPackageName()
public long getPackageVersion(java.lang.String uri)
getPackageVersion
 in class SBMLExtension
uri
- the string of URI that represents one of versions of the
&ldquolayout&rdquo package
0
if the given URI is invalid.public SBMLNamespaces getSBMLExtensionNamespaces(java.lang.String uri)
LayoutPkgNamespaces
object.
getSBMLExtensionNamespaces
 in class SBMLExtension
uri
- the string of URI that represents one of versions of the
&ldquolayout&rdquo package
uri
,
or null
if the URI is not defined in the Layout
package.public java.lang.String getStringFromTypeCode(int typeCode)
getStringFromTypeCode
 in class SBMLExtension
public java.lang.String getURI(long sbmlLevel, long sbmlVersion, long pkgVersion)
getURI
 in class SBMLExtension
sbmlLevel
- the level of SBMLsbmlVersion
- the version of SBMLpkgVersion
- the version of package
public long getVersion(java.lang.String uri)
getVersion
 in class SBMLExtension
uri
- the string of URI that represents one of versions of the
&ldquolayout&rdquo package
0
if
the given URI is invalid.public static java.lang.String getXmlnsL2()
public static java.lang.String getXmlnsL3V1V1()
public static java.lang.String getXmlnsXSI()
public boolean isInUse(SBMLDocument doc)
SBMLDocument
The implementation returns true if the model object contains one or more layouts.
isInUse
 in class SBMLExtension
doc
- the sbml document to test.
public void removeL2Namespaces(XMLNamespaces xmlns)
This method should be overridden by all extensions that want to serialize to an L2 annotation.
removeL2Namespaces
 in class SBMLExtension