libsbml.SBMLResolverRegistry Class Reference

Inheritance diagram for libsbml.SBMLResolverRegistry:

Detailed Description

comp Registry of all SBML resolvers.

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.

LibSBML provides facilities for resolving SBML documents in various ways from a given URI. Resolvers are implemented as objects derived from the class SBMLResolver.

The resolver registry maintains a list of known resolvers and provides methods for discovering them. It is implemented as a singleton object of class SBMLResolverRegistry. Callers can use the method SBMLResolverRegistry.getNumResolvers() to find out how many resolvers are registered, then use SBMLResolverRegistry.getResolverByIndex() to iterate over each one;

See also

SBMLFileResolver

Public Member Functions
def	addOwnedSBMLDocument (self, doc)
	Adds the given SBMLDocument to the registry of SBML documents that will need to be deleted. More...
def	addResolver (self, resolver)
	Adds the given resolver to the registry of SBML resolvers. More...
def	deleteResolerRegistryInstance ()
def	getInstance ()
	Returns the singleton instance for the resolver registry. More...
def	getNumResolvers (self)
	Returns the number of resolvers known by the registry. More...
def	getResolverByIndex (self, index)
	Returns the resolver with the given index number. More...
def	removeResolver (self, index)
	Removes the resolver with the given index. More...
def	resolve (self, args)
	Resolves the document for the given URI. More...
def	resolveUri (self, args)
	Resolves the full URI for the given URI without actually reading the document. More...

Member Function Documentation

def libsbml.SBMLResolverRegistry.addOwnedSBMLDocument	(		self,
			doc
	)

Adds the given SBMLDocument to the registry of SBML documents that will need to be deleted.

addOwnedSBMLDocument(SBMLDocument doc)   int

When calculating reference cycles, sometimes we need SBML Documents to persist, but nobody else owns them directly. We hand them to the registry here so they can be cleaned up

Parameters

doc	the SBML Document to add to the registry.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_OBJECT

def libsbml.SBMLResolverRegistry.addResolver	(		self,
			resolver
	)

Adds the given resolver to the registry of SBML resolvers.

addResolver(SBMLResolver resolver)   int

Parameters

resolver

the resolver to add to the registry.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_OBJECT

def libsbml.SBMLResolverRegistry.deleteResolerRegistryInstance

(

)

deleteResolerRegistryInstance()

deletes the static resolver registry instance

def libsbml.SBMLResolverRegistry.getInstance

(

)

Returns the singleton instance for the resolver registry.

getInstance()   SBMLResolverRegistry

Prior to using the registry, callers have to obtain a copy of the registry. This static method provides the means for doing that.

Returns

the singleton for the resolver registry.

def libsbml.SBMLResolverRegistry.getNumResolvers

(

self

)

Returns the number of resolvers known by the registry.

getNumResolvers()   int

Returns

the number of registered resolvers.

See also

getResolverByIndex()

def libsbml.SBMLResolverRegistry.getResolverByIndex	(		self,
			index
	)

Returns the resolver with the given index number.

getResolverByIndex(int index)   SBMLResolver

Resolvers are given arbitrary index numbers by the registry. Callers can use the method SBMLResolverRegistry.getNumResolvers() to find out how many resolvers are registered, then use this method to iterate over the list and obtain each one in turn.

Parameters

index

the zero-based index of the resolver to fetch.

Returns

the resolver with the given index number, or None if the number is less than 0 or there is no resolver at the given index position.

def libsbml.SBMLResolverRegistry.removeResolver	(		self,
			index
	)

Removes the resolver with the given index.

removeResolver(int index)   int

Parameters

index

the index of the resolver to be removed.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_OBJECT

def libsbml.SBMLResolverRegistry.resolve	(		self,
			args
	)

Resolves the document for the given URI.

resolve(string uri, string baseUri)   SBMLDocument
resolve(string uri)   SBMLDocument

Parameters

uri	the URI to the target document.
baseUri	base URI, in case the URI is a relative one.

Returns

the document, if this resolver can resolve the document or None.

def libsbml.SBMLResolverRegistry.resolveUri	(		self,
			args
	)

Resolves the full URI for the given URI without actually reading the document.

resolveUri(string uri, string baseUri)   SBMLUri
resolveUri(string uri)   SBMLUri

Parameters

uri	the URI to the target document.
baseUri	base URI, in case the URI is a relative one.

Returns

the full URI to the document, if this resolver can resolve the document or None.