org.sbml.libsbml

Class CompBase

java.lang.Object

org.sbml.libsbml.SBase

org.sbml.libsbml.CompBase

Direct Known Subclasses:

ExternalModelDefinition, SBaseRef, Submodel

public class CompBase
extends SBase

comp A convenience subclass of &ldquocomp&rdquo package SBase-derived classes

The CompBase class derives from SBase, and defines a few functions and features common to all SBase-derived classes in the SBML Level 3 'Hierarchical Model Composition' package (&ldquocomp&rdquo).

Method Summary

Methods

Modifier and Type	Method and Description
void	delete() Explicitly deletes the underlying native object.
java.lang.String	getPackageName() Returns the package name of this plugin object.
java.lang.String	getPackageURI() Returns the XML namespace (URI) of the package extension of this object.
long	getPackageVersion() Returns the package version of the package extension of this plugin object.
static Model	getParentModel(SBase child) Returns the Model object to which the referenced child object belongs.

Methods inherited from class org.sbml.libsbml.SBase

addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, cloneObject, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getElementByMetaId, getElementBySId, getElementName, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getTypeCode, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isSetAnnotation, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetId, unsetMetaId, unsetModelHistory, unsetName, unsetNotes, unsetSBOTerm

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

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

Overrides:

delete in class SBase

getPackageName

public java.lang.String getPackageName()

Returns the package name of this plugin object.

Overrides:

getPackageName in class SBase

Returns:

the package name of this plugin object.

getPackageURI

public java.lang.String getPackageURI()

Returns the XML namespace (URI) of the package extension of this object.

Returns:

the URI of the package extension of this plugin object.

getPackageVersion

public long getPackageVersion()

Returns the package version of the package extension of this plugin object.

Overrides:

getPackageVersion in class SBase

Returns:

the package version of the package extension of this plugin object.

See Also:

SBase.getLevel(), SBase.getVersion()

getParentModel

public static Model getParentModel(SBase child)

Returns the Model object to which the referenced child object belongs.