DOM Attribute class. More...
#include <dom_attr.h>
Public Member Functions | |
Construction | |
CL_DomAttr () | |
Constructs a DOM Attr handle. | |
CL_DomAttr (CL_DomDocument doc, const CL_DomString &name, const CL_DomString &namespace_uri=CL_DomString()) | |
Constructs a DomAttr. | |
CL_DomAttr (const CL_SharedPtr< CL_DomNode_Generic > &impl) | |
Constructs a DomAttr. | |
~CL_DomAttr () | |
Attributes | |
CL_DomString | get_name () const |
Returns the name of this attribute. | |
bool | get_specified () const |
If this attribute was explicitly given a value in the original document, this is true; otherwise, it is false. | |
CL_DomString | get_value () const |
Returns the value of the attribute. | |
void | set_value (const CL_DomString &value) |
Sets the value of the attribute. | |
CL_DomElement | get_owner_element () const |
Returns the attribute's owner element. | |
Operations | |
bool | operator== (const CL_DomNode &other) const |
Compare operator. | |
bool | operator!= (const CL_DomNode &other) const |
Compare operator. | |
void | normalize () |
Merges any adjacent Text nodes. | |
CL_DomNode | insert_before (CL_DomNode &new_child, CL_DomNode &ref_child) |
Inserts the node new_child before the existing child node ref_child. | |
CL_DomNode | replace_child (CL_DomNode &new_child, CL_DomNode &old_child) |
Replaces the child node old_child with new_child in the list of children. | |
CL_DomNode | remove_child (CL_DomNode &old_child) |
Removes the child node indicated by old_child from the list of children, and returns it. | |
CL_DomNode | append_child (CL_DomNode new_child) |
Adds the node new_child to the end of the list of children of this node. | |
CL_DomNode | clone_node (bool deep) const |
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. | |
CL_DomElement | to_element () const |
Returns the Element interface to this node. | |
CL_DomAttr | to_attr () const |
Returns the Attribute interface to this node. | |
CL_DomText | to_text () const |
Returns the Text interface to this node. | |
CL_DomCDATASection | to_cdata_section () const |
Returns the CDATA Section interface to this node. | |
CL_DomEntityReference | to_entity_reference () const |
Returns the Entity Reference interface to this node. | |
CL_DomEntity | to_entity () const |
Returns the Entity interface to this node. | |
CL_DomProcessingInstruction | to_processing_instruction () const |
Returns the Processing Instruction interface to this node. | |
CL_DomComment | to_comment () const |
Returns the Comment interface to this node. | |
CL_DomDocument | to_document () const |
Returns the Document interface to this node. | |
CL_DomDocumentType | to_document_type () const |
Returns the Document Type interface to this node. | |
CL_DomDocumentFragment | to_document_fragment () const |
Returns the Document Fragment interface to this node. | |
CL_DomNotation | to_notation () const |
Returns the Notation interface to this node. | |
CL_DomNode | named_item (const CL_DomString &name) const |
Returns the first child node with the specified node name. | |
CL_DomNode | named_item_ns (const CL_DomString &namespace_uri, const CL_DomString &local_name) const |
Retrieves the first child node with the specified namespace URI and local name. | |
CL_DomString | find_namespace_uri (const CL_DomString &qualified_name) const |
Searches the node tree upwards for the namespace URI of the given qualified name. | |
CL_DomString | find_prefix (const CL_DomString &namespace_uri) const |
Searches the node tree upwards for the prefix name for the namespace URI. | |
std::vector< CL_DomNode > | select_nodes (const CL_DomString &xpath_expression) const |
Returns all the nodes matching the specified xpath expression using this node as the context node. | |
CL_DomNode | select_node (const CL_DomString &xpath_expression) const |
Returns the first node matching the specified xpath expression using this node as the context node. | |
CL_String | select_string (const CL_DomString &xpath_expression) const |
Returns the first node value matching the specified xpath expression using this node as the context node. | |
int | select_int (const CL_DomString &xpath_expression) const |
Returns the first node value (as integer) matching the specified xpath expression using this node as the context node. | |
float | select_float (const CL_DomString &xpath_expression) const |
Returns the first node value (as float) matching the specified xpath expression using this node as the context node. | |
bool | select_bool (const CL_DomString &xpath_expression) const |
Returns the first node value (as boolean) matching the specified xpath expression using this node as the context node. | |
Attributes | |
| |
CL_DomString | get_node_name () const |
Returns the node name. | |
CL_DomString | get_namespace_uri () const |
Returns the namespace URI of this node. | |
CL_DomString | get_prefix () const |
Returns the namespace prefix of the node. | |
void | set_prefix (const CL_DomString &prefix) |
Sets the namespace prefix of the node. | |
CL_DomString | get_local_name () const |
Returns local part of the qualified name of this node. | |
CL_DomString | get_node_value () const |
Returns the node value. | |
void | set_node_value (const CL_DomString &value) |
Sets the node value. | |
unsigned short | get_node_type () const |
Returns the node type (one of those in the NodeType enum). | |
CL_DomNode | get_parent_node () const |
Returns the parent of this node. | |
CL_DomNodeList | get_child_nodes () const |
Returns a NodeList that contains all children of this node. | |
CL_DomNode | get_first_child () const |
The first child of this node. | |
CL_DomNode | get_last_child () const |
The last child of this node. | |
CL_DomNode | get_previous_sibling () const |
The node immediately preceding this node. | |
CL_DomNode | get_next_sibling () const |
The node immediately following this node. | |
CL_DomNamedNodeMap | get_attributes () const |
A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise. | |
CL_DomDocument | get_owner_document () const |
The Document object associated with this node. | |
bool | is_null () const |
Returns true if this is a null node. | |
bool | is_element () const |
Returns true if this is an element node. | |
bool | is_attr () const |
Returns true if this is an attribute node. | |
bool | is_text () const |
Returns true if this is a text node. | |
bool | is_cdata_section () const |
Returns true if this is a CDATA section node. | |
bool | is_entity_reference () const |
Returns true if this is an entity reference node. | |
bool | is_entity () const |
Returns true if this is an entity node. | |
bool | is_processing_instruction () const |
Returns true if this is a processing instruction node. | |
bool | is_comment () const |
Returns true if this is a comment node. | |
bool | is_document () const |
Returns true if this is a document node. | |
bool | is_document_type () const |
Returns true if this is a document type node. | |
bool | is_document_fragment () const |
Returns true if this is a document fragment node. | |
bool | is_notation () const |
Returns true if this is a notation node. | |
bool | is_supported (const CL_DomString &feature, const CL_DomString &version) const |
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node. | |
bool | has_attributes () const |
Returns true if this node (if its an element) has any attributes. | |
bool | has_child_nodes () const |
Returns true if this node has any children. | |
enum | NodeType { NULL_NODE = 0, ELEMENT_NODE = 1, ATTRIBUTE_NODE = 2, TEXT_NODE = 3, CDATA_SECTION_NODE = 4, ENTITY_REFERENCE_NODE = 5, ENTITY_NODE = 6, PROCESSING_INSTRUCTION_NODE = 7, COMMENT_NODE = 8, DOCUMENT_NODE = 9, DOCUMENT_TYPE_NODE = 10, DOCUMENT_FRAGMENT_NODE = 11, NOTATION_NODE = 12 } |
An integer indicating which type of node this is. More... | |
Implementation | |
| |
CL_SharedPtr< CL_DomNode_Generic > | impl |
class | CL_DomDocument |
class | CL_DomNamedNodeMap |
DOM Attribute class.
The Attr interface represents an attribute in an Element object. Typically the allowable values for the attribute are defined in a document type definition.
Attr objects inherit the Node interface, but since they are not actually child nodes of the element they describe, the DOM does not consider them part of the document tree. Thus, the Node attributes parentNode, previousSibling, and nextSibling have a null value for Attr objects. The DOM takes the view that attributes are properties of elements rather than having a separate identity from the elements they are associated with; this should make it more efficient to implement such features as default attributes associated with all elements of a given type. Furthermore, Attr nodes may not be immediate children of a DocumentFragment. However, they can be associated with Element nodes contained within a DocumentFragment. In short, users and implementors of the DOM need to be aware that Attr nodes have some things in common with other objects inheriting the Node interface, but they also are quite distinct.
The attribute's effective value is determined as follows: if this attribute has been explicitly assigned any value, that value is the attribute's effective value; otherwise, if there is a declaration for this attribute, and that declaration includes a default value, then that default value is the attribute's effective value; otherwise, the attribute does not exist on this element in the structure model until it has been explicitly added. Note that the nodeValue attribute on the Attr instance can also be used to retrieve the string version of the attribute's value(s).
In XML, where the value of an attribute can contain entity references, the child nodes of the Attr node provide a representation in which entity references are not expanded. These child nodes may be either Text or EntityReference nodes. Because the attribute type may be unknown, there are no tokenized attribute values.
enum CL_DomNode::NodeType [inherited] |
CL_DomAttr::CL_DomAttr | ( | ) |
Constructs a DOM Attr handle.
CL_DomAttr::CL_DomAttr | ( | CL_DomDocument | doc, | |
const CL_DomString & | name, | |||
const CL_DomString & | namespace_uri = CL_DomString() | |||
) |
Constructs a DomAttr.
doc | = Dom Document | |
name | = Dom String | |
namespace_uri | = Dom String |
CL_DomAttr::CL_DomAttr | ( | const CL_SharedPtr< CL_DomNode_Generic > & | impl | ) |
Constructs a DomAttr.
impl | = Shared Ptr |
CL_DomAttr::~CL_DomAttr | ( | ) |
CL_DomNode CL_DomNode::append_child | ( | CL_DomNode | new_child | ) | [inherited] |
Adds the node new_child to the end of the list of children of this node.
If the new_child is already in the tree, it is first removed.
CL_DomNode CL_DomNode::clone_node | ( | bool | deep | ) | const [inherited] |
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
The duplicate node has no parent.
Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a child Text node. Cloning any other type of node simply returns a copy of this node.
deep | If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element). retval: The duplicate node. |
CL_DomString CL_DomNode::find_namespace_uri | ( | const CL_DomString & | qualified_name | ) | const [inherited] |
Searches the node tree upwards for the namespace URI of the given qualified name.
CL_DomString CL_DomNode::find_prefix | ( | const CL_DomString & | namespace_uri | ) | const [inherited] |
Searches the node tree upwards for the prefix name for the namespace URI.
CL_DomNamedNodeMap CL_DomNode::get_attributes | ( | ) | const [inherited] |
A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
CL_DomNodeList CL_DomNode::get_child_nodes | ( | ) | const [inherited] |
Returns a NodeList that contains all children of this node.
If there are no children, this is a NodeList containing no nodes. The content of the returned NodeList is "live" in the sense that, for instance, changes to the children of the node object that it was created from are immediately reflected in the nodes returned by the NodeList accessors; it is not a static snapshot of the content of the node. This is true for every NodeList, including the ones returned by the getElementsByTagName method.
CL_DomNode CL_DomNode::get_first_child | ( | ) | const [inherited] |
The first child of this node.
If there is no such node, this returns a null node.
CL_DomNode CL_DomNode::get_last_child | ( | ) | const [inherited] |
The last child of this node.
If there is no such node, this returns a null node.
CL_DomString CL_DomNode::get_local_name | ( | ) | const [inherited] |
Returns local part of the qualified name of this node.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as create_element from the Document interface, this is always an empty string.
CL_DomString CL_DomAttr::get_name | ( | ) | const |
Returns the name of this attribute.
CL_DomString CL_DomNode::get_namespace_uri | ( | ) | const [inherited] |
Returns the namespace URI of this node.
CL_DomNode CL_DomNode::get_next_sibling | ( | ) | const [inherited] |
The node immediately following this node.
If there is no such node, this returns a null node.
CL_DomString CL_DomNode::get_node_name | ( | ) | const [inherited] |
Returns the node name.
The return value vary according to the node type as follows:
unsigned short CL_DomNode::get_node_type | ( | ) | const [inherited] |
Returns the node type (one of those in the NodeType enum).
CL_DomString CL_DomNode::get_node_value | ( | ) | const [inherited] |
Returns the node value.
The return value vary according to the node type as follows:
CL_DomDocument CL_DomNode::get_owner_document | ( | ) | const [inherited] |
The Document object associated with this node.
This is also the Document object used to create new nodes. When this node is a Document this is null.
CL_DomElement CL_DomAttr::get_owner_element | ( | ) | const |
Returns the attribute's owner element.
The Element node this attribute is attached to or null if this attribute is not in use.
CL_DomNode CL_DomNode::get_parent_node | ( | ) | const [inherited] |
Returns the parent of this node.
All nodes, except Document, DocumentFragment, and Attr may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is null.
CL_DomString CL_DomNode::get_prefix | ( | ) | const [inherited] |
Returns the namespace prefix of the node.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as create_element from the Document interface, this is always an empty string.
CL_DomNode CL_DomNode::get_previous_sibling | ( | ) | const [inherited] |
The node immediately preceding this node.
If there is no such node, this returns a null node.
bool CL_DomAttr::get_specified | ( | ) | const |
If this attribute was explicitly given a value in the original document, this is true; otherwise, it is false.
CL_DomString CL_DomAttr::get_value | ( | ) | const |
Returns the value of the attribute.
bool CL_DomNode::has_attributes | ( | ) | const [inherited] |
Returns true if this node (if its an element) has any attributes.
bool CL_DomNode::has_child_nodes | ( | ) | const [inherited] |
Returns true if this node has any children.
CL_DomNode CL_DomNode::insert_before | ( | CL_DomNode & | new_child, | |
CL_DomNode & | ref_child | |||
) | [inherited] |
Inserts the node new_child before the existing child node ref_child.
If refChild is a null node, inserts new_child at the end of the list of children.
If newChild is a DocumentFragment object, all of its children are inserted, in the same order, before ref_child. If the new_child is already in the tree, it is first removed.
new_child | The node to insert. | |
ref_child | The reference node, i.e., the node before which the new node must be inserted. retval: The node being inserted. |
bool CL_DomNode::is_attr | ( | ) | const [inherited] |
Returns true if this is an attribute node.
bool CL_DomNode::is_cdata_section | ( | ) | const [inherited] |
Returns true if this is a CDATA section node.
bool CL_DomNode::is_comment | ( | ) | const [inherited] |
Returns true if this is a comment node.
bool CL_DomNode::is_document | ( | ) | const [inherited] |
Returns true if this is a document node.
bool CL_DomNode::is_document_fragment | ( | ) | const [inherited] |
Returns true if this is a document fragment node.
bool CL_DomNode::is_document_type | ( | ) | const [inherited] |
Returns true if this is a document type node.
bool CL_DomNode::is_element | ( | ) | const [inherited] |
Returns true if this is an element node.
bool CL_DomNode::is_entity | ( | ) | const [inherited] |
Returns true if this is an entity node.
bool CL_DomNode::is_entity_reference | ( | ) | const [inherited] |
Returns true if this is an entity reference node.
bool CL_DomNode::is_notation | ( | ) | const [inherited] |
Returns true if this is a notation node.
bool CL_DomNode::is_null | ( | ) | const [inherited] |
Returns true if this is a null node.
bool CL_DomNode::is_processing_instruction | ( | ) | const [inherited] |
Returns true if this is a processing instruction node.
bool CL_DomNode::is_supported | ( | const CL_DomString & | feature, | |
const CL_DomString & | version | |||
) | const [inherited] |
Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
bool CL_DomNode::is_text | ( | ) | const [inherited] |
Returns true if this is a text node.
CL_DomNode CL_DomNode::named_item | ( | const CL_DomString & | name | ) | const [inherited] |
Returns the first child node with the specified node name.
Returns a null node if no child is found.
CL_DomNode CL_DomNode::named_item_ns | ( | const CL_DomString & | namespace_uri, | |
const CL_DomString & | local_name | |||
) | const [inherited] |
Retrieves the first child node with the specified namespace URI and local name.
void CL_DomNode::normalize | ( | ) | [inherited] |
Merges any adjacent Text nodes.
Puts all Text nodes in the full depth of the sub-tree underneath this node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes.
This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer lookups) that depend on a particular document tree structure are to be used.
Note: In cases where the document contains CDATASections, the normalize operation alone may not be sufficient, since XPointers do not differentiate between Text nodes and CDATASection nodes.
bool CL_DomNode::operator!= | ( | const CL_DomNode & | other | ) | const [inherited] |
Compare operator.
bool CL_DomNode::operator== | ( | const CL_DomNode & | other | ) | const [inherited] |
Compare operator.
CL_DomNode CL_DomNode::remove_child | ( | CL_DomNode & | old_child | ) | [inherited] |
Removes the child node indicated by old_child from the list of children, and returns it.
CL_DomNode CL_DomNode::replace_child | ( | CL_DomNode & | new_child, | |
CL_DomNode & | old_child | |||
) | [inherited] |
Replaces the child node old_child with new_child in the list of children.
If the new_child is already in the tree, it is first removed.
new_child | The new node to put in the child list. | |
old_child | The node being replaced in the list. retval: The node replaced. |
bool CL_DomNode::select_bool | ( | const CL_DomString & | xpath_expression | ) | const [inherited] |
Returns the first node value (as boolean) matching the specified xpath expression using this node as the context node.
float CL_DomNode::select_float | ( | const CL_DomString & | xpath_expression | ) | const [inherited] |
Returns the first node value (as float) matching the specified xpath expression using this node as the context node.
int CL_DomNode::select_int | ( | const CL_DomString & | xpath_expression | ) | const [inherited] |
Returns the first node value (as integer) matching the specified xpath expression using this node as the context node.
CL_DomNode CL_DomNode::select_node | ( | const CL_DomString & | xpath_expression | ) | const [inherited] |
Returns the first node matching the specified xpath expression using this node as the context node.
std::vector<CL_DomNode> CL_DomNode::select_nodes | ( | const CL_DomString & | xpath_expression | ) | const [inherited] |
Returns all the nodes matching the specified xpath expression using this node as the context node.
CL_String CL_DomNode::select_string | ( | const CL_DomString & | xpath_expression | ) | const [inherited] |
Returns the first node value matching the specified xpath expression using this node as the context node.
void CL_DomNode::set_node_value | ( | const CL_DomString & | value | ) | [inherited] |
Sets the node value.
void CL_DomNode::set_prefix | ( | const CL_DomString & | prefix | ) | [inherited] |
Sets the namespace prefix of the node.
Note that setting this attribute, when permitted, changes the node_name attribute, which holds the qualified name, as well as the tag_name and name attributes of the Element and Attr interfaces, when applicable.
Note also that changing the prefix of an attribute that is known to have a default value, does not make a new attribute with the default value and the original prefix appear, since the namespace_uri and local_name do not change.
void CL_DomAttr::set_value | ( | const CL_DomString & | value | ) |
Sets the value of the attribute.
CL_DomAttr CL_DomNode::to_attr | ( | ) | const [inherited] |
Returns the Attribute interface to this node.
If the node is not an Attribute node, then it returns a null node.
CL_DomCDATASection CL_DomNode::to_cdata_section | ( | ) | const [inherited] |
Returns the CDATA Section interface to this node.
If the node is not a CDATA Section node, then it returns a null node.
CL_DomComment CL_DomNode::to_comment | ( | ) | const [inherited] |
Returns the Comment interface to this node.
If the node is not a Comment node, then it returns a null node.
CL_DomDocument CL_DomNode::to_document | ( | ) | const [inherited] |
Returns the Document interface to this node.
If the node is not a Document node, then it returns a null node.
CL_DomDocumentFragment CL_DomNode::to_document_fragment | ( | ) | const [inherited] |
Returns the Document Fragment interface to this node.
If the node is not a DocumentFragment node, then it returns a null node.
CL_DomDocumentType CL_DomNode::to_document_type | ( | ) | const [inherited] |
Returns the Document Type interface to this node.
If the node is not a Document Type node, then it returns a null node.
CL_DomElement CL_DomNode::to_element | ( | ) | const [inherited] |
Returns the Element interface to this node.
If the node is not an Element node, then it returns a null node.
CL_DomEntity CL_DomNode::to_entity | ( | ) | const [inherited] |
Returns the Entity interface to this node.
If the node is not an Entity node, then it returns a null node.
CL_DomEntityReference CL_DomNode::to_entity_reference | ( | ) | const [inherited] |
Returns the Entity Reference interface to this node.
If the node is not an Entity Reference node, then it returns a null node.
CL_DomNotation CL_DomNode::to_notation | ( | ) | const [inherited] |
Returns the Notation interface to this node.
If the node is not a Notation node, then it returns a null node.
CL_DomProcessingInstruction CL_DomNode::to_processing_instruction | ( | ) | const [inherited] |
Returns the Processing Instruction interface to this node.
If the node is not a Processing Instrucion node, then it returns a null node.
CL_DomText CL_DomNode::to_text | ( | ) | const [inherited] |
Returns the Text interface to this node.
If the node is not a Text node, then it returns a null node.
friend class CL_DomDocument [friend, inherited] |
friend class CL_DomNamedNodeMap [friend, inherited] |
CL_SharedPtr<CL_DomNode_Generic> CL_DomNode::impl [protected, inherited] |