libsbmlcs.SBMLFileResolver Class Reference

Inheritance diagram for libsbmlcs.SBMLFileResolver:

Detailed Description

{comp}

comp A resolver for documents stored on a file system.

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.

In SBML, resolvers come into play with the SBML Level 3 Hierarchical Model Composition package (“comp”); 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 identifiers used in “comp” are URIs (Uniform Resource Identifiers).

SBMLFileResolver is a class implementing the ability to resolve URIs to files. It works on the local file system only. It can resolve relative and absolute paths, and directories to be searched can be specified using the methods SBMLFileResolver::addAdditionalDir() and SBMLFileResolver::clearAdditionalDirs().

See also

SBMLResolver

SBMLUri

Public Member Functions
void	addAdditionalDir (string dir)
	Adds a directory to the list of directories to search for files to resolve. More...
void	clearAdditionalDirs ()
	Removes the list of directories to search for files to resolve. More...
SBMLResolver	clone ()
	Creates and returns a deep copy of this SBMLFileResolver object. More...
override void	Dispose ()
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 a given URI without actually reading the document. More...
SBMLUri	resolveUri (string uri)
	Resolves the full URI for a given URI without actually reading the document. More...
	SBMLFileResolver ()
	Creates a new SBMLFileResolver object. More...
	SBMLFileResolver (SBMLFileResolver c)
	Copy constructor. More...

Protected Attributes
bool	swigCMemOwn

Constructor & Destructor Documentation

libsbmlcs.SBMLFileResolver.SBMLFileResolver

(

)

Creates a new SBMLFileResolver object.

libsbmlcs.SBMLFileResolver.SBMLFileResolver

(

SBMLFileResolver

c

)

Copy constructor.

Creates a copy of an SBMLFileResolver object.

Parameters

c	the SBMLFileResolver object to copy.

Exceptions

SBMLConstructorException

Thrown if the argument orig is null.

Member Function Documentation

void libsbmlcs.SBMLFileResolver.addAdditionalDir

(

string

dir

)

Adds a directory to the list of directories to search for files to resolve.

Parameters

dir	the directory to add.

See also

clearAdditionalDirs()

void libsbmlcs.SBMLFileResolver.clearAdditionalDirs

(

)

Removes the list of directories to search for files to resolve.

After this method is called, SBMLFileResolver::resolve(string uri, string baseUri) will only search absolute or relative directories. New directories can be added using SBMLFileResolver::addAdditionalDir().

See also

addAdditionalDir()

SBMLResolver libsbmlcs.SBMLFileResolver.clone

(

)

Creates and returns a deep copy of this SBMLFileResolver object.

Returns

a (deep) copy of this SBMLFileResolver object.

override void libsbmlcs.SBMLFileResolver.Dispose ( )

virtual

Reimplemented from libsbmlcs.SBMLResolver.

SBMLDocument libsbmlcs.SBMLFileResolver.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.SBMLFileResolver.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.SBMLFileResolver.resolveUri	(	string	uri,
		string	baseUri
	)

Resolves the full URI for a 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.SBMLFileResolver.resolveUri

(

string

uri

)

Resolves the full URI for a 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.SBMLResolver.swigCMemOwn

protectedinherited