public class GroupsExtension 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.
This is the Groups package extension of the SBMLExtension
class that
every libSBML plug-in must implement in order to implement an
SBML Level 3 package.
Constructor and Description |
---|
GroupsExtension()
Creates a new
GroupsExtension instance. |
GroupsExtension(GroupsExtension orig)
Copy constructor for
GroupsExtension . |
Modifier and Type | Method and Description |
---|---|
GroupsExtension |
cloneObject()
Creates and returns a deep copy of this
GroupsExtension 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
|
static long |
getDefaultLevel()
Returns the default SBML Level implemented by this libSBML 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 implemented by this libSBML 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 SBML Level 3 package ('groups').
|
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 a
GroupsPkgNamespaces object. |
java.lang.String |
getStringFromTypeCode(int typeCode)
Returns a string describing the type code of the &ldquogroups&rdquo
package.
|
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 GroupsExtension()
GroupsExtension
instance.public GroupsExtension(GroupsExtension orig)
GroupsExtension
.
orig
- the GroupsExtension
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 GroupsExtension.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 GroupsExtension.delete()
themselves.
delete
 in class SBMLExtension
public SBasePlugin DowncastSBasePlugin(long cPtr, boolean owner)
SBMLExtension
DowncastSBasePlugin
 in class SBMLExtension
public SBase DowncastSBase(long cPtr, boolean owner)
SBMLExtension
DowncastSBase
 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 GroupsExtension cloneObject()
GroupsExtension
object.
cloneObject
 in class SBMLExtension
GroupsExtension
object.public java.lang.String getName()
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 this package.
public long getLevel(java.lang.String uri)
getLevel
 in class SBMLExtension
uri
- the string of the URI that represents one of the versions of
the 'groups' 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
- the string of the URI that represents one of the versions of
the 'groups' 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
- the string of the URI that represents one of the versions of
the 'groups' package.
0
if the given URI is invalid, or for a different package.public SBMLNamespaces getSBMLExtensionNamespaces(java.lang.String uri)
GroupsPkgNamespaces
object.
getSBMLExtensionNamespaces
 in class SBMLExtension
uri
- the string of the URI that represents one of the versions of
the 'groups' package.
GroupsPkgNamespaces
object corresponding to the given URI of this
package, or null
if the given URI is not defined in the 'groups'
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 &ldquogroups&rdquo
package.
typeCode
. If
the type code is unrecognized for this implementation of the libSBML
&ldquogroups&rdquo package, the string returned will be '(Unknown
SBML Groups Type)'
.