public class SBMLResolver extends java.lang.Object
This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. It is a class used in the implementation of extra functionality provided by libSBML.
The SBMLResolver
class is the base class for the various SBML
resolvers: facilities that take a unique identifier as input and return
the document associated with that identifier. In SBML, resolvers come
into play with the SBML Level 3 Hierarchical Model Composition
package this package includes features that allow a model to be composed
from pieces that are external to a given SBML document, which implies the
need to be able to identify and locate those external pieces. The
SBMLResolver
class and its subclasses provide facilities for software
applications to be able to do these tasks.
LibSBML provides a number of built-in resolvers, and applications can
create their own by subclassing SBMLResolver
and following the examples
of the existing resolvers. The following are the built-in resolvers
in libSBML 5.12.0
:
More resolvers may be provided by libSBML in the future. Application authors may also write their own.
SBMLUri
Constructor and Description |
---|
SBMLResolver()
Creates a new
SBMLResolver object. |
SBMLResolver(SBMLResolver c)
Copy constructor.
|
Modifier and Type | Method and Description |
---|---|
SBMLResolver |
cloneObject()
Creates and returns a deep copy of this
SBMLResolver object. |
void |
delete()
Explicitly deletes the underlying native object.
|
SBMLDocument |
resolve(java.lang.String uri)
Resolves the document for the given URI.
|
SBMLDocument |
resolve(java.lang.String uri,
java.lang.String baseUri)
Resolves the document for the given URI.
|
SBMLUri |
resolveUri(java.lang.String uri)
Resolves the full URI for the given URI without actually reading the
document.
|
SBMLUri |
resolveUri(java.lang.String uri,
java.lang.String baseUri)
Resolves the full URI for the given URI without actually reading the
document.
|
public SBMLResolver()
SBMLResolver
object.public SBMLResolver(SBMLResolver c)
SBMLResolver
object.
c
- the SBMLResolver
object 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 SBMLResolver.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 SBMLResolver.delete()
themselves.
public SBMLResolver cloneObject()
SBMLResolver
object.
SBMLResolver
object.public SBMLDocument resolve(java.lang.String uri, java.lang.String baseUri)
uri
- the URI to the target documentbaseUri
- base URI, in case the URI is a relative one
public SBMLDocument resolve(java.lang.String uri)
uri
- the URI to the target documentbaseUri
- base URI, in case the URI is a relative one
public SBMLUri resolveUri(java.lang.String uri, java.lang.String baseUri)
uri
- the URI to the target documentbaseUri
- base URI, in case the URI is a relative one
public SBMLUri resolveUri(java.lang.String uri)
uri
- the URI to the target documentbaseUri
- base URI, in case the URI is a relative one