Modules Namespace List Class Hierarchy Alphabetical List Compound List Namespace Members Compound Members Related Pages
org::w3c::dom::Node Class Reference#include <Node.h>
Inheritance diagram for org::w3c::dom::Node:
List of all members.
Detailed Description
The Node interface is the primary datatype for the entire Document acdk::lang::Object Model.
It represents a single node in the document tree. While all objects implementing the Node interface expose methods for dealing with children, not all objects implementing the Node interface may have children. For example, Text nodes may not have children, and adding children to such nodes results in a DOMException being raised.
The attributes nodeName, nodeValue and attributes are included as a mechanism to get at node information without casting down to the specific derived interface. In cases where there is no obvious mapping of these attributes for a specific nodeType (e.g., nodeValue for an Element or attributes for a Comment ), this returns null. Note that the specialized interfaces may contain additional and more convenient mechanisms to get and set the relevant information.
The values of nodeName, nodeValue, and attributes vary according to the node type as follows:
See also the Document acdk::lang::Object Model (DOM) Level 3 Core Specification.
- Author:
- Roger Rene Kommer
- Version:
- Revision
- 1.21
- Date:
- Date
- 2005/02/13 03:25:57
|
Public Member Functions |
| virtual acdk::lang::RString | getNodeName ()=0 |
| | The name of this node, depending on its type; see the table above.
|
| virtual acdk::lang::RString | getNamespaceURI ()=0 |
| | The namespace URI of this node, or null if it is unspecified (see ).
|
| virtual acdk::lang::RString | getLocalName ()=0 |
| | Returns the local part of the qualified name of this node.
|
| virtual acdk::lang::RString | getBaseURI ()=0 |
| | The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI.
|
| virtual acdk::lang::RString | getPrefix ()=0 |
| | The namespace prefix of this node, or null if it is unspecified.
|
| virtual void | setPrefix (IN(acdk::lang::RString) prefix)=0 throw ( RDOMException ) |
| | The namespace prefix of this node, or null if it is unspecified.
|
| virtual acdk::lang::RString | getNodeValue ()=0 throw ( RDOMException ) |
| | The value of this node, depending on its type; see the table above.
|
| virtual void | setNodeValue (IN(acdk::lang::RString) s)=0 throw ( RDOMException ) |
| | The value of this node, depending on its type; see the table above.
|
| virtual short | getNodeType ()=0 |
| | A code representing the type of the underlying object, as defined above.
|
| virtual RNode | getParentNode ()=0 |
| | The parent of this node.
|
| virtual RNodeList | getChildNodes ()=0 |
| | A NodeList that contains all children of this node.
|
| virtual RNode | getFirstChild ()=0 |
| | The first child of this node.
|
| virtual RNode | getLastChild ()=0 |
| | The last child of this node.
|
| virtual RNode | getPreviousSibling ()=0 |
| | The node immediately preceding this node.
|
| virtual RNode | getNextSibling ()=0 |
| | The node immediately following this node.
|
| virtual RNamedNodeMap | getAttributes ()=0 |
| | A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
|
| virtual RDocument | getOwnerDocument ()=0 |
| | The Document object associated with this node.
|
| virtual RNode | insertBefore (IN(RNode) node, IN(RNode) node1)=0 throw ( RDOMException ) |
| | Inserts the node newChild before the existing child node refChild.
|
| virtual RNode | replaceChild (IN(RNode) node, IN(RNode) node1)=0 throw ( RDOMException ) |
| | Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
|
| virtual RNode | removeChild (IN(RNode) node)=0 throw ( RDOMException ) |
| | Removes the child node indicated by oldChild from the list of children, and returns it.
|
| virtual RNode | appendChild (IN(RNode) node)=0 throw ( RDOMException ) |
| | Adds the node newChild to the end of the list of children of this node.
|
| virtual bool | hasChildNodes ()=0 |
| | Returns whether this node has any children.
|
| virtual RNode | cloneNode (bool deepCopy)=0 |
| | Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
|
| virtual acdk::lang::RString | getTextContent () throw ( org::w3c::dom::RDOMException ) |
| | This attribute returns the text content of this node and its descendants.
|
| virtual void | setTextContent (IN(acdk::lang::RString) textContent) throw ( org::w3c::dom::RDOMException ) |
| | This attribute returns the text content of this node and its descendants.
|
| virtual RNode | selectNode (IN(acdk::lang::RString) xpath)=0 |
| virtual RNodeList | selectNodes (IN(acdk::lang::RString) xpath)=0 |
| virtual acdk::lang::RObject | selectObject (IN(acdk::lang::RString) xpath) |
| | may return Node, NodeList, String Boolean or Number
|
| virtual acdk::lang::RString | selectText (IN(acdk::lang::RString) xpath) |
| | select a string.
|
| virtual acdk::lang::RNumber | selectNumber (IN(acdk::lang::RString) xpath) |
| virtual acdk::lang::RBoolean | selectBoolean (IN(acdk::lang::RString) xpath) |
| virtual acdk::lang::RString | toXML () |
| | dom4j like extension
|
| virtual void | write (IN(acdk::io::RWriter) out, int writeFlags=NWFWDefaultFlags, int indentLevel=0, IN(acdk::lang::RString) encoding=Nil) |
| | write this node
|
| virtual int | getChildCount () |
| | dom4j like extension return the number of child nodes
|
| virtual RNode | getChild (int idx) |
| virtual bool | isEqualNode (IN(RNode) other)=0 |
| | Tests whether two nodes are equal.
|
| virtual RNode | detach () |
| | remove this node from this document
|
Member Function Documentation
|
|
Adds the node newChild to the end of the list of children of this node.
If the newChild is already in the tree, it is first removed. - Parameters:
-
| newChild | The node to add.If it is a DocumentFragment object, the entire contents of the document fragment are moved into the child list of this node |
- Returns:
- The node added.
- Exceptions:
-
| DOMException | HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to append is one of this node's ancestors or this node itself, or if this node is of type Document and the DOM application attempts to append a second DocumentType or Element node.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the previous parent of the node being inserted is readonly.
NOT_SUPPORTED_ERR: if the newChild node is a child of the Document node, this exception might be raised if the DOM implementation doesn't support the removal of the DocumentType child or Element child. |
- Version:
- DOM Level 3
Implemented in acdk::xml::dom::XMLNode. |
| virtual RNode org::w3c::dom::Node::cloneNode |
( |
bool |
deepCopy |
) |
[pure virtual] |
|
|
|
Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
The duplicate node has no parent ( parentNode is null) and no user data. User data associated to the imported node is not carried over. However, if any UserDataHandlers has been specified along with the associated data these handlers will be called with the appropriate parameters before this method returns.
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 children it contains unless it is a deep clone. This includes text contained in an the Element since the text is contained in a child Text node. Cloning an Attr directly, as opposed to be cloned as part of an Element cloning operation, returns a specified attribute (specified is true). Cloning an Attr always clones its children, since they represent its value, no matter whether this is a deep clone or not. Cloning an EntityReference automatically constructs its subtree if a corresponding Entity is available, no matter whether this is a deep clone or not. Cloning any other type of node simply returns a copy of this node.
Note that cloning an immutable subtree results in a mutable copy, but the children of an EntityReference clone are readonly . In addition, clones of unspecified Attr nodes are specified. And, cloning Document, DocumentType, Entity, and Notation nodes is implementation dependent. - Parameters:
-
| 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). |
- Returns:
- The duplicate node.
Implemented in acdk::xml::dom::XMLNode, and acdk::xml::libxmldom::LibXMLNode. |
| virtual RNode org::w3c::dom::Node::detach |
( |
|
) |
[virtual] |
|
|
|
remove this node from this document
|
| virtual RNamedNodeMap org::w3c::dom::Node::getAttributes |
( |
|
) |
[pure virtual] |
|
|
|
The absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI.
This value is computed as described in . However, when the Document supports the feature HTML [DOM Level 2 HTML] , the base URI is computed using first the value of the href attribute of the HTML BASE element if any, and the value of the documentURI attribute from the Document interface otherwise. - Since:
- DOM Level 3
Implemented in acdk::xml::dom::XMLNode, and acdk::xml::libxmldom::LibXMLNode. |
| virtual RNode org::w3c::dom::Node::getChild |
( |
int |
idx |
) |
[virtual] |
|
| virtual int org::w3c::dom::Node::getChildCount |
( |
|
) |
[virtual] |
|
| virtual RNodeList org::w3c::dom::Node::getChildNodes |
( |
|
) |
[pure virtual] |
|
| virtual RNode org::w3c::dom::Node::getFirstChild |
( |
|
) |
[pure virtual] |
|
| virtual RNode org::w3c::dom::Node::getLastChild |
( |
|
) |
[pure virtual] |
|
|
|
The namespace URI of this node, or null if it is unspecified (see ).
This is not a computed value that is the result of a namespace lookup based on an examination of the namespace declarations in scope. It is merely the namespace URI given at creation time.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as Document::createElement(), this is always null. <p >Note: Per the Namespaces in XML Specification [XML Namespaces] an attribute does not inherit its namespace from the element it is attached to. If an attribute is not explicitly given a namespace, it simply has no namespace. - Since:
- DOM Level 2
Implemented in acdk::xml::dom::XMLNode, and acdk::xml::libxmldom::LibXMLNode. |
| virtual RNode org::w3c::dom::Node::getNextSibling |
( |
|
) |
[pure virtual] |
|
| virtual short org::w3c::dom::Node::getNodeType |
( |
|
) |
[pure virtual] |
|
| virtual RDocument org::w3c::dom::Node::getOwnerDocument |
( |
|
) |
[pure virtual] |
|
| virtual RNode org::w3c::dom::Node::getParentNode |
( |
|
) |
[pure virtual] |
|
|
|
The namespace prefix of this node, or null if it is unspecified.
When it is defined to be null, setting it has no effect, including if the node is read-only.
Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable.
Setting the prefix to null makes it unspecified, setting it to an empty string is implementation dependent.
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 namespaceURI and localName do not change.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null. - Since:
- DOM Level 2
Implemented in acdk::xml::dom::XMLNode, and acdk::xml::libxmldom::LibXMLNode. |
| virtual RNode org::w3c::dom::Node::getPreviousSibling |
( |
|
) |
[pure virtual] |
|
|
|
This attribute returns the text content of this node and its descendants.
When it is defined to be null, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty or null, replaced by a single Text node containing the string this attribute is set to.
On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attribute Text.isElementContentWhitespace). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:
| Node type | Content |
| ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE | concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children. |
| TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE | nodeValue |
| DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | null |
- Exceptions:
-
| DOMException | DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform. |
- Since:
- DOM Level 3
Reimplemented in acdk::xml::libxmldom::LibXMLNode. |
| virtual bool org::w3c::dom::Node::hasChildNodes |
( |
|
) |
[pure virtual] |
|
|
|
Inserts the node newChild before the existing child node refChild.
If refChild is null, insert newChild 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 refChild. If the newChild is already in the tree, it is first removed. <p >Note: Inserting a node before itself is implementation dependent. - Parameters:
-
| newChild | The node to insert. |
| refChild | The reference node, i.e., the node before which the new node must be inserted. |
- Returns:
- The node being inserted.
- Exceptions:
-
| DOMException | HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to insert is one of this node's ancestors or this node itself, or if this node is of type Document and the DOM application attempts to insert a second DocumentType or Element node.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the parent of the node being inserted is readonly.
NOT_FOUND_ERR: Raised if refChild is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of type Document, this exception might be raised if the DOM implementation doesn't support the insertion of a DocumentType or Element node. |
- Version:
- DOM Level 3
Implemented in acdk::xml::dom::XMLNode. |
| virtual bool org::w3c::dom::Node::isEqualNode |
( |
IN(RNode) |
other |
) |
[pure virtual] |
|
|
|
Tests whether two nodes are equal.
This method tests for equality of nodes, not sameness (i.e., whether the two nodes are references to the same object) which can be tested with Node.isSameNode(). All nodes that are the same will also be equal, though the reverse may not be true.
Two nodes are equal if and only if the following conditions are satisfied:
-
The two nodes are of the same type.
-
The following string attributes are equal:
nodeName, localName, namespaceURI, prefix, nodeValue . This is: they are both null, or they have the same length and are character for character identical.
-
The
attributes NamedNodeMaps are equal. This is: they are both null, or they have the same length and for each node that exists in one map there is a node that exists in the other map and is equal, although not necessarily at the same index.
-
The
childNodes NodeLists are equal. This is: they are both null, or they have the same length and contain equal nodes at the same index. Note that normalization can affect equality; to avoid this, nodes should be normalized before being compared.
For two DocumentType nodes to be equal, the following conditions must also be satisfied:
-
The following string attributes are equal:
publicId, systemId, internalSubset.
-
The
entities NamedNodeMaps are equal.
-
The
notations NamedNodeMaps are equal.
On the other hand, the following do not affect equality: the ownerDocument, baseURI, and parentNode attributes, the specified attribute for Attr nodes, the schemaTypeInfo attribute for Attr and Element nodes, the Text.isElementContentWhitespace attribute for Text nodes, as well as any user data or event listeners registered on the nodes. <p >Note: As a general rule, anything not mentioned in the description above is not significant in consideration of equality checking. Note that future versions of this specification may take into account more attributes and implementations conform to this specification are expected to be updated accordingly. - Parameters:
-
| arg | The node to compare equality with. |
- Returns:
- Returns
true if the nodes are equal, false otherwise.
- Since:
- DOM Level 3
|
|
|
Removes the child node indicated by oldChild from the list of children, and returns it.
- Parameters:
-
| oldChild | The node being removed. |
- Returns:
- The node removed.
- Exceptions:
-
| DOMException | NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of type Document, this exception might be raised if the DOM implementation doesn't support the removal of the DocumentType child or the Element child. |
- Version:
- DOM Level 3
Implemented in acdk::xml::dom::XMLNode. |
|
|
Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order. If the newChild is already in the tree, it is first removed. <p >Note: Replacing a node with itself is implementation dependent. - Parameters:
-
| newChild | The new node to put in the child list. |
| oldChild | The node being replaced in the list. |
- Returns:
- The node replaced.
- Exceptions:
-
| DOMException | HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to put in is one of this node's ancestors or this node itself, or if this node is of type Document and the result of the replacement operation would add a second DocumentType or Element on the Document node.
WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the new node is readonly.
NOT_FOUND_ERR: Raised if oldChild is not a child of this node.
NOT_SUPPORTED_ERR: if this node is of type Document, this exception might be raised if the DOM implementation doesn't support the replacement of the DocumentType child or Element child. |
- Version:
- DOM Level 3
Implemented in acdk::xml::dom::XMLNode. |
|
|
The value of this node, depending on its type; see the table above.
When it is defined to be null, setting it has no effect, including if the node is read-only. - Exceptions:
-
| DOMException | NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly and if it is not defined to be null. |
|
|
|
The namespace prefix of this node, or null if it is unspecified.
When it is defined to be null, setting it has no effect, including if the node is read-only.
Note that setting this attribute, when permitted, changes the nodeName attribute, which holds the qualified name, as well as the tagName and name attributes of the Element and Attr interfaces, when applicable.
Setting the prefix to null makes it unspecified, setting it to an empty string is implementation dependent.
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 namespaceURI and localName do not change.
For nodes of any type other than ELEMENT_NODE and ATTRIBUTE_NODE and nodes created with a DOM Level 1 method, such as createElement from the Document interface, this is always null. - Exceptions:
-
| DOMException | INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character according to the XML version in use specified in the Document.xmlVersion attribute.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the specified prefix is malformed per the Namespaces in XML specification, if the namespaceURI of this node is null, if the specified prefix is xml and the namespaceURI of this node is different from http://www.w3.org/XML/1998/namespace, if this node is an attribute and the specified prefix is xmlns and the namespaceURI of this node is different from <a href='http://www.w3.org/2000/xmlns/'>http://www.w3.org/2000/xmlns/</a>, or if this node is an attribute and the qualifiedName of this node is xmlns [XML Namespaces] |
- Since:
- DOM Level 2
Implemented in acdk::xml::dom::XMLNode. |
|
|
This attribute returns the text content of this node and its descendants.
When it is defined to be null, setting it has no effect. On setting, any possible children this node may have are removed and, if it the new string is not empty or null, replaced by a single Text node containing the string this attribute is set to.
On getting, no serialization is performed, the returned string does not contain any markup. No whitespace normalization is performed and the returned string does not contain the white spaces in element content (see the attribute Text.isElementContentWhitespace). Similarly, on setting, no parsing is performed either, the input string is taken as pure textual content.
The string returned is made of the text content of this node depending on its type, as defined below:
| Node type | Content |
| ELEMENT_NODE, ATTRIBUTE_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, DOCUMENT_FRAGMENT_NODE | concatenation of the textContent attribute value of every child node, excluding COMMENT_NODE and PROCESSING_INSTRUCTION_NODE nodes. This is the empty string if the node has no children. |
| TEXT_NODE, CDATA_SECTION_NODE, COMMENT_NODE, PROCESSING_INSTRUCTION_NODE | nodeValue |
| DOCUMENT_NODE, DOCUMENT_TYPE_NODE, NOTATION_NODE | null |
- Exceptions:
-
| DOMException | NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. |
- Since:
- DOM Level 3
|
|
|
dom4j like extension
- Todo:
- implement in derived interfaces
Reimplemented in acdk::xml::dom::XMLCDATASection, acdk::xml::dom::XMLCharacterData, acdk::xml::dom::XMLComment, acdk::xml::dom::XMLDocument, acdk::xml::dom::XMLElement, acdk::xml::dom::XMLNode, acdk::xml::dom::XMLText, acdk::xml::libxmldom::LibXMLCDATASection, acdk::xml::libxmldom::LibXMLCharacterData, acdk::xml::libxmldom::LibXMLComment, acdk::xml::libxmldom::LibXMLDocument, acdk::xml::libxmldom::LibXMLDocumentType, acdk::xml::libxmldom::LibXMLElement, acdk::xml::libxmldom::LibXMLEntity, acdk::xml::libxmldom::LibXMLEntityReference, acdk::xml::libxmldom::LibXMLNode, acdk::xml::libxmldom::LibXMLNotation, acdk::xml::libxmldom::LibXMLText, and org::w3c::dom::DocumentType. |
| virtual void org::w3c::dom::Node::write |
( |
IN(acdk::io::RWriter) |
out, |
|
|
int |
writeFlags = NWFWDefaultFlags, |
|
|
int |
indentLevel = 0, |
|
|
IN(acdk::lang::RString) |
encoding = Nil |
|
) |
[inline, virtual] |
|
|
|
write this node
- Parameters:
-
| out | a byte writer |
| writeFlags | a combination of NodeWriteFlags |
| indentLevel | number of indention. Is not supported if written as HTML |
| encoding | string one of UTF-8 HTML US-ASCII ASCII ISO-8859-1 UTF-16 UTF-16BE UTF-16LE |
|
|
2005/5/9
Node
