libsbml.XMLTriple Class Reference

Inheritance diagram for libsbml.XMLTriple:

Detailed Description

A qualified XML name.

This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. This class is not prescribed by the SBML specifications, although it is used to implement features defined in SBML.

A 'triple' in the libSBML XML layer encapsulates the notion of qualified name, meaning an element name or an attribute name with an optional namespace qualifier. Triples by themselves are not entities in an XML stream—they are not, for example, elements or attributes; rather, XMLTriple is used in libSBML to construct these other kinds of objects.

An XMLTriple instance carries up to three data items:

1. The name of the attribute or element; that is, the attribute name as it appears in an XML document or data stream;
2. The XML namespace prefix (if any) of the attribute. For example, in the following fragment of XML, the namespace prefix is the string mysim and it appears on both the element someelement and the attribute attribA. When both the element and the attribute are stored as XMLTriple objects, their prefix is mysim.

   <mysim:someelement mysim:attribA='value' />
   

3. The XML namespace URI with which the prefix is associated. In XML, every namespace used must be declared and mapped to a URI.

XMLTriple objects are the lowest-level data item in the XML layer of libSBML. Other objects such as XMLToken make use of XMLTriple objects.

See also

XMLToken

XMLNode

XMLAttributes

XMLNamespaces

Public Member Functions
def	__init__ (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...
def	clone (self)
	Creates and returns a deep copy of this XMLTriple object. More...
def	getName (self)
	Returns the name portion of this XMLTriple object. More...
def	getPrefix (self)
	Returns the prefix portion of this XMLTriple object. More...
def	getPrefixedName (self)
	Returns the prefixed name from this XMLTriple. More...
def	getURI (self)
	Returns the URI portion of this XMLTriple object. More...
def	isEmpty (self)
	Returns True if this XMLTriple object is empty. More...

Constructor & Destructor Documentation

def libsbml.XMLTriple.__init__	(		self,
			args
	)

This method has multiple variants; they differ in the arguments they accept.

__init__()   XMLTriple
__init__(string name, string uri, string prefix)   XMLTriple
__init__(string triplet, char  sepchar)   XMLTriple
__init__(string triplet)   XMLTriple
__init__(XMLTriple orig)   XMLTriple

Each variant is described separately below.

---

Method variant with the following signature:

XMLTriple(string name, string uri, string prefix)

Creates a new XMLTriple object with a given name, uri and and prefix.

Parameters

name	a string, the name for the entity represented by this object.
uri	a string, the XML namespace URI associated with the prefix.
prefix	a string, the XML namespace prefix for this triple.

---

Method variant with the following signature:

XMLTriple(string triplet, char sepchar = ' ')

Creates an XMLTriple object by splitting a given string at a given separator character.

The 'triplet' in this case is a string that may be in one of the following three possible formats:

1. name
2. URIxname
3. URIxnamexprefix

where x represents the separator character, sepchar.

Parameters

triplet	a string representing the triplet as shown above.
sepchar	a character, the sepchar used in the triplet.

Note

Owing to the way that language interfaces are created in libSBML, this documentation may show methods that define default values for parameters with text that has the form parameter = value. This is not to be intepreted as a Python keyword argument; the use of a parameter name followed by an equals sign followed by a value is only meant to indicate a default value if the argument is not provided at all. It is not a keyword in the Python sense.

---

Method variant with the following signature:

XMLTriple()

Creates a new, empty XMLTriple object.

---

Method variant with the following signature:

XMLTriple(XMLTriple orig)

Copy constructor; creates a copy of this XMLTriple object.

Parameters

orig	the XMLTriple object to copy.

Member Function Documentation

def libsbml.XMLTriple.clone

(

self

)

Creates and returns a deep copy of this XMLTriple object.

clone()   XMLTriple

Returns

the (deep) copy of this XMLTriple object.

def libsbml.XMLTriple.getName

(

self

)

Returns the name portion of this XMLTriple object.

getName()   string

Returns

a string, the name portion of this XMLTriple object.

def libsbml.XMLTriple.getPrefix

(

self

)

Returns the prefix portion of this XMLTriple object.

getPrefix()   string

Returns

a string, the prefix portion of this XMLTriple object.

def libsbml.XMLTriple.getPrefixedName

(

self

)

Returns the prefixed name from this XMLTriple.

getPrefixedName()   string

Returns

a string, the prefixed name from this XMLTriple. This is constructed by concatenating the prefix stored in this XMLTriple object, followed by a colon character ':', followed by the name stored in this XMLTriple object.

def libsbml.XMLTriple.getURI

(

self

)

Returns the URI portion of this XMLTriple object.

getURI()   string

Returns

URI a string, the URI portion of this XMLTriple object.

def libsbml.XMLTriple.isEmpty

(

self

)

Returns True if this XMLTriple object is empty.

isEmpty()   bool

Returns

True if this XMLTriple is empty, False otherwise.