libsbmlcs.SBMLResolverRegistry Class Reference

Inheritance diagram for libsbmlcs.SBMLResolverRegistry:

Detailed Description

{comp}

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
int	addResolver (SBMLResolver resolver)
	Adds the given resolver to the registry of SBML resolvers. More...
virtual void	Dispose ()
int	getNumResolvers ()
	Returns the number of resolvers known by the registry. More...
SBMLResolver	getResolverByIndex (int index)
	Returns the resolver with the given index number. More...
int	removeResolver (int index)
	Removes the resolver with the given index. More...
SBMLDocument	resolve (string uri, string baseUri)
	Resolves the document for the given URI. More...
SBMLDocument	resolve (string uri)
	Resolves the document for the given URI. More...
SBMLUri	resolveUri (string uri, string baseUri)
	Resolves the full URI for the given URI without actually reading the document. More...
SBMLUri	resolveUri (string uri)
	Resolves the full URI for the given URI without actually reading the document. More...

Static Public Member Functions
static SBMLResolverRegistry	getInstance ()
	Returns the singleton instance for the resolver registry. More...

Protected Attributes
bool	swigCMemOwn

Member Function Documentation

int libsbmlcs.SBMLResolverRegistry.addResolver

(

SBMLResolver

resolver

)

Adds the given resolver to the registry of SBML resolvers.

Parameters

resolver

the resolver to add to the registry.

Returns

integer value indicating the success/failure of the operation. The possible values are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_OBJECT

virtual void libsbmlcs.SBMLResolverRegistry.Dispose ( )

virtual

static SBMLResolverRegistry libsbmlcs.SBMLResolverRegistry.getInstance ( )

static

Returns the singleton instance for the resolver registry.

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.

int libsbmlcs.SBMLResolverRegistry.getNumResolvers

(

)

Returns the number of resolvers known by the registry.

Returns

the number of registered resolvers.

See also

getResolverByIndex()

SBMLResolver libsbmlcs.SBMLResolverRegistry.getResolverByIndex

(

int

index

)

Returns the resolver with the given index number.

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 null if the number is less than 0 or there is no resolver at the given index position.

int libsbmlcs.SBMLResolverRegistry.removeResolver

(

int

index

)

Removes the resolver with the given index.

Parameters

index

the index of the resolver to be removed

Returns

integer value indicating the success/failure of the operation. The possible values are:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_OBJECT

SBMLDocument libsbmlcs.SBMLResolverRegistry.resolve	(	string	uri,
		string	baseUri
	)

Resolves the document for the given URI.

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

SBMLDocument libsbmlcs.SBMLResolverRegistry.resolve

(

string

uri

)

Resolves the document for the given URI.

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

SBMLUri libsbmlcs.SBMLResolverRegistry.resolveUri	(	string	uri,
		string	baseUri
	)

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

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

SBMLUri libsbmlcs.SBMLResolverRegistry.resolveUri

(

string

uri

)

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

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

Member Data Documentation

bool libsbmlcs.SBMLResolverRegistry.swigCMemOwn

protected