libSBML Perl API  libSBML 5.8.0 Perl API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
XMLToken Class Reference
Inheritance diagram for XMLToken:
[legend]

Detailed Description

Representation of a token in an XML stream.

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.

Public Member Functions

int addAttr (const std::string &name, const std::string &value, const std::string &namespaceURI="", const std::string &prefix="")
 Adds an attribute to the attribute set in this XMLToken optionally with a prefix and URI defining a namespace. More...
 
int addAttr (const XMLTriple &triple, const std::string &value)
 Adds an attribute with the given XMLTriple/value pair to the attribute set in this XMLToken. More...
 
int addNamespace (const std::string &uri, const std::string &prefix="")
 Appends an XML namespace prefix and URI pair to this XMLToken. More...
 
int append (const std::string &chars)
 Appends characters to this XML text content. More...
 
int clearAttributes ()
 Clears (deletes) all attributes in this XMLToken. More...
 
int clearNamespaces ()
 Clears (deletes) all XML namespace declarations in the XMLNamespaces of this XMLToken. More...
 
XMLTokenclone () const
 Creates and returns a deep copy of this XMLToken. More...
 
const XMLAttributesgetAttributes () const
 Returns the attributes of this element. More...
 
int getAttributesLength () const
 Return the number of attributes in the attributes set. More...
 
int getAttrIndex (const std::string &name, const std::string &uri="") const
 Return the index of an attribute with the given local name and namespace URI. More...
 
int getAttrIndex (const XMLTriple &triple) const
 Return the index of an attribute with the given XMLTriple. More...
 
std::string getAttrName (int index) const
 Return the local name of an attribute in the attributes set in this XMLToken (by position). More...
 
std::string getAttrPrefix (int index) const
 Return the prefix of an attribute in the attribute set in this XMLToken (by position). More...
 
std::string getAttrPrefixedName (int index) const
 Return the prefixed name of an attribute in the attribute set in this XMLToken (by position). More...
 
std::string getAttrURI (int index) const
 Return the namespace URI of an attribute in the attribute set in this XMLToken (by position). More...
 
std::string getAttrValue (int index) const
 Return the value of an attribute in the attribute set in this XMLToken (by position). More...
 
std::string getAttrValue (const std::string name, const std::string uri="") const
 Return a value of an attribute with the given local name and namespace URI. More...
 
std::string getAttrValue (const XMLTriple &triple) const
 Return a value of an attribute with the given XMLTriple. More...
 
const std::string & getCharacters () const
 Returns the text of this element. More...
 
unsigned int getColumn () const
 Returns the column at which this XMLToken occurred in the input document or data stream. More...
 
unsigned int getLine () const
 Returns the line at which this XMLToken occurred in the input document or data stream. More...
 
const std::string & getName () const
 Returns the (unqualified) name of this XML element. More...
 
int getNamespaceIndex (const std::string &uri) const
 Look up the index of an XML namespace declaration by URI. More...
 
int getNamespaceIndexByPrefix (const std::string &prefix) const
 Look up the index of an XML namespace declaration by prefix. More...
 
std::string getNamespacePrefix (int index) const
 Look up the prefix of an XML namespace declaration by position. More...
 
std::string getNamespacePrefix (const std::string &uri) const
 Look up the prefix of an XML namespace declaration by its URI. More...
 
const XMLNamespacesgetNamespaces () const
 Returns the XML namespace declarations for this XML element. More...
 
int getNamespacesLength () const
 Returns the number of XML namespaces stored in the XMLNamespaces of this XMLToken. More...
 
std::string getNamespaceURI (int index) const
 Look up the URI of an XML namespace declaration by its position. More...
 
std::string getNamespaceURI (const std::string &prefix="") const
 Look up the URI of an XML namespace declaration by its prefix. More...
 
const std::string & getPrefix () const
 Returns the namespace prefix of this XML element. More...
 
const std::string & getURI () const
 Returns the namespace URI of this XML element. More...
 
bool hasAttr (int index) const
 Predicate returning true or false depending on whether an attribute with the given index exists in the attribute set in this XMLToken. More...
 
bool hasAttr (const std::string name, const std::string uri="") const
 Predicate returning true or false depending on whether an attribute with the given local name and namespace URI exists in the attribute set in this XMLToken. More...
 
bool hasAttr (const XMLTriple &triple) const
 Predicate returning true or false depending on whether an attribute with the given XML triple exists in the attribute set in this XMLToken. More...
 
bool hasNamespaceNS (const std::string &uri, const std::string &prefix) const
 Predicate returning true or false depending on whether an XML Namespace with the given uri/prefix pair is contained in the XMLNamespaces ofthis XMLToken. More...
 
bool hasNamespacePrefix (const std::string &prefix) const
 Predicate returning true or false depending on whether an XML Namespace with the given prefix is contained in the XMLNamespaces of this XMLToken. More...
 
bool hasNamespaceURI (const std::string &uri) const
 Predicate returning true or false depending on whether an XML Namespace with the given URI is contained in the XMLNamespaces of this XMLToken. More...
 
bool isAttributesEmpty () const
 Predicate returning true or false depending on whether the attribute set in this XMLToken set is empty. More...
 
bool isElement () const
 Predicate returning true or false depending on whether this XMLToken is an XML element. More...
 
bool isEnd () const
 Predicate returning true or false depending on whether this XMLToken is an XML end element. More...
 
bool isEndFor (const XMLToken &element) const
 Predicate returning true or false depending on whether this XMLToken is an XML end element for the given start element. More...
 
bool isEOF () const
 Predicate returning true or false depending on whether this XMLToken is an end of file marker. More...
 
bool isNamespacesEmpty () const
 Predicate returning true or false depending on whether the XMLNamespaces of this XMLToken is empty. More...
 
bool isStart () const
 Predicate returning true or false depending on whether this XMLToken is an XML start element. More...
 
bool isText () const
 Predicate returning true or false depending on whether this XMLToken is an XML text element. More...
 
XMLTokenoperator= (const XMLToken &rhs)
 Assignment operator for XMLToken. More...
 
int removeAttr (int n)
 Removes an attribute with the given index from the attribute set in this XMLToken. More...
 
int removeAttr (const std::string &name, const std::string &uri="")
 Removes an attribute with the given local name and namespace URI from the attribute set in this XMLToken. More...
 
int removeAttr (const XMLTriple &triple)
 Removes an attribute with the given XMLTriple from the attribute set in this XMLToken. More...
 
int removeNamespace (int index)
 Removes an XML Namespace stored in the given position of the XMLNamespaces of this XMLToken. More...
 
int removeNamespace (const std::string &prefix)
 Removes an XML Namespace with the given prefix. More...
 
int setAttributes (const XMLAttributes &attributes)
 Sets an XMLAttributes to this XMLToken. More...
 
int setEnd ()
 Declares this XML start element is also an end element. More...
 
int setEOF ()
 Declares this XMLToken is an end-of-file (input) marker. More...
 
int setNamespaces (const XMLNamespaces &namespaces)
 Sets an XMLnamespaces to this XML element. More...
 
int setTriple (const XMLTriple &triple)
 Sets the XMLTripe (name, uri and prefix) of this XML element. More...
 
std::string toString ()
 Prints a string representation of the underlying token stream, for debugging purposes. More...
 
int unsetEnd ()
 Declares this XML start/end element is no longer an end element. More...
 
 XMLToken ()
 Creates a new empty XMLToken. More...
 
 XMLToken (const XMLTriple &triple, const XMLAttributes &attributes, const XMLNamespaces &namespaces, const unsigned int line=0, const unsigned int column=0)
 Creates a start element XMLToken with the given set of attributes and namespace declarations. More...
 
 XMLToken (const XMLTriple &triple, const XMLAttributes &attributes, const unsigned int line=0, const unsigned int column=0)
 Creates a start element XMLToken with the given set of attributes. More...
 
 XMLToken (const XMLTriple &triple, const unsigned int line=0, const unsigned int column=0)
 Creates an end element XMLToken. More...
 
 XMLToken (const std::string &chars, const unsigned int line=0, const unsigned int column=0)
 Creates a text XMLToken. More...
 
 XMLToken (const XMLToken &orig)
 Copy constructor; creates a copy of this XMLToken. More...
 
virtual ~XMLToken ()
 Destroys this XMLToken. More...
 

Constructor & Destructor Documentation

XMLToken::XMLToken ( )

Creates a new empty XMLToken.

XMLToken::XMLToken ( const XMLTriple triple,
const XMLAttributes attributes,
const XMLNamespaces namespaces,
const unsigned int  line = 0,
const unsigned int  column = 0 
)

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

Parameters
tripleXMLTriple.
attributesXMLAttributes, the attributes to set.
namespacesXMLNamespaces, the namespaces to set.
linean unsigned int, the line number (default = 0).
columnan unsigned int, the column number (default = 0).
Documentation note:
The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.
XMLToken::XMLToken ( const XMLTriple triple,
const XMLAttributes attributes,
const unsigned int  line = 0,
const unsigned int  column = 0 
)

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

Parameters
tripleXMLTriple.
attributesXMLAttributes, the attributes to set.
linean unsigned int, the line number (default = 0).
columnan unsigned int, the column number (default = 0).
Documentation note:
The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.
XMLToken::XMLToken ( const XMLTriple triple,
const unsigned int  line = 0,
const unsigned int  column = 0 
)

Creates an end element XMLToken.

Parameters
tripleXMLTriple.
linean unsigned int, the line number (default = 0).
columnan unsigned int, the column number (default = 0).
Documentation note:
The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.
XMLToken::XMLToken ( const std::string &  chars,
const unsigned int  line = 0,
const unsigned int  column = 0 
)

Creates a text XMLToken.

Parameters
charsa string, the text to be added to the XMLToken
linean unsigned int, the line number (default = 0).
columnan unsigned int, the column number (default = 0).
Exceptions
XMLConstructorExceptionThrown if the argument orig is NULL.
Documentation note:
The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.
XMLToken::~XMLToken ( )
virtual

Destroys this XMLToken.

XMLToken::XMLToken ( const XMLToken orig)

Copy constructor; creates a copy of this XMLToken.

Parameters
origthe XMLToken object to copy.
Exceptions
XMLConstructorExceptionThrown if the argument orig is NULL.

Member Function Documentation

int XMLToken::addAttr ( const std::string &  name,
const std::string &  value,
const std::string &  namespaceURI = "",
const std::string &  prefix = "" 
)

Adds an attribute to the attribute set in this XMLToken optionally with a prefix and URI defining a namespace.

Nothing will be done if this XMLToken is not a start element.

Parameters
namea string, the local name of the attribute.
valuea string, the value of the attribute.
namespaceURIa string, the namespace URI of the attribute.
prefixa string, the prefix of the namespace
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
Note
if local name with the same namespace URI already exists in the attribute set, its value and prefix will be replaced.
Documentation note:
The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.
int XMLToken::addAttr ( const XMLTriple triple,
const std::string &  value 
)

Adds an attribute with the given XMLTriple/value pair to the attribute set in this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Note
if local name with the same namespace URI already exists in the attribute set, its value and prefix will be replaced.
Parameters
triplean XMLTriple, the XML triple of the attribute.
valuea string, the value of the attribute.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int XMLToken::addNamespace ( const std::string &  uri,
const std::string &  prefix = "" 
)

Appends an XML namespace prefix and URI pair to this XMLToken.

If there is an XML namespace with the given prefix in this XMLToken, then the existing XML namespace will be overwritten by the new one.

Nothing will be done if this XMLToken is not a start element.

Parameters
uria string, the uri for the namespace
prefixa string, the prefix for the namespace
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
Documentation note:
The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.
int XMLToken::append ( const std::string &  chars)

Appends characters to this XML text content.

Parameters
charsstring, characters to append
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int XMLToken::clearAttributes ( )

Clears (deletes) all attributes in this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int XMLToken::clearNamespaces ( )

Clears (deletes) all XML namespace declarations in the XMLNamespaces of this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
XMLToken * XMLToken::clone ( ) const

Creates and returns a deep copy of this XMLToken.

Returns
a (deep) copy of this XMLToken set.
const XMLAttributes & XMLToken::getAttributes ( ) const

Returns the attributes of this element.

Returns
the XMLAttributes of this XML element.
int XMLToken::getAttributesLength ( ) const

Return the number of attributes in the attributes set.

Returns
the number of attributes in the attributes set in this XMLToken.
int XMLToken::getAttrIndex ( const std::string &  name,
const std::string &  uri = "" 
) const

Return the index of an attribute with the given local name and namespace URI.

Parameters
namea string, the local name of the attribute.
uria string, the namespace URI of the attribute.
Returns
the index of an attribute with the given local name and namespace URI, or -1 if not present.
Documentation note:
The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.
int XMLToken::getAttrIndex ( const XMLTriple triple) const

Return the index of an attribute with the given XMLTriple.

Parameters
triplean XMLTriple, the XML triple of the attribute for which the index is required.
Returns
the index of an attribute with the given XMLTriple, or -1 if not present.
std::string XMLToken::getAttrName ( int  index) const

Return the local name of an attribute in the attributes set in this XMLToken (by position).

Parameters
indexan integer, the position of the attribute whose local name is required.
Returns
the local name of an attribute in this list (by position).
Note
If index is out of range, an empty string will be returned. Use XMLToken::hasAttr() to test for the attribute existence.
std::string XMLToken::getAttrPrefix ( int  index) const

Return the prefix of an attribute in the attribute set in this XMLToken (by position).

Parameters
indexan integer, the position of the attribute whose prefix is required.
Returns
the namespace prefix of an attribute in the attribute set (by position).
Note
If index is out of range, an empty string will be returned. Use XMLToken::hasAttr() to test for the attribute existence.
std::string XMLToken::getAttrPrefixedName ( int  index) const

Return the prefixed name of an attribute in the attribute set in this XMLToken (by position).

Parameters
indexan integer, the position of the attribute whose prefixed name is required.
Returns
the prefixed name of an attribute in the attribute set (by position).
Note
If index is out of range, an empty string will be returned. Use XMLToken::hasAttr() to test for attribute existence.
std::string XMLToken::getAttrURI ( int  index) const

Return the namespace URI of an attribute in the attribute set in this XMLToken (by position).

Parameters
indexan integer, the position of the attribute whose namespace URI is required.
Returns
the namespace URI of an attribute in the attribute set (by position).
Note
If index is out of range, an empty string will be returned. Use XMLToken::hasAttr() to test for attribute existence.
std::string XMLToken::getAttrValue ( int  index) const

Return the value of an attribute in the attribute set in this XMLToken (by position).

Parameters
indexan integer, the position of the attribute whose value is required.
Returns
the value of an attribute in the attribute set (by position).
Note
If index is out of range, an empty string will be returned. Use XMLToken::hasAttr() to test for attribute existence.
std::string XMLToken::getAttrValue ( const std::string  name,
const std::string  uri = "" 
) const

Return a value of an attribute with the given local name and namespace URI.

Parameters
namea string, the local name of the attribute whose value is required.
uria string, the namespace URI of the attribute.
Returns
The attribute value as a string.
Note
If an attribute with the given local name and namespace URI does not exist, an empty string will be returned. Use XMLToken::hasAttr() to test for attribute existence.
Documentation note:
The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.
std::string XMLToken::getAttrValue ( const XMLTriple triple) const

Return a value of an attribute with the given XMLTriple.

Parameters
triplean XMLTriple, the XML triple of the attribute whose value is required.
Returns
The attribute value as a string.
Note
If an attribute with the given XMLTriple does not exist, an empty string will be returned. Use XMLToken::hasAttr() to test for attribute existence.
const string & XMLToken::getCharacters ( ) const

Returns the text of this element.

Returns
the characters of this XML text.
unsigned int XMLToken::getColumn ( ) const

Returns the column at which this XMLToken occurred in the input document or data stream.

Returns
the column at which this XMLToken occurred.
unsigned int XMLToken::getLine ( ) const

Returns the line at which this XMLToken occurred in the input document or data stream.

Returns
the line at which this XMLToken occurred.
const string & XMLToken::getName ( ) const

Returns the (unqualified) name of this XML element.

Returns
the (unqualified) name of this XML element.
int XMLToken::getNamespaceIndex ( const std::string &  uri) const

Look up the index of an XML namespace declaration by URI.

Parameters
uria string, uri of the required namespace.
Returns
the index of the given declaration, or -1 if not present.
int XMLToken::getNamespaceIndexByPrefix ( const std::string &  prefix) const

Look up the index of an XML namespace declaration by prefix.

Parameters
prefixa string, prefix of the required namespace.
Returns
the index of the given declaration, or -1 if not present.
std::string XMLToken::getNamespacePrefix ( int  index) const

Look up the prefix of an XML namespace declaration by position.

Callers should use getNamespacesLength() to find out how many namespaces are stored in the XMLNamespaces.

Parameters
indexan 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, an empty string will be returned.
See Also
getNamespacesLength()
std::string XMLToken::getNamespacePrefix ( const std::string &  uri) const

Look up the prefix of an XML namespace declaration by its URI.

Parameters
uria string, the URI of the prefix being sought
Returns
the prefix of an XML namespace declaration given its URI.
Note
If uri does not exist, an empty string will be returned.
const XMLNamespaces & XMLToken::getNamespaces ( ) const

Returns the XML namespace declarations for this XML element.

Returns
the XML namespace declarations for this XML element.
int XMLToken::getNamespacesLength ( ) const

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

Returns
the number of namespaces in this list.
std::string XMLToken::getNamespaceURI ( int  index) const

Look up the URI of an XML namespace declaration by its position.

Parameters
indexan integer, position of the required URI.
Returns
the URI of an XML namespace declaration in the XMLNamespaces (by position).
Note
If index is out of range, an empty string will be returned.
See Also
getNamespacesLength()
std::string XMLToken::getNamespaceURI ( const std::string &  prefix = "") const

Look up the URI of an XML namespace declaration by its prefix.

Parameters
prefixa string, the prefix of the required URI
Returns
the URI of an XML namespace declaration given its prefix.
Note
If prefix does not exist, an empty string will be returned.
Documentation note:
The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.
const string & XMLToken::getPrefix ( ) const

Returns the namespace prefix of this XML element.

Returns
the namespace prefix of this XML element.
Note
If no prefix exists, an empty string will be return.
const string & XMLToken::getURI ( ) const

Returns the namespace URI of this XML element.

Returns
the namespace URI of this XML element.
bool XMLToken::hasAttr ( int  index) const

Predicate returning true or false depending on whether an attribute with the given index exists in the attribute set in this XMLToken.

Parameters
indexan integer, the position of the attribute.
Returns
true if an attribute with the given index exists in the attribute set in this XMLToken, false otherwise.
bool XMLToken::hasAttr ( const std::string  name,
const std::string  uri = "" 
) const

Predicate returning true or false depending on whether an attribute with the given local name and namespace URI exists in the attribute set in this XMLToken.

Parameters
namea string, the local name of the attribute.
uria string, the namespace URI of the attribute.
Returns
true if an attribute with the given local name and namespace URI exists in the attribute set in this XMLToken, false otherwise.
Documentation note:
The native C++ implementation of this method defines a default argument value. In the documentation generated for different libSBML language bindings, you may or may not see corresponding arguments in the method declarations. For example, in Java and C#, a default argument is handled by declaring two separate methods, with one of them having the argument and the other one lacking the argument. However, the libSBML documentation will be identical for both methods. Consequently, if you are reading this and do not see an argument even though one is described, please look for descriptions of other variants of this method near where this one appears in the documentation.
bool XMLToken::hasAttr ( const XMLTriple triple) const

Predicate returning true or false depending on whether an attribute with the given XML triple exists in the attribute set in this XMLToken.

Parameters
triplean XMLTriple, the XML triple of the attribute
Returns
true if an attribute with the given XML triple exists in the attribute set in this XMLToken, false otherwise.
bool XMLToken::hasNamespaceNS ( const std::string &  uri,
const std::string &  prefix 
) const

Predicate returning true or false depending on whether an XML Namespace with the given uri/prefix pair is contained in the XMLNamespaces ofthis XMLToken.

Parameters
uria string, the uri for the namespace
prefixa string, the prefix for the namespace
Returns
true if an XML Namespace with the given uri/prefix pair is contained in the XMLNamespaces of this XMLToken, false otherwise.
bool XMLToken::hasNamespacePrefix ( const std::string &  prefix) const

Predicate returning true or false depending on whether an XML Namespace with the given prefix is contained in the XMLNamespaces of this XMLToken.

Parameters
prefixa string, the prefix for the namespace
Returns
true if an XML Namespace with the given URI is contained in the XMLNamespaces of this XMLToken, false otherwise.
bool XMLToken::hasNamespaceURI ( const std::string &  uri) const

Predicate returning true or false depending on whether an XML Namespace with the given URI is contained in the XMLNamespaces of this XMLToken.

Parameters
uria string, the uri for the namespace
Returns
true if an XML Namespace with the given URI is contained in the XMLNamespaces of this XMLToken, false otherwise.
bool XMLToken::isAttributesEmpty ( ) const

Predicate returning true or false depending on whether the attribute set in this XMLToken set is empty.

Returns
true if the attribute set in this XMLToken is empty, false otherwise.
bool XMLToken::isElement ( ) const

Predicate returning true or false depending on whether this XMLToken is an XML element.

Returns
true if this XMLToken is an XML element, false otherwise.
bool XMLToken::isEnd ( ) const

Predicate returning true or false depending on whether this XMLToken is an XML end element.

Returns
true if this XMLToken is an XML end element, false otherwise.
bool XMLToken::isEndFor ( const XMLToken element) const

Predicate returning true or false depending on whether this XMLToken is an XML end element for the given start element.

Parameters
elementXMLToken, element for which query is made.
Returns
true if this XMLToken is an XML end element for the given XMLToken start element, false otherwise.
bool XMLToken::isEOF ( ) const

Predicate returning true or false depending on whether this XMLToken is an end of file marker.

Returns
true if this XMLToken is an end of file (input) marker, false otherwise.
bool XMLToken::isNamespacesEmpty ( ) const

Predicate returning true or false depending on whether the XMLNamespaces of this XMLToken is empty.

Returns
true if the XMLNamespaces of this XMLToken is empty, false otherwise.
bool XMLToken::isStart ( ) const

Predicate returning true or false depending on whether this XMLToken is an XML start element.

Returns
true if this XMLToken is an XML start element, false otherwise.
bool XMLToken::isText ( ) const

Predicate returning true or false depending on whether this XMLToken is an XML text element.

Returns
true if this XMLToken is an XML text element, false otherwise.
XMLToken & XMLToken::operator= ( const XMLToken rhs)

Assignment operator for XMLToken.

Parameters
rhsThe XMLToken object whose values are used as the basis of the assignment.
Exceptions
XMLConstructorExceptionThrown if the argument rhs is NULL.
int XMLToken::removeAttr ( int  n)

Removes an attribute with the given index from the attribute set in this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Parameters
nan 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:
int XMLToken::removeAttr ( const std::string &  name,
const std::string &  uri = "" 
)

Removes an attribute with the given local name and namespace URI from the attribute set in this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Parameters
namea string, the local name of the attribute.
uria string, the namespace URI of the attribute.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int XMLToken::removeAttr ( const XMLTriple triple)

Removes an attribute with the given XMLTriple from the attribute set in this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Parameters
triplean XMLTriple, the XML triple of the attribute.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int XMLToken::removeNamespace ( int  index)

Removes an XML Namespace stored in the given position of the XMLNamespaces of this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Parameters
indexan integer, position of the removed namespace.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int XMLToken::removeNamespace ( const std::string &  prefix)

Removes an XML Namespace with the given prefix.

Nothing will be done if this XMLToken is not a start element.

Parameters
prefixa string, prefix of the required namespace.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int XMLToken::setAttributes ( const XMLAttributes attributes)

Sets an XMLAttributes to this XMLToken.

Nothing will be done if this XMLToken is not a start element.

Parameters
attributesXMLAttributes to be set to this XMLToken.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
Note
This function replaces the existing XMLAttributes with the new one.
int XMLToken::setEnd ( )

Declares this XML start element is also an end element.

Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int XMLToken::setEOF ( )

Declares this XMLToken is an end-of-file (input) marker.

Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int XMLToken::setNamespaces ( const XMLNamespaces namespaces)

Sets an XMLnamespaces to this XML element.

Nothing will be done if this XMLToken is not a start element.

Parameters
namespacesXMLNamespaces to be set to this XMLToken.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
Note
This function replaces the existing XMLNamespaces with the new one.
int XMLToken::setTriple ( const XMLTriple triple)

Sets the XMLTripe (name, uri and prefix) of this XML element.

Nothing will be done if this XML element is a text node.

Parameters
tripleXMLTriple to be added to this XML element.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
string XMLToken::toString ( )

Prints a string representation of the underlying token stream, for debugging purposes.

int XMLToken::unsetEnd ( )

Declares this XML start/end element is no longer an end element.

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