org.sbml.libsbml

Class FbcPkgNamespaces

java.lang.Object

org.sbml.libsbml.FbcPkgNamespaces

public class FbcPkgNamespaces
extends java.lang.Object

fbc Class to store SBML Level, Version, and XML namespace for the SBML Flux Balance Constraints (“fbc”) 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.

SBML Level 3 “packages” add features on top of SBML Level 3 Core. When a model definition uses an SBML package, it must declare the Level and Version of SBML Core and the Version of the package being used. The package name, the SBML Level and Version, and the package Version correspond uniquely to an XML namespace added to the XML encoding of the SBML model.

LibSBML Level 3 extensions are implementations of support for SBML Level 3 packages. Each package is implemented as a separate extension. To allow software applications to query the level and version information of an extension's package implementation, libSBML uses specialized object classes. For the extension implementing the SBML “fbc” package, the object class is FbcPkgNamespaces. (This class is a specialization of a common base class called SBMLExtensionNamespaces that is not exposed in the libSBML programming language interfaces other than C++.)

Objects of class FbcPkgNamespaces can be passed to constructors of SBML components defined by “fbc” in order to ensure that the correct component structure is created. This is necessary because different versions of an SBML Level 3 package may introduce differences in the definition of the components defined by the package. (For example, later editions of a package may introduce new attributes on a component that are not present in earlier editions of the package specification.)

See Also:

CompPkgNamespaces, LayoutPkgNamespaces, QualPkgNamespaces

Constructor Summary

Constructors

Constructor and Description
FbcPkgNamespaces() Creates a new FbcPkgNamespaces object.

Method Summary

Modifier and Type	Method and Description
FbcPkgNamespaces	cloneObject() Creates and returns a deep copy of this FbcPkgNamespaces.
void	delete() Explicitly deletes the underlying native object.
java.lang.String	getPackageName() Returns the short-form name or label for the package.
long	getPackageVersion() Returns the package's version number.
java.lang.String	getURI() Returns a string representing the package's XML namespace.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FbcPkgNamespaces

public FbcPkgNamespaces()

Creates a new FbcPkgNamespaces object.

Warning:

Note that the internal implementation of the list nodes uses C++ objects. If callers use this constructor to create the list object deliberately, those objects are in a sense "owned" by the caller when this constructor is used. Callers need to remember to call FbcPkgNamespaces.delete() on this list object after it is no longer needed or risk leaking memory.

Method Detail

cloneObject

public FbcPkgNamespaces cloneObject()

Creates and returns a deep copy of this FbcPkgNamespaces.

Returns:

a (deep) copy of this FbcPkgNamespaces.

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 FbcPkgNamespaces.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 FbcPkgNamespaces.delete() themselves.

getURI

public java.lang.String getURI()

Returns a string representing the package's XML namespace.

Returns:

a string representing the XML namespace that reflects the SBML Level and Version, and the package Version.

getPackageVersion

public long getPackageVersion()

Returns the package's version number.

Returns:

an integer, the version number for the SBML Level 3 Flux Balance Constraints package implemented by the libSBML extension.

getPackageName

public java.lang.String getPackageName()

Returns the short-form name or label for the package.

Returns:

the short-form name of the SBML Level 3 package, which in this case, will be “fbc”.