libSBML Perl API
libSBML 5.10.0 Perl API
|
{core} Representation of 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. An XMLTriple instance carries up to three data items:
The name of the attribute or element; that is, the attribute name as it appears in an XML document or data stream;
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" />
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.
Public Member Functions | |
XMLTriple * | clone () const |
Creates and returns a deep copy of this XMLTriple set. More... | |
const std::string & | getName () const |
Returns the name portion of this XMLTriple. More... | |
const std::string & | getPrefix () const |
Returns the prefix portion of this XMLTriple. More... | |
const std::string | getPrefixedName () const |
Returns the prefixed name from this XMLTriple. More... | |
const std::string & | getURI () const |
Returns the URI portion of this XMLTriple. More... | |
bool | isEmpty () const |
Predicate returning true or false depending on whether this XMLTriple is empty. More... | |
XMLTriple & | operator= (const XMLTriple &rhs) |
Assignment operator for XMLTriple. More... | |
XMLTriple () | |
Creates a new, empty XMLTriple. More... | |
XMLTriple (const std::string &name, const std::string &uri, const std::string &prefix) | |
Creates a new XMLTriple with the given name , uri and and prefix . More... | |
XMLTriple (const std::string &triplet, const char sepchar= ' ') | |
Creates a new XMLTriple by splitting the given triplet on the separator character sepchar . More... | |
XMLTriple (const XMLTriple &orig) | |
Copy constructor; creates a copy of this XMLTriple set. More... | |
XMLTriple::XMLTriple | ( | ) |
Creates a new, empty XMLTriple.
XMLTriple::XMLTriple | ( | const std::string & | name, |
const std::string & | uri, | ||
const std::string & | prefix | ||
) |
Creates a new XMLTriple with the given name
, uri
and and prefix
.
name | a string, name for the XMLTriple. |
uri | a string, URI of the XMLTriple. |
prefix | a string, prefix for the URI of the XMLTriple, |
XMLConstructorException | Thrown if the argument orig is NULL . |
XMLTriple::XMLTriple | ( | const std::string & | triplet, |
const char | sepchar = ' ' |
||
) |
Creates a new XMLTriple by splitting the given triplet
on the separator character sepchar
.
Triplet may be in one of the following formats:
triplet | a string representing the triplet as above |
sepchar | a character, the sepchar used in the triplet |
XMLConstructorException | Thrown if the argument orig is NULL . |
XMLTriple::XMLTriple | ( | const XMLTriple & | orig | ) |
Copy constructor; creates a copy of this XMLTriple set.
orig | the XMLTriple object to copy. |
XMLConstructorException | Thrown if the argument orig is NULL . |
XMLTriple * XMLTriple::clone | ( | ) | const |
const std::string & XMLTriple::getName | ( | ) | const |
const std::string & XMLTriple::getPrefix | ( | ) | const |
const std::string XMLTriple::getPrefixedName | ( | ) | const |
const std::string & XMLTriple::getURI | ( | ) | const |
bool XMLTriple::isEmpty | ( | ) | const |
Assignment operator for XMLTriple.
rhs | The XMLTriple object whose values are used as the basis of the assignment. |
XMLConstructorException | Thrown if the argument rhs is NULL . |