Constructor Detail

• QualExtension

  public QualExtension()

  Creates a new QualExtension instance.

• QualExtension

  public QualExtension(QualExtension orig)

  Copy constructor.

  Parameters:

  orig - the 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 QualExtension.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 QualExtension.delete() themselves.

  Overrides:

  delete 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 used by this libSBML package extension.

  Returns:

  the SBML Level.

• getDefaultVersion

  public static long getDefaultVersion()

  Returns the default SBML Version used by this libSBML package extension.

  Returns:

  the Version within the default SBML Level.

• 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.

• 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 QualExtension cloneObject()

  Creates and returns a deep copy of this QualExtension object.

  Overrides:

  cloneObject in class SBMLExtension

  Returns:

  a (deep) copy of this SBase object.

• getName

  public java.lang.String getName()

  Returns the name of this package ('qual')

  Overrides:

  getName in class SBMLExtension

  Returns:

  a string representing the name of this package ('qual').

• 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.

  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.)

  Overrides:

  getURI in class SBMLExtension

  Parameters:

  sbmlLevel - the level of SBML.

  sbmlVersion - the version of SBML.

  pkgVersion - the version of the package.

  Returns:

  a string of the package URI, or an empty string if no corresponding URI exists.

• 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 - a URI that represents a version of this 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 - a URI that represents a version of this 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 - a URI that represents one of the valid versions of this package.

  Returns:

  the version of the SBML Level 3 package with the given URI, or 0 if the given URI is invalid, or for a different package.

• getSBMLExtensionNamespaces

  public SBMLNamespaces getSBMLExtensionNamespaces(java.lang.String uri)

  Returns an QualPkgNamespaces object.

  Overrides:

  getSBMLExtensionNamespaces in class SBMLExtension

  Parameters:

  uri - a URI that represents one of the valid versions of the &ldquoqual&rdquo package.

  Returns:

  an QualPkgNamespace object corresponding to the given uri, or null if the URI is not defined in the Qual package.

• getStringFromTypeCode

  public java.lang.String getStringFromTypeCode(int typeCode)

  Takes a type code of the &ldquoqual&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 &ldquoqual&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 &ldquoqual&rdquo package, the string returned will be '(Unknown SBML Qual Type)'.