libSBML Python API  5.10.0
 All Classes Namespaces Files Functions Variables Modules Pages
libsbml.SBMLUri Class Reference
Inheritance diagram for libsbml.SBMLUri:
[legend]

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

def clone
 
def getHost
 
def getPath
 
def getQuery
 
def getScheme
 
def getUri
 
def relativeTo
 

Member Function Documentation

def libsbml.SBMLUri.clone (   self)

{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 Python method signature(s):
clone(SBMLUri self)   SBMLUri

Creates and returns a deep copy of this SBMLUri object.

Returns
a (deep) copy of this SBMLFileResolver object.
def libsbml.SBMLUri.getHost (   self)

Python method signature(s):

getHost(SBMLUri self)   string

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.
def libsbml.SBMLUri.getPath (   self)

Python method signature(s):

getPath(SBMLUri self)   string

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)
def libsbml.SBMLUri.getQuery (   self)

Python method signature(s):

getQuery(SBMLUri self)   string

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)
def libsbml.SBMLUri.getScheme (   self)

Python method signature(s):

getScheme(SBMLUri self)   string

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.
def libsbml.SBMLUri.getUri (   self)

Python method signature(s):

getUri(SBMLUri self)   string

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

Returns
the original URI, with backslashes replaced with slashes.
def libsbml.SBMLUri.relativeTo (   self,
  args 
)

Python method signature(s):

relativeTo(SBMLUri self, string uri)   SBMLUri

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
uria URI to be added to this object
Returns
the resulting new URI