Inheritance diagram for libsbml.XMLNode:

Detailed Description

A node in libSBML's XML document tree.

LibSBML implements an XML abstraction layer. This layer presents a uniform XML interface to calling programs regardless of which underlying XML parser libSBML has actually been configured to use. The basic data object in the XML abstraction is a node, represented by XMLNode.

An XMLNode can contain any number of children. Each child is another XMLNode, thereby forming a tree. The methods XMLNode.getNumChildren() and XMLNode.getChild() can be used to access the tree structure starting from a given node.

Each XMLNode is subclassed from XMLToken, and thus has the same methods available as XMLToken. These methods include XMLToken.getNamespaces(), XMLToken.getPrefix(), XMLToken.getName(), XMLToken.getURI(), and XMLToken.getAttributes().

Conversion between an XML string and an XMLNode

LibSBML provides the following utility functions for converting an XML string (e.g., <annotation>...</annotation>) to/from an XMLNode object.

XMLNode.toXMLString() returns a string representation of the XMLNode object.

XMLNode.convertXMLNodeToString() (static function) returns a string representation of the given XMLNode object.

XMLNode.convertStringToXMLNode() (static function) returns an XMLNode object converted from the given XML string.

The returned XMLNode object by XMLNode.convertStringToXMLNode() is a dummy root (container) XMLNode if the given XML string has two or more top-level elements (e.g., "<p>...</p><p>...</p>"). In the dummy root node, each top-level element in the given XML string is contained as a child XMLNode. XMLToken.isEOF() can be used to identify if the returned XMLNode object is a dummy node or not. Here is an example:

 xn = XMLNode.convertStringToXMLNode('<p></p>')
 if xn == None:
   # Do something to handle exceptional situation.
 
 elif xn.isEOF():
   # Node is a dummy node.
 
 else:
   # None is not a dummy node.

Public Member Functions
def	__init__ (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	addAttr (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	addChild (self, node)
	Adds a copy of `node` as a child of this XMLNode. More...

def	addNamespace (self, args)
	Appends an XML namespace declaration to this token. More...

def	append (self, chars)
	Appends characters to the text content of token. More...

def	clearAttributes (self)
	Removes all attributes of this XMLToken object. More...

def	clearNamespaces (self)
	Removes all XML namespace declarations from this token. More...

def	clone (self)
	Creates and returns a deep copy of this XMLNode object. More...

def	convertStringToXMLNode (xmlstr, xmlns=None)
	Returns an XMLNode which is derived from a string containing XML content. More...

def	convertXMLNodeToString (node)
	Returns a string representation of a given XMLNode. More...

def	equals (self, other, ignoreURI=False, ignoreAttributeValues=False)
	Compare this XMLNode against another XMLNode returning true if both nodes represent the same XML tree, or false otherwise. More...

def	getAttributes (self)
	Returns the attributes of the XML element represented by this token. More...

def	getAttributesLength (self)
	Returns the number of attributes on this XMLToken object. More...

def	getAttrIndex (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getAttrName (self, index)
	Returns the name of the nth attribute in this token's list of attributes. More...

def	getAttrPrefix (self, index)
	Returns the prefix of the nth attribute in this token's list of attributes. More...

def	getAttrPrefixedName (self, index)
	Returns the prefixed name of the nth attribute in this token's list of attributes. More...

def	getAttrURI (self, index)
	Returns the XML namespace URI of the nth attribute in this token's list of attributes. More...

def	getAttrValue (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getCharacters (self)
	Returns the character text of token. More...

def	getChild (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getColumn (self)
	Returns the column number at which this token occurs in the input. More...

def	getIndex (self, name)
	Return the index of the first child of this XMLNode with the given name. More...

def	getLine (self)
	Returns the line number at which this token occurs in the input. More...

def	getName (self)
	Returns the (unqualified) name of token. More...

def	getNamespaceIndex (self, uri)
	Returns the index of an XML namespace declaration based on its URI. More...

def	getNamespaceIndexByPrefix (self, prefix)
	Returns the index of an XML namespace declaration based on its prefix. More...

def	getNamespacePrefix (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getNamespaces (self)
	Returns the XML namespaces declared for this token. More...

def	getNamespacesLength (self)
	Returns the number of XML namespaces declared on this token. More...

def	getNamespaceURI (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getNumChildren (self)
	Returns the number of children for this XMLNode. More...

def	getPrefix (self)
	Returns the XML namespace prefix of token. More...

def	getURI (self)
	Returns the XML namespace URI of token. More...

def	hasAttr (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	hasChild (self, name)
	Return a boolean indicating whether this XMLNode has a child with the given name. More...

def	hasNamespaceNS (self, uri, prefix)
	Returns `True` if this token has an XML namespace with a given prefix and URI combination. More...

def	hasNamespacePrefix (self, prefix)
	Returns `True` if this token has an XML namespace with a given prefix. More...

def	hasNamespaceURI (self, uri)
	Returns `True` if this token has an XML namespace with a given URI. More...

def	insertChild (self, n, node)
	Inserts a copy of the given node as the `n`th child of this XMLNode. More...

def	isAttributesEmpty (self)
	Returns `True` if this token has no attributes. More...

def	isElement (self)
	Returns `True` if this token represents an XML element. More...

def	isEnd (self)
	Returns `True` if this token represents an XML end element. More...

def	isEndFor (self, element)
	Returns `True` if this token represents an XML end element for a particular start element. More...

def	isEOF (self)
	Returns `True` if this token is an end of file marker. More...

def	isNamespacesEmpty (self)
	Returns `True` if there are no namespaces declared on this token. More...

def	isStart (self)
	Returns `True` if this token represents an XML start element. More...

def	isText (self)
	Returns `True` if this token represents an XML text element. More...

def	removeAttr (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	removeChild (self, n)
	Removes the `n`th child of this XMLNode and returns the removed node. More...

def	removeChildren (self)
	Removes all children from this node. More...

def	removeNamespace (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	setAttributes (self, attributes)
	Sets the attributes on the XML element represented by this token. More...

def	setCharacters (self, chars)
	Sets the characters for this XMLToken. More...

def	setEnd (self)
	Declares that this token represents an XML element end tag. More...

def	setEOF (self)
	Declares that this token is an end-of-file/input marker. More...

def	setNamespaces (self, namespaces)
	Sets the XML namespaces on this XML element. More...

def	setTriple (self, triple)
	Sets the name, namespace prefix and namespace URI of this token. More...

def	toString (self)
	Prints a string representation of the underlying token stream. More...

def	toXMLString (self)
	Returns a string representation of this XMLNode. More...

def	unsetEnd (self)
	Declares that this token no longer represents an XML start/end element. More...

Constructor & Destructor Documentation

def libsbml.XMLNode.__init__	(	self,
		args
	)

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

__init__()   XMLNode
__init__(XMLToken token)   XMLNode
__init__(XMLTriple triple, XMLAttributes attributes, XMLNamespaces namespaces, long   line=0, long   column=0)   XMLNode
__init__(XMLTriple triple, XMLAttributes attributes, XMLNamespaces namespaces, long   line=0)   XMLNode
__init__(XMLTriple triple, XMLAttributes attributes, XMLNamespaces namespaces)   XMLNode
__init__(XMLTriple triple, XMLAttributes attributes, long   line=0, long   column=0)   XMLNode
__init__(XMLTriple triple, XMLAttributes attributes, long   line=0)   XMLNode
__init__(XMLTriple triple, XMLAttributes attributes)   XMLNode
__init__(XMLTriple triple, long   line=0, long   column=0)   XMLNode
__init__(XMLTriple triple, long   line=0)   XMLNode
__init__(XMLTriple triple)   XMLNode
__init__(string chars, long   line=0, long   column=0)   XMLNode
__init__(string chars, long   line=0)   XMLNode
__init__(string chars)   XMLNode
__init__(XMLInputStream stream)   XMLNode
__init__(XMLNode orig)   XMLNode

Each variant is described separately below.

Method variant with the following signature:

XMLNode(XMLToken token)

Creates a new XMLNode by copying an XMLToken object.

Parameters

token XMLToken to be copied to XMLNode.

Method variant with the following signature:

XMLNode(XMLTriple triple, XMLAttributes attributes, XMLNamespaces namespaces, long line = 0, long column = 0)

Creates a new start element XMLNode with the given set of attributes and namespace declarations.

Parameters

triple	XMLTriple.
attributes	XMLAttributes, the attributes to set.
namespaces	XMLNamespaces, the namespaces to set.
line	a long integer, the line number (default = 0).
column	a long integer, the column number (default = 0).

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:

XMLNode(XMLNode orig)

Copy constructor; creates a copy of this XMLNode.

Parameters

orig	the XMLNode instance to copy.

Method variant with the following signature:

XMLNode()

Creates a new empty XMLNode with no children.

Method variant with the following signature:

XMLNode(XMLTriple triple, XMLAttributes attributes, long line = 0, long column = 0)

Creates a start element XMLNode with the given set of attributes.

Parameters

triple	XMLTriple.
attributes	XMLAttributes, the attributes to set.
line	a long integer, the line number (default = 0).
column	a long integer, the column number (default = 0).

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:

XMLNode(XMLTriple triple, long line = 0, long column = 0)

Creates an end element XMLNode.

Parameters

triple	XMLTriple.
line	a long integer, the line number (default = 0).
column	a long integer, the column number (default = 0).

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:

XMLNode(string chars, long line = 0, long column = 0)

Creates a text XMLNode.

Parameters

chars	a string, the text to be added to the XMLToken.
line	a long integer, the line number (default = 0).
column	a long integer, the column number (default = 0).

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.

Member Function Documentation

def libsbml.XMLToken.addAttr	(	self,
		args
	)

inherited

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

addAttr(string name, string value, string namespaceURI, string prefix)   int
addAttr(string name, string value, string namespaceURI)   int
addAttr(string name, string value)   int
addAttr(XMLTriple triple, string value)   int

Each variant is described separately below.

Method variant with the following signature:

addAttr(string name, string value, string namespaceURI = '', string prefix = '')

Adds an attribute to the XML element represented by this token.

: This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

Parameters

name	a string, the so-called 'local part' of the attribute name; that is, the attribute name without any namespace qualifier or prefix.
value	a string, the value assigned to the attribute.
namespaceURI	a string, the XML namespace URI of the attribute.
prefix	a string, the prefix for the XML namespace.

Recall that in XML, the complete form of an attribute on an XML element is the following:

prefix:name='value'

The name part is the name of the attribute, the 'value' part is the value assigned to the attribute (and it is always a quoted string), and the prefix part is an optional XML namespace prefix. Internally in libSBML, this data is stored in an XMLAttributes object associated with this XMLToken.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: If an attribute with the same name and XML namespace URI already exists on this XMLToken object, then the previous value will be replaced with the new value provided to this method.; 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:

addAttr(XMLTriple triple, string value)

Adds an attribute to the XML element represented by this token.

: This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

Parameters

triple	an XMLTriple object defining the attribute, its value, and optionally its XML namespace (if any is provided).
value	a string, the value assigned to the attribute.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: If an attribute with the same name and XML namespace URI already exists on this XMLToken object, then the previous value will be replaced with the new value provided to this method.

def libsbml.XMLNode.addChild	(	self,
		node
	)

Adds a copy of node as a child of this XMLNode.

addChild(XMLNode node)   int

The given node is added at the end of the list of children.

Parameters

node	the XMLNode to be added as child.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: The given node is added at the end of the children list.

def libsbml.XMLToken.addNamespace	(	self,
		args
	)

inherited

Appends an XML namespace declaration to this token.

addNamespace(string uri, string prefix)   int
addNamespace(string uri)   int

The namespace added will be defined by the given XML namespace URI and an optional prefix. If this XMLToken object already possesses an XML namespace declaration with the given prefix, then the existing XML namespace URI will be overwritten by the new one given by uri.

: This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

Parameters

uri	a string, the XML namespace URI for the namespace.
prefix	a string, the namespace prefix to use.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

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.

def libsbml.XMLToken.append	(	self,
		chars
	)

inherited

Appends characters to the text content of token.

append(string chars)   int

This method only makes sense for XMLToken objects that contains text. If this method is called on a token that represents an XML start or end tag, it will return the code LIBSBML_OPERATION_FAILED.

Parameters

chars string, characters to append to the text of this token.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: isText(); isElement()

def libsbml.XMLToken.clearAttributes ( self )

inherited

Removes all attributes of this XMLToken object.

clearAttributes()   int

: This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

def libsbml.XMLToken.clearNamespaces ( self )

inherited

Removes all XML namespace declarations from this token.

clearNamespaces()   int

: This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

def libsbml.XMLNode.clone ( self )

Creates and returns a deep copy of this XMLNode object.

clone()   XMLNode

Returns: the (deep) copy of this XMLNode object.

def libsbml.XMLNode.convertStringToXMLNode	(	xmlstr,
		xmlns = `None`
	)

Returns an XMLNode which is derived from a string containing XML content.

convertStringToXMLNode(string xmlstr, XMLNamespaces xmlns)   XMLNode
convertStringToXMLNode(string xmlstr)   XMLNode

The XML namespace must be defined using argument xmlns if the corresponding XML namespace attribute is not part of the string of the first argument.

Parameters

xmlstr	string to be converted to a XML node.
xmlns	XMLNamespaces the namespaces to set (default value is `None`).

Note: The caller owns the returned XMLNode and is reponsible for deleting it. The returned XMLNode object is a dummy root (container) XMLNode if the top-level element in the given XML string is NOT <html>, <body>, <annotation>, or <notes>. In the dummy root node, each top-level element in the given XML string is contained as a child XMLNode. XMLToken.isEOF() can be used to identify if the returned XMLNode object is a dummy node.

Returns: a XMLNode which is converted from string xmlstr. If the conversion failed, this method returns None.

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.

def libsbml.XMLNode.convertXMLNodeToString ( node )

Returns a string representation of a given XMLNode.

convertXMLNodeToString(XMLNode node)   string

Parameters

node	the XMLNode to be represented as a string.

Returns: a string-form representation of node.

def libsbml.XMLNode.equals	(	self,
		other,
		ignoreURI = `False`,
		ignoreAttributeValues = `False`
	)

Compare this XMLNode against another XMLNode returning true if both nodes represent the same XML tree, or false otherwise.

equals(XMLNode other, bool ignoreURI, bool ignoreAttributeValues)   bool
equals(XMLNode other, bool ignoreURI)   bool
equals(XMLNode other)   bool

Parameters

other	another XMLNode to compare against.
ignoreURI	whether to ignore the namespace URI when doing the comparison.
ignoreAttributeValues	whetehr to ignore attribute values when doing the comparison.

Returns: boolean indicating whether this XMLNode represents the same XML tree as another.

def libsbml.XMLToken.getAttributes ( self )

inherited

Returns the attributes of the XML element represented by this token.

getAttributes()   XMLAttributes

Returns: the attributes of this XML element, stored in an XMLAttributes object.

def libsbml.XMLToken.getAttributesLength ( self )

inherited

Returns the number of attributes on this XMLToken object.

getAttributesLength()   int

Returns: the number of attributes possessed by this token.

See also: hasAttr()

def libsbml.XMLToken.getAttrIndex	(	self,
		args
	)

inherited

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

getAttrIndex(string name, string uri)   int
getAttrIndex(string name)   int
getAttrIndex(XMLTriple triple)   int

Each variant is described separately below.

Method variant with the following signature:

getAttrIndex(string name, string uri='')

Returns the index of the attribute with the given name and namespace URI.

Parameters

name	a string, the name of the attribute.
uri	a string, the namespace URI of the attribute.

Returns: the index of an attribute with the given local name and namespace URI, or -1 if it is not present on this token.

Method variant with the following signature:

getAttrIndex(XMLTriple triple)

Returns the index of the attribute defined by the given XMLTriple object.

Parameters

triple the XMLTriple object that defines the attribute whose index is being sought.

Returns: the index of an attribute with the given XMLTriple object, or -1 if no such attribute is present on this token.

def libsbml.XMLToken.getAttrName	(	self,
		index
	)

inherited

Returns the name of the nth attribute in this token's list of attributes.

getAttrName(int index)   string

Parameters

index an integer, the position of the attribute whose name is being sought.

Returns: the name of the attribute located at position n in the list of attributes possessed by this XMLToken object.

Note: If index is out of range, this method will return an empty string. XMLToken.hasAttr() can be used to test for an attribute's existence explicitly, and XMLToken.getAttributesLength() can be used to find out the number of attributes possessed by this token.

See also: hasAttr(); getAttributesLength()

def libsbml.XMLToken.getAttrPrefix	(	self,
		index
	)

inherited

Returns the prefix of the nth attribute in this token's list of attributes.

getAttrPrefix(int index)   string

Parameters

index an integer, the position of the attribute whose prefix is being sought.

Returns: the XML namespace prefix of the attribute located at position n in the list of attributes possessed by this XMLToken object.

Note: If index is out of range, this method will return an empty string. XMLToken.hasAttr() can be used to test for an attribute's existence explicitly, and XMLToken.getAttributesLength() can be used to find out the number of attributes possessed by this token.

See also: hasAttr(); getAttributesLength()

def libsbml.XMLToken.getAttrPrefixedName	(	self,
		index
	)

inherited

Returns the prefixed name of the nth attribute in this token's list of attributes.

getAttrPrefixedName(int index)   string

In this context, prefixed name means the name of the attribute prefixed with the XML namespace prefix assigned to the attribute. This will be a string of the form prefix:name.

Parameters

index an integer, the position of the attribute whose prefixed name is being sought.

Returns: the prefixed name of the attribute located at position n in the list of attributes possessed by this XMLToken object.

Note: If index is out of range, this method will return an empty string. XMLToken.hasAttr() can be used to test for an attribute's existence explicitly, and XMLToken.getAttributesLength() can be used to find out the number of attributes possessed by this token.

def libsbml.XMLToken.getAttrURI	(	self,
		index
	)

inherited

Returns the XML namespace URI of the nth attribute in this token's list of attributes.

getAttrURI(int index)   string

Parameters

index an integer, the position of the attribute whose namespace URI is being sought.

Returns: the XML namespace URI of the attribute located at position n in the list of attributes possessed by this XMLToken object.

Note: If index is out of range, this method will return an empty string. XMLToken.hasAttr() can be used to test for an attribute's existence explicitly, and XMLToken.getAttributesLength() can be used to find out the number of attributes possessed by this token.

def libsbml.XMLToken.getAttrValue	(	self,
		args
	)

inherited

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

getAttrValue(int index)   string
getAttrValue(string name, string uri)   string
getAttrValue(string name)   string
getAttrValue(XMLTriple triple)   string

Each variant is described separately below.

Method variant with the following signature:

getAttrValue(string name, string uri='')

Returns the value of the attribute with a given name and XML namespace URI.

Parameters

name	a string, the name of the attribute whose value is being sought.
uri	a string, the XML namespace URI of the attribute.

Returns: The value of the attribute, as a string.

Note: If an attribute with the given name and uri does not exist on this token object, this method will return an empty string. XMLToken.hasAttr() can be used to test explicitly for the presence of an attribute with a given name and namespace.

Method variant with the following signature:

getAttrValue(XMLTriple triple)

Returns the value of the attribute specified by a given XMLTriple object.

Parameters

triple an XMLTriple describing the attribute whose value is being sought.

Returns: The value of the attribute, as a string.

Note: If an attribute defined by the given triple does not exist on this token object, this method will return an empty string. XMLToken.hasAttr() can be used to test explicitly for the existence of an attribute with the properties of a given triple.

Method variant with the following signature:

getAttrValue(int index)

Returns the value of the nth attribute in this token's list of attributes.

Parameters

index an integer, the position of the attribute whose value is required.

Returns: the value of the attribute located at position n in the list of attributes possessed by this XMLToken object.

Note: If index is out of range, this method will return an empty string. XMLToken.hasAttr() can be used to test for an attribute's existence explicitly, and XMLToken.getAttributesLength() can be used to find out the number of attributes possessed by this token.

def libsbml.XMLToken.getCharacters ( self )

inherited

Returns the character text of token.

getCharacters()   string

Returns: the characters of this XML token. If this token is not a text token (i.e., it's an XML element and not character content), then this will return an empty string.

See also: isText(); isElement()

def libsbml.XMLNode.getChild	(	self,
		args
	)

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

getChild(long  n)   XMLNode
getChild(string name)   XMLNode

Each variant is described separately below.

Method variant with the following signature:

getChild(long n)

Returns the nth child of this XMLNode.

If the index n is greater than the number of child nodes, this method returns an empty node.

Parameters

n	a long integereger, the index of the node to return.

Returns: the nth child of this XMLNode.

Method variant with the following signature:

getChild(string name)

Returns the first child of this XMLNode with the corresponding name.

If no child with corrsponding name can be found, this method returns an empty node.

Parameters

name	the name of the node to return.

Returns: the first child of this XMLNode with given name.

def libsbml.XMLToken.getColumn ( self )

inherited

Returns the column number at which this token occurs in the input.

getColumn()   long

Returns: the column at which this XMLToken occurred.

def libsbml.XMLNode.getIndex	(	self,
		name
	)

Return the index of the first child of this XMLNode with the given name.

getIndex(string name)   int

Parameters

name	a string, the name of the child for which the index is required.

Returns: the index of the first child of this XMLNode with the given name, or -1 if not present.

def libsbml.XMLToken.getLine ( self )

inherited

Returns the line number at which this token occurs in the input.

getLine()   long

Returns: the line at which this XMLToken occurred.

def libsbml.XMLToken.getName ( self )

inherited

Returns the (unqualified) name of token.

getName()   string

Returns: the (unqualified) name of token.

def libsbml.XMLToken.getNamespaceIndex	(	self,
		uri
	)

inherited

Returns the index of an XML namespace declaration based on its URI.

getNamespaceIndex(string uri)   int

Parameters

uri	a string, the XML namespace URI of the sought-after namespace.

Returns: the index of the given declaration, or -1 if no such namespace URI is present on this XMLToken object.

def libsbml.XMLToken.getNamespaceIndexByPrefix	(	self,
		prefix
	)

inherited

Returns the index of an XML namespace declaration based on its prefix.

getNamespaceIndexByPrefix(string prefix)   int

Parameters

prefix a string, the prefix of the sought-after XML namespace.

Returns: the index of the given declaration, or -1 if no such namespace URI is present on this XMLToken object.

def libsbml.XMLToken.getNamespacePrefix	(	self,
		args
	)

inherited

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

getNamespacePrefix(int index)   string
getNamespacePrefix(string uri)   string

Each variant is described separately below.

Method variant with the following signature:

getNamespacePrefix(int index)

Returns the prefix of the nth XML namespace declaration.

Parameters

index an integer, position of the required prefix.

Returns: the prefix of an XML namespace declaration in the XMLNamespaces (by position).

Note: If index is out of range, this method will return an empty string. XMLToken.getNamespacesLength() can be used to find out how many namespaces are defined on this XMLToken object.

See also: getNamespacesLength()

Method variant with the following signature:

getNamespacePrefix(string uri)

Returns the prefix associated with a given XML namespace URI on this token.

Parameters

uri	a string, the URI of the namespace whose prefix is being sought.

Returns: the prefix of an XML namespace declaration on this XMLToken object.

Note: If there is no XML namespace with the given uri declared on this XMLToken object, this method will return an empty string.

def libsbml.XMLToken.getNamespaces ( self )

inherited

Returns the XML namespaces declared for this token.

getNamespaces()   XMLNamespaces

Returns: the XML namespace declarations for this XML element.

def libsbml.XMLToken.getNamespacesLength ( self )

inherited

Returns the number of XML namespaces declared on this token.

getNamespacesLength()   int

Returns: the number of XML namespaces stored in the XMLNamespaces object of this XMLToken object.

def libsbml.XMLToken.getNamespaceURI	(	self,
		args
	)

inherited

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

getNamespaceURI(int index)   string
getNamespaceURI(string prefix)   string
getNamespaceURI()   string

Each variant is described separately below.

Method variant with the following signature:

getNamespaceURI(string prefix = '')

Returns the URI of an XML namespace with a given prefix.

Parameters

prefix a string, the prefix of the sought-after XML namespace URI.

Returns: the URI of an XML namespace declaration given its prefix.

Note: If there is no XML namespace with the given prefix stored in the XMLNamespaces object of this XMLToken object, this method will return an empty string.; 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:

getNamespaceURI(int index)

Returns the URI of the nth XML namespace declared on this token.

Parameters

index an integer, the position of the sought-after XML namespace URI.

Returns: the URI of the nth XML namespace stored in the XMLNamespaces object in this XMLToken object.

Note: If index is out of range, this method will return an empty string.

See also: getNamespacesLength()

def libsbml.XMLNode.getNumChildren ( self )

Returns the number of children for this XMLNode.

getNumChildren()   long

Returns: the number of children for this XMLNode.

def libsbml.XMLToken.getPrefix ( self )

inherited

Returns the XML namespace prefix of token.

getPrefix()   string

Returns: the XML namespace prefix of token.

Note: If no XML namespace prefix has been assigned to this token, this method will return an empty string.

def libsbml.XMLToken.getURI ( self )

inherited

Returns the XML namespace URI of token.

getURI()   string

Returns: the XML namespace URI of token.

def libsbml.XMLToken.hasAttr	(	self,
		args
	)

inherited

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

hasAttr(int index)   bool
hasAttr(string name, string uri)   bool
hasAttr(string name)   bool
hasAttr(XMLTriple triple)   bool

Each variant is described separately below.

Method variant with the following signature:

hasAttr(string name, string uri='')

Returns True if an attribute with a given name and namespace URI exists.

Parameters

name	a string, the name of the attribute being sought.
uri	a string, the XML namespace URI of the attribute being sought.

Returns: True if an attribute with the given local name and namespace URI exists in the list of attributes on this token object, False otherwise.

Method variant with the following signature:

hasAttr(XMLTriple triple)

Returns True if an attribute defined by a given XMLTriple object exists.

Parameters

triple an XMLTriple object describing the attribute being sought.

Returns: True if an attribute matching the properties of the given XMLTriple object exists in the list of attributes on this token, False otherwise.

Method variant with the following signature:

hasAttr(int index)

Returns True if an attribute with the given index exists.

Parameters

index an integer, the position of the attribute.

Returns: True if this token object possesses an attribute with the given index, False otherwise.

def libsbml.XMLNode.hasChild	(	self,
		name
	)

Return a boolean indicating whether this XMLNode has a child with the given name.

hasChild(string name)   bool

Parameters

name	a string, the name of the child to be checked.

Returns: boolean indicating whether this XMLNode has a child with the given name.

def libsbml.XMLToken.hasNamespaceNS	(	self,
		uri,
		prefix
	)

inherited

Returns True if this token has an XML namespace with a given prefix and URI combination.

hasNamespaceNS(string uri, string prefix)   bool

Parameters

uri	a string, the URI for the namespace.
prefix	a string, the prefix for the namespace.

Returns: True if an XML namespace with the given URI/prefix pair is contained in the XMLNamespaces object of this XMLToken object, False otherwise.

def libsbml.XMLToken.hasNamespacePrefix	(	self,
		prefix
	)

inherited

Returns True if this token has an XML namespace with a given prefix.

hasNamespacePrefix(string prefix)   bool

Parameters

prefix a string, the prefix for the XML namespace.

Returns: True if an XML Namespace with the given URI is contained in the XMLNamespaces of this XMLToken, False otherwise.

def libsbml.XMLToken.hasNamespaceURI	(	self,
		uri
	)

inherited

Returns True if this token has an XML namespace with a given URI.

hasNamespaceURI(string uri)   bool

Parameters

uri	a string, the URI of the XML namespace.

Returns: True if an XML namespace with the given URI is contained in the XMLNamespaces object of this XMLToken object, False otherwise.

def libsbml.XMLNode.insertChild	(	self,
		n,
		node
	)

Inserts a copy of the given node as the nth child of this XMLNode.

insertChild(long  n, XMLNode node)   XMLNode

If the given index n is out of range for this XMLNode instance, the node is added at the end of the list of children. Even in that situation, this method does not throw an error.

Parameters

n	an integer, the index at which the given node is inserted.
node	an XMLNode to be inserted as `n`th child.

Returns: a reference to the newly-inserted child node.

def libsbml.XMLToken.isAttributesEmpty ( self )

inherited

Returns True if this token has no attributes.

isAttributesEmpty()   bool

Returns: True if the list of attributes on XMLToken object is empty, False otherwise.

def libsbml.XMLToken.isElement ( self )

inherited

Returns True if this token represents an XML element.

isElement()   bool

This generic predicate returns True if the element is either a start or end tag, and False if it's a text object. The related methods XMLToken:isStart(), XMLToken.isEnd() and XMLToken.isText() are more specific predicates.

Returns: True if this XMLToken object represents an XML element, False otherwise.

See also: isStart(); isEnd(); isText()

def libsbml.XMLToken.isEnd ( self )

inherited

Returns True if this token represents an XML end element.

isEnd()   bool

Returns: True if this XMLToken object represents an XML end element, False otherwise.

See also: isStart(); isElement(); isText()

def libsbml.XMLToken.isEndFor	(	self,
		element
	)

inherited

Returns True if this token represents an XML end element for a particular start element.

isEndFor(XMLToken element)   bool

Parameters

element XMLToken, the element with which the current object should be compared to determined whether the current object is a start element for the given one.

Returns: True if this XMLToken object represents an XML end tag for the start tag given by element, False otherwise.

See also: isElement(); isStart(); isEnd(); isText()

def libsbml.XMLToken.isEOF ( self )

inherited

Returns True if this token is an end of file marker.

isEOF()   bool

Returns: True if this XMLToken object represents the end of the input, False otherwise.

See also: setEOF()

def libsbml.XMLToken.isNamespacesEmpty ( self )

inherited

Returns True if there are no namespaces declared on this token.

isNamespacesEmpty()   bool

Returns: True if the XMLNamespaces object stored in this XMLToken token is empty, False otherwise.

def libsbml.XMLToken.isStart ( self )

inherited

Returns True if this token represents an XML start element.

isStart()   bool

Returns: True if this XMLToken is an XML start element, False otherwise.

See also: isElement(); isEnd(); isText()

def libsbml.XMLToken.isText ( self )

inherited

Returns True if this token represents an XML text element.

isText()   bool

Returns: True if this XMLToken is an XML text element, False otherwise.

See also: isElement(); isStart(); isEnd()

def libsbml.XMLToken.removeAttr	(	self,
		args
	)

inherited

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

removeAttr(int n)   int
removeAttr(string name, string uri)   int
removeAttr(string name)   int
removeAttr(XMLTriple triple)   int

Each variant is described separately below.

Method variant with the following signature:

removeAttr(string name, string uri = '')

Removes an attribute from the XML element represented by this token.

: This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

Parameters

name	a string, the name of the attribute to be removed.
uri	a string, the XML namespace URI of the attribute to be removed.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

The value LIBSBML_INDEX_EXCEEDS_SIZE is returned if there is no attribute on this element with the given name (and uri if specified).

See also: hasAttr()

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:

removeAttr(int n)

Removes the nth attribute from the XML element represented by this token.

: This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

Parameters

n	an integer the index of the resource to be deleted.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

The value LIBSBML_INDEX_EXCEEDS_SIZE is returned if there is no attribute on this element at the given index n.

See also: getAttrIndex(); getAttrIndex(); getAttributesLength()

Method variant with the following signature:

removeAttr(XMLTriple triple)

Removes an attribute from the XML element represented by this token.

: This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

Parameters

triple an XMLTriple describing the attribute to be removed.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

The value LIBSBML_INDEX_EXCEEDS_SIZE is returned if there is no attribute on this element matching the properties of the given triple.

See also: hasAttr()

def libsbml.XMLNode.removeChild	(	self,
		n
	)

Removes the nth child of this XMLNode and returns the removed node.

removeChild(long  n)   XMLNode

It is important to keep in mind that a given XMLNode may have more than one child. Calling this method erases all existing references to child nodes after the given position n. If the index n is greater than the number of child nodes in this XMLNode, this method takes no action (and returns None).

Parameters

n	an integer, the index of the node to be removed.

Returns: the removed child, or None if n is greater than the number of children in this node.

Note: The caller owns the returned node and is responsible for deleting it.

def libsbml.XMLNode.removeChildren ( self )

Removes all children from this node.

removeChildren()   int

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

LIBSBML_OPERATION_SUCCESS

def libsbml.XMLToken.removeNamespace	(	self,
		args
	)

inherited

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

removeNamespace(int index)   int
removeNamespace(string prefix)   int

Each variant is described separately below.

Method variant with the following signature:

removeNamespace(int index)

Removes the nth XML namespace declaration.

: This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

Parameters

index an integer, the position of the namespace to be removed. The position in this context refers to the position of the namespace in the XMLNamespaces object stored in this XMLToken object. Callers can use one of the getNamespace___() methods to find the index number of a given namespace.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: getNamespaceIndex(); getNamespaceIndexByPrefix(); getNamespacesLength()

Method variant with the following signature:

removeNamespace(string prefix)

Removes an XML namespace declaration having a given prefix.

: This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

Parameters

prefix a string, the prefix of the namespace to be removed.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

The value LIBSBML_INDEX_EXCEEDS_SIZE is returned if there is no namespace with the given prefix on this element.

See also: getNamespaceIndexByPrefix()

def libsbml.XMLToken.setAttributes	(	self,
		attributes
	)

inherited

Sets the attributes on the XML element represented by this token.

setAttributes(XMLAttributes attributes)   int

: This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

Parameters

attributes an XMLAttributes object to be assigned to this XMLToken object, thereby setting the XML attributes associated with this token.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: This function replaces any existing XMLAttributes object on this XMLToken object with the one given by attributes.

def libsbml.XMLToken.setCharacters	(	self,
		chars
	)

inherited

Sets the characters for this XMLToken.

This method only makes sense for XMLToken objects that contains text.

setCharacters(string chars)   int

If this method is called on a token that represents an XML start or end tag, it will return the code LIBSBML_OPERATION_FAILED.

Parameters

chars string, characters to append to the text of this token.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: isText(); isElement()

def libsbml.XMLToken.setEnd ( self )

inherited

Declares that this token represents an XML element end tag.

setEnd()   int

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: isStart(); isEnd()

def libsbml.XMLToken.setEOF ( self )

inherited

Declares that this token is an end-of-file/input marker.

setEOF()   int

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

See also: isEOF()

def libsbml.XMLToken.setNamespaces	(	self,
		namespaces
	)

inherited

Sets the XML namespaces on this XML element.

setNamespaces(XMLNamespaces namespaces)   int

: This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

Parameters

namespaces the XMLNamespaces object to be assigned to this XMLToken object.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Note: This function replaces any existing XMLNamespaces object on this XMLToken object with the new one given by namespaces.

def libsbml.XMLToken.setTriple	(	self,
		triple
	)

inherited

Sets the name, namespace prefix and namespace URI of this token.

setTriple(XMLTriple triple)   int

: This operation only makes sense for XML start elements. This method will return LIBSBML_INVALID_XML_OPERATION if this XMLToken object is not an XML start element.

Parameters

triple the new XMLTriple to use for this XMLToken object. If this XMLToken already had an XMLTriple object stored within it, that object will be replaced.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

def libsbml.XMLToken.toString ( self )

inherited

Prints a string representation of the underlying token stream.

toString()   string

This method is intended for debugging purposes.

Returns: a text string representing this XMLToken object.

def libsbml.XMLNode.toXMLString ( self )

Returns a string representation of this XMLNode.

toXMLString()   string

Returns: a string derived from this XMLNode.

def libsbml.XMLToken.unsetEnd ( self )

inherited

Declares that this token no longer represents an XML start/end element.

unsetEnd()   int

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Detailed Description

Conversion between an XML string and an XMLNode

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation