GroupsExtension (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.SBMLExtension
- - org.sbml.libsbml.GroupsExtension

```
public class GroupsExtension
extends SBMLExtension
```
groups Base extension class for the package.

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 is used to facilitate libSBML plug-ins in the implementation of an SBMLLevel 3 package.

Constructor Summary

Constructors
Constructor and Description

GroupsExtension()
Creates a new GroupsExtension instance.

GroupsExtension(GroupsExtension orig)
Copy constructor for GroupsExtension.

Constructors
Constructor and Description
`GroupsExtension()` Creates a new `GroupsExtension` instance.
`GroupsExtension(GroupsExtension orig)` Copy constructor for `GroupsExtension`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)` Takes a type code of the &ldquogroups&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.

Methods inherited from class org.sbml.libsbml.SBMLExtension
getNumOfSBasePlugins, getNumOfSupportedPackageURI, getSupportedPackageURI, isEnabled, isInUse, isSupported, setEnabled

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GroupsExtension
```
public GroupsExtension()
```
    Creates a new GroupsExtension instance.
  - GroupsExtension
```
public GroupsExtension(GroupsExtension orig)
```
    Copy constructor for GroupsExtension.
    
    Parameters:
    
    orig - the GroupsExtension instance to copy.
- Method Detail
  - delete
```
public void delete()
```
    Explicitly deletes the underlying native object.
    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.
    
    Overrides:
    
    delete in class SBMLExtension
  - DowncastSBasePlugin
```
public SBasePlugin DowncastSBasePlugin(long cPtr,
                                       boolean owner)
```
    Description copied from class: SBMLExtension
    
    SBMLExtension derived classes must override this method
    
    Overrides:
    
    DowncastSBasePlugin in class SBMLExtension
  - DowncastSBase
```
public SBase DowncastSBase(long cPtr,
                           boolean owner)
```
    Description copied from class: SBMLExtension
    
    SBMLExtension derived classes must override this method
    
    Overrides:
    
    DowncastSBase in class SBMLExtension
  - getPackageName
```
public static java.lang.String getPackageName()
```
    Returns the nickname of the SBML Level 3 package implemented by this libSBML extension.
    
    Returns:
    
    the package nickname, as a string.
  - getDefaultLevel
```
public static long getDefaultLevel()
```
    Returns the default SBML Level implemented by this libSBML extension.
    
    Returns:
    
    the SBML Level, as a long integereger.
  - getDefaultVersion
```
public static long getDefaultVersion()
```
    Returns the default SBML Version implemented by this libSBML extension.
    
    Returns:
    
    the Version within the default SBML Level, as a long integereger.
  - getDefaultPackageVersion
```
public static long getDefaultPackageVersion()
```
    Returns the default version of the SBML Level 3 package implemented by this libSBML extension.
    
    Returns:
    
    the default version number of the SBML Level 3 package definition, as a long integereger.
  - getXmlnsL3V1V1
```
public static java.lang.String getXmlnsL3V1V1()
```
    Returns the XML namespace URI of the SBML Level 3 package implemented by this libSBML extension.
    
    Returns:
    
    the XML namespace, as a string.
  - cloneObject
```
public GroupsExtension cloneObject()
```
    Creates and returns a deep copy of this GroupsExtension object.
    
    Overrides:
    
    cloneObject in class SBMLExtension
    
    Returns:
    
    a (deep) copy of this GroupsExtension object.
  - getName
```
public java.lang.String getName()
```
    Returns the name of this SBML Level 3 package ('groups').
    
    Overrides:
    
    getName in class SBMLExtension
    
    Returns:
    
    a string representing the name of this package ('groups').
  - getURI
```
public java.lang.String getURI(long sbmlLevel,
                               long sbmlVersion,
                               long pkgVersion)
```
    Returns a string representing the SBML XML namespace of this SBML Level 3 package.
    
    Overrides:
    
    getURI in class SBMLExtension
    
    Parameters:
    
    sbmlLevel - the level of SBML.
    
    sbmlVersion - the version of SBML.
    
    pkgVersion - the version of this package.
    
    Returns:
    
    a string representing the name of this package ('groups').
    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 is necessarily always 3.)
  - getLevel
```
public long getLevel(java.lang.String uri)
```
    Returns the SBML Level for the given URI of this package.
    
    Overrides:
    
    getLevel in class SBMLExtension
    
    Parameters:
    
    uri - the string of the URI that represents one of the versions of the 'groups' package.
    
    Returns:
    
    the SBML Level for the given URI of this package, or 0 if the given URI is invalid, or for a different package.
  - getVersion
```
public long getVersion(java.lang.String uri)
```
    Returns the Version within the SBML Level for the given URI of this package.
    
    Overrides:
    
    getVersion in class SBMLExtension
    
    Parameters:
    
    uri - the string of the URI that represents one of the versions of the 'groups' package.
    
    Returns:
    
    the SBML Version within the SBML Level for the given URI of this package, or 0 if the given URI is invalid, or for a different package.
  - getPackageVersion
```
public long getPackageVersion(java.lang.String uri)
```
    Returns the SBML Level 3 package version for the given URI of this package.
    
    Overrides:
    
    getPackageVersion in class SBMLExtension
    
    Parameters:
    
    uri - the string of the URI that represents one of the versions of the 'groups' package.
    
    Returns:
    
    the version of the SBML Level 3 package for the given URI of this package, or 0 if the given URI is invalid, or for a different package.
  - getSBMLExtensionNamespaces
```
public SBMLNamespaces getSBMLExtensionNamespaces(java.lang.String uri)
```
    Returns a GroupsPkgNamespaces object.
    
    Overrides:
    
    getSBMLExtensionNamespaces in class SBMLExtension
    
    Parameters:
    
    uri - the string of the URI that represents one of the versions of the 'groups' package.
    
    Returns:
    
    GroupsPkgNamespaces object corresponding to the given URI of this package, or null if the given URI is not defined in the 'groups' package.
  - getStringFromTypeCode
```
public java.lang.String getStringFromTypeCode(int typeCode)
```
    Takes a type code of the &ldquogroups&rdquo package and returns a string describing the code.
    
    Overrides:
    
    getStringFromTypeCode in class SBMLExtension
    
    Parameters:
    
    typeCode - a libSBML type code defined by the libSBML extension implementing support for the SBML Level 3 &ldquogroups&rdquo package.
    
    Returns:
    
    a text string representing the type code given by 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)'.

Class GroupsExtension

Constructor Summary

Method Summary

Methods inherited from class org.sbml.libsbml.SBMLExtension

Methods inherited from class java.lang.Object

Constructor Detail

GroupsExtension

GroupsExtension

Method Detail

delete

DowncastSBasePlugin

DowncastSBase

getPackageName

getDefaultLevel

getDefaultVersion

getDefaultPackageVersion

getXmlnsL3V1V1

cloneObject

getName

getURI

getLevel

getVersion

getPackageVersion

getSBMLExtensionNamespaces

getStringFromTypeCode