public class CompExtension extends SBMLExtension
This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. This class is not prescribed by the SBML specifications, although it is used to implement features defined in SBML.
Constructor and Description |
---|
CompExtension()
Creates a new
CompExtension instance. |
CompExtension(CompExtension source)
Copy constructor.
|
Modifier and Type | Method and Description |
---|---|
SBMLExtension |
cloneObject()
Creates and returns a deep copy of this
CompExtension object. |
void |
delete()
Explicitly deletes the underlying native object.
|
static long |
getDefaultLevel()
Returns the default SBML Level used by this libSBML package extension.
|
static long |
getDefaultPackageVersion()
Returns the default version of the SBML Level 3 package implemented
by this libSBML extension.
|
static long |
getDefaultVersion()
Returns the default SBML Version used by this libSBML package 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 as a short-form label
("
comp "). |
static java.lang.String |
getPackageName()
Returns the nickname of the SBML Level 3 package implemented by
this libSBML extension.
|
long |
getPackageVersion(java.lang.String uri)
Returns the SBML Level 3 package version for the given URI of this
package.
|
SBMLNamespaces |
getSBMLExtensionNamespaces(java.lang.String uri)
Returns an
CompPkgNamespaces object. |
java.lang.String |
getStringFromTypeCode(int typeCode)
Takes a type code of the &ldquocomp&rdquo package and returns a string
describing the code.
|
java.lang.String |
getURI(long sbmlLevel,
long sbmlVersion,
long pkgVersion)
Returns a string representing the SBML XML namespace of this SBML
Level 3 package.
|
long |
getVersion(java.lang.String uri)
Returns the Version within the SBML Level for the given URI of this
package.
|
static java.lang.String |
getXmlnsL3V1V1()
Returns the XML namespace URI of the SBML Level 3 package
implemented by this libSBML extension.
|
getNumOfSBasePlugins, getNumOfSupportedPackageURI, getSupportedPackageURI, isEnabled, isInUse, isSupported, setEnabled
public CompExtension()
CompExtension
instance.public CompExtension(CompExtension source)
source
- 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 CompExtension.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 CompExtension.delete()
themselves.
delete
 in class SBMLExtension
public static java.lang.String getPackageName()
public static long getDefaultLevel()
public static long getDefaultVersion()
public static long getDefaultPackageVersion()
public static java.lang.String getXmlnsL3V1V1()
public SBMLExtension cloneObject()
CompExtension
object.
cloneObject
 in class SBMLExtension
CompExtension
object.public java.lang.String getName()
comp
").
getName
 in class SBMLExtension
public java.lang.String getURI(long sbmlLevel, long sbmlVersion, long pkgVersion)
The namespace URI constructed by this method corresponds to the
combination of the Level and Version of SBML, and the Version of the SBML
Level 3 package. (At the time of this writing, the only SBML Level
that supports packages is Level 3, so the value of sbmlLevel
must
necessarily always be 3
.)
getURI
 in class SBMLExtension
sbmlLevel
- the level of SBML.sbmlVersion
- the version of SBML.pkgVersion
- the version of the package.
public long getLevel(java.lang.String uri)
getLevel
 in class SBMLExtension
uri
- a URI that represents a version of this package.
0
if the
given URI is invalid, or for a different package.public long getVersion(java.lang.String uri)
getVersion
 in class SBMLExtension
uri
- a URI that represents a version of this package.
0
if the given URI is invalid, or for a different package.public long getPackageVersion(java.lang.String uri)
getPackageVersion
 in class SBMLExtension
uri
- a URI that represents one of the valid versions of this
package.
0
if the given URI is invalid, or for a different package.public SBMLNamespaces getSBMLExtensionNamespaces(java.lang.String uri)
CompPkgNamespaces
object.
getSBMLExtensionNamespaces
 in class SBMLExtension
uri
- a URI that represents one of the valid versions of the
&ldquocomp&rdquo package.
uri
, or
null
if the URI is not defined in the Hierarchical Model Composition
package.public java.lang.String getStringFromTypeCode(int typeCode)
getStringFromTypeCode
 in class SBMLExtension
typeCode
- a libSBML type code defined by the libSBML extension
implementing support for the SBML Level 3 &ldquocomp&rdquo package.
typeCode
.
If the type code is unrecognized for this implementation of the libSBML
&ldquocomp&rdquo package, the string returned will be
'(Unknown SBML Comp Type)'
.