libsbmlcs.SBMLUri Class Reference

Inheritance diagram for libsbmlcs.SBMLUri:

Detailed Description

{comp}

comp utility class for handling URIs.

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.

This class implements functionality for parsing URIs and extracting information about them.

See also

SBMLResolver

SBMLFileResolver

Public Member Functions
SBMLUri	clone ()
	Creates and returns a deep copy of this SBMLUri object. More...
virtual void	Dispose ()
string	getHost ()
	Returns the host portion of the stored URI. More...
string	getPath ()
	Returns the path and filename portion of the stored URI. More...
string	getQuery ()
	Returns the query portion of the stored URI. More...
string	getScheme ()
	Returns the scheme of the stored URI. More...
string	getUri ()
	Returns the full stored URI, after replacing backslashes with slashes. More...
SBMLUri	relativeTo (string uri)
	Constructs a new URI relative to this object and the given URI. More...
	SBMLUri (string uri)
	Creates a new SBMLUri from the given string URI. More...
	SBMLUri (SBMLUri orig)
	Copy constructor. More...

Protected Attributes
bool	swigCMemOwn

Constructor & Destructor Documentation

libsbmlcs.SBMLUri.SBMLUri

(

string

uri

)

Creates a new SBMLUri from the given string URI.

libsbmlcs.SBMLUri.SBMLUri

(

SBMLUri

orig

)

Copy constructor.

Creates a copy of an SBMLUri object.

Parameters

orig	the SBMLUri object to copy.

Exceptions

SBMLConstructorException

Thrown if the argument orig is null.

Member Function Documentation

SBMLUri libsbmlcs.SBMLUri.clone

(

)

Creates and returns a deep copy of this SBMLUri object.

Returns

a (deep) copy of this SBMLFileResolver object.

virtual void libsbmlcs.SBMLUri.Dispose ( )

virtual

string libsbmlcs.SBMLUri.getHost

(

)

Returns the host portion of the stored URI.

For a scheme such as 'http', this method returns the part of the URI after 'http://' and before the next '/' character. URIs with file or URN schemes have no host; in that case, this method returns an empty string.

Returns

the host of the URI, or an empty string in the case of files or URNs schemes that do not possess a host portion.

string libsbmlcs.SBMLUri.getPath

(

)

Returns the path and filename portion of the stored URI.

This method returns the text after the scheme, colon, and host (if present), and before the next '?' character. The result may be an empty string for some URIs.

Returns

the path of the URI (i.e., the full filename with path)

string libsbmlcs.SBMLUri.getQuery

(

)

Returns the query portion of the stored URI.

The equery portion of a URI is the text after a filename, starting with the character '?'. For many URIs, this is an empty string.

Returns

the query of the URI (i.e., the part after the full filename with path)

string libsbmlcs.SBMLUri.getScheme

(

)

Returns the scheme of the stored URI.

The scheme of the URI is the text before the first colon character. Typical examples of what this might return are the strings 'file' or 'http'. If the current URI does not have a scheme, this method returns an empty string.

Returns

the parsed scheme, such as 'http', or an empty string if no scheme exists for the current URI.

string libsbmlcs.SBMLUri.getUri

(

)

Returns the full stored URI, after replacing backslashes with slashes.

Returns

the original URI, with backslashes replaced with slashes.

SBMLUri libsbmlcs.SBMLUri.relativeTo

(

string

uri

)

Constructs a new URI relative to this object and the given URI.

For example,

SBMLUri('c:\test').relativeTo('test.xml')

would construct a new file URI, with path c:/test/test.xml.

Parameters

uri	a URI to be added to this object

Returns

the resulting new URI

Member Data Documentation

bool libsbmlcs.SBMLUri.swigCMemOwn

protected