http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Download
Installation
Build

API Docs
Samples
Schema

FAQs
Programming
Migration

Releases
Bug-Reporting
Feedback

Y2K Compliance
PDF Document

CVS Repository
Mail Archive

API Docs for SAX and DOM
 

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

IDOM_Element Class Reference

By far the vast majority of objects (apart from text) that authors encounter when traversing a document are IDOM_Element nodes. More...

#include <IDOM_Element.hpp>

Inheritance diagram for IDOM_Element

Inheritance graph
[legend]
Collaboration diagram for IDOM_Element:

Collaboration graph
[legend]
List of all members.

Public Methods

Destructor.
virtual ~IDOM_Element ()
 Destructor. More...

Getter functions.
virtual const XMLCh* getTagName ()const=0
 The name of the element. More...

virtual const XMLCh* getAttribute (const XMLCh *name)const=0
 Retrieves an attribute value by name. More...

virtual IDOM_AttrgetAttributeNode (const XMLCh *name)const=0
 Retrieves an IDOM_Attr node by name. More...

virtual IDOM_NodeListgetElementsByTagName (const XMLCh *name)const=0
 Returns a NodeList of all descendant elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the IDOM_Element tree. More...

Set functions.
virtual void setAttribute (const XMLCh *name,const XMLCh *value)=0
 Adds a new attribute. More...

virtual IDOM_AttrsetAttributeNode (IDOM_Attr *newAttr)=0
 Adds a new attribute. More...

Functions which modify the Element.
virtual IDOM_AttrremoveAttributeNode (IDOM_Attr *oldAttr)=0
 Removes the specified attribute node. More...

virtual void removeAttribute (const XMLCh *name)=0
 Removes an attribute by name. More...

Functions introduced in DOM Level 2.
virtual const XMLCh* getAttributeNS (const XMLCh *namespaceURI,const XMLCh *localName)const=0
 Retrieves an attribute value by local name and namespace URI. More...

virtual void setAttributeNS (const XMLCh *namespaceURI,const XMLCh *qualifiedName,const XMLCh *value)=0
 Adds a new attribute. More...

virtual void removeAttributeNS (const XMLCh *namespaceURI,const XMLCh *localName)=0
 Removes an attribute by local name and namespace URI. More...

virtual IDOM_AttrgetAttributeNodeNS (const XMLCh *namespaceURI,const XMLCh *localName)const=0
 Retrieves an IDOM_Attr node by local name and namespace URI. More...

virtual IDOM_AttrsetAttributeNodeNS (IDOM_Attr *newAttr)=0
 Adds a new attribute. More...

virtual IDOM_NodeListgetElementsByTagNameNS (const XMLCh *namespaceURI,const XMLCh *localName)const=0
 Returns a IDOM_NodeList of all the IDOM_Elements with a given local name and namespace URI in the order in which they would be encountered in a preorder traversal of the IDOM_Document tree, starting from this node. More...

virtual bool hasAttribute (const XMLCh *name)const=0
 Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise. More...

virtual bool hasAttributeNS (const XMLCh *namespaceURI,const XMLCh *localName)const=0
 Returns true when an attribute with a given local name and namespace URI is specified on this element or has a default value, false otherwise. More...


Protected Methods

 IDOM_Element ()
 IDOM_Element (const IDOM_Element &other)
IDOM_Element& operator= (const IDOM_Element &other)

Detailed Description

By far the vast majority of objects (apart from text) that authors encounter when traversing a document are IDOM_Element nodes.

Assume the following XML document:&lt;elementExample id="demo"&gt; &lt;subelement1/&gt; &lt;subelement2&gt;&lt;subsubelement/&gt;&lt;/subelement2&gt; &lt;/elementExample&gt;

When represented using DOM, the top node is an IDOM_Element node for "elementExample", which contains two child IDOM_Element nodes, one for "subelement1" and one for "subelement2". "subelement1" contains no child nodes.

Elements may have attributes associated with them; since the IDOM_Element interface inherits from IDOM_Node, the generic IDOM_Node interface method getAttributes may be used to retrieve the set of all attributes for an element. There are methods on the IDOM_Element interface to retrieve either an IDOM_Attr object by name or an attribute value by name. In XML, where an attribute value may contain entity references, an IDOM_Attr object should be retrieved to examine the possibly fairly complex sub-tree representing the attribute value. On the other hand, in HTML, where all attributes have simple string values, methods to directly access an attribute value can safely be used as a convenience.


Constructor & Destructor Documentation

IDOM_Element::IDOM_Element ( ) [protected]
 

IDOM_Element::IDOM_Element ( const IDOM_Element & other ) [protected]
 

IDOM_Element::~IDOM_Element ( ) [virtual]
 

Destructor.

The object being destroyed is the reference object, not the underlying Element itself.


Member Function Documentation

const XMLCh * IDOM_Element::getAttribute ( const XMLCh * name ) const [pure virtual]
 

Retrieves an attribute value by name.

Parameters:
name   The name of the attribute to retrieve.
Returns:
The IDOM_Attr value as a string, or the empty string if that attribute does not have a specified or default value.

const XMLCh * IDOM_Element::getAttributeNS ( const XMLCh * namespaceURI,
const XMLCh * localName ) const [pure virtual]
 

Retrieves an attribute value by local name and namespace URI.

Parameters:
namespaceURI   The namespace URI of the attribute to retrieve.
localName   The local name of the attribute to retrieve.
Returns:
The IDOM_Attr value as a string, or an null if that attribute does not have a specified or default value.

IDOM_Attr * IDOM_Element::getAttributeNode ( const XMLCh * name ) const [pure virtual]
 

Retrieves an IDOM_Attr node by name.

Parameters:
name   The name (nodeName) of the attribute to retrieve.
Returns:
The IDOM_Attr node with the specified name (nodeName) or null if there is no such attribute.

IDOM_Attr * IDOM_Element::getAttributeNodeNS ( const XMLCh * namespaceURI,
const XMLCh * localName ) const [pure virtual]
 

Retrieves an IDOM_Attr node by local name and namespace URI.

Parameters:
namespaceURI   The namespace URI of the attribute to retrieve.
localName   The local name of the attribute to retrieve.
Returns:
The IDOM_Attr node with the specified attribute local name and namespace URI or null if there is no such attribute.

IDOM_NodeList * IDOM_Element::getElementsByTagName ( const XMLCh * name ) const [pure virtual]
 

Returns a NodeList of all descendant elements with a given tag name, in the order in which they would be encountered in a preorder traversal of the IDOM_Element tree.

Parameters:
name   The name of the tag to match on. The special value "*" matches all tags.
Returns:
A list of matching IDOM_Element nodes.

IDOM_NodeList * IDOM_Element::getElementsByTagNameNS ( const XMLCh * namespaceURI,
const XMLCh * localName ) const [pure virtual]
 

Returns a IDOM_NodeList of all the IDOM_Elements with a given local name and namespace URI in the order in which they would be encountered in a preorder traversal of the IDOM_Document tree, starting from this node.

Parameters:
namespaceURI   The namespace URI of the elements to match on. The special value "*" matches all namespaces.
localName   The local name of the elements to match on. The special value "*" matches all local names.
Returns:
A new IDOM_NodeList object containing all the matched IDOM_Elements.

const XMLCh * IDOM_Element::getTagName ( ) const [pure virtual]
 

The name of the element.

For example, in: &lt;elementExample id="demo"&gt; ... &lt;/elementExample&gt; , tagName has the value "elementExample". Note that this is case-preserving in XML, as are all of the operations of the DOM.

bool IDOM_Element::hasAttribute ( const XMLCh * name ) const [pure virtual]
 

Returns true when an attribute with a given name is specified on this element or has a default value, false otherwise.

Parameters:
name   The name of the attribute to look for.
Returns:
true if an attribute with the given name is specified on this element or has a default value, false otherwise.

bool IDOM_Element::hasAttributeNS ( const XMLCh * namespaceURI,
const XMLCh * localName ) const [pure virtual]
 

Returns true when an attribute with a given local name and namespace URI is specified on this element or has a default value, false otherwise.

HTML-only DOM implementations do not need to implement this method.

Parameters:
namespaceURI   The namespace URI of the attribute to look for.
localName   The local name of the attribute to look for.
Returns:
true if an attribute with the given local name and namespace URI is specified or has a default value on this element, false otherwise.
Since:
DOM Level 2

IDOM_Element & IDOM_Element::operator= ( const IDOM_Element & other ) [protected]
 

void IDOM_Element::removeAttribute ( const XMLCh * name ) [pure virtual]
 

Removes an attribute by name.

If the removed attribute is known to have a default value, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable.
To remove an attribute by local name and namespace URI, use the removeAttributeNS method.

Parameters:
name   The name of the attribute to remove.
Exceptions:
DOMException   NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

void IDOM_Element::removeAttributeNS ( const XMLCh * namespaceURI,
const XMLCh * localName ) [pure virtual]
 

Removes an attribute by local name and namespace URI.

If the removed attribute has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix.

Parameters:
namespaceURI   The namespace URI of the attribute to remove.
localName   The local name of the attribute to remove.
Exceptions:
DOMException   NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

IDOM_Attr * IDOM_Element::removeAttributeNode ( IDOM_Attr * oldAttr ) [pure virtual]
 

Removes the specified attribute node.

If the removed IDOM_Attr has a default value it is immediately replaced. The replacing attribute has the same namespace URI and local name, as well as the original prefix, when applicable.

Parameters:
oldAttr   The IDOM_Attr node to remove from the attribute list.
Returns:
The IDOM_Attr node that was removed.
Exceptions:
DOMException   NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NOT_FOUND_ERR: Raised if oldAttr is not an attribute of the element.

void IDOM_Element::setAttribute ( const XMLCh * name,
const XMLCh * value ) [pure virtual]
 

Adds a new attribute.

If an attribute with that name is already present in the element, its value is changed to be that of the value parameter. This value is a simple string, it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an IDOM_Attr node plus any Text and EntityReference nodes, build the appropriate subtree, and use setAttributeNode to assign it as the value of an attribute.

Parameters:
name   The name of the attribute to create or alter.
value   Value to set in string form.
Exceptions:
DOMException   INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

void IDOM_Element::setAttributeNS ( const XMLCh * namespaceURI,
const XMLCh * qualifiedName,
const XMLCh * value ) [pure virtual]
 

Adds a new attribute.

If an attribute with the same local name and namespace URI is already present on the element, its prefix is changed to be the prefix part of the qualifiedName, and its value is changed to be the value parameter. This value is a simple string, it is not parsed as it is being set. So any markup (such as syntax to be recognized as an entity reference) is treated as literal text, and needs to be appropriately escaped by the implementation when it is written out. In order to assign an attribute value that contains entity references, the user must create an IDOM_Attr node plus any IDOM_Text and IDOM_EntityReference nodes, build the appropriate subtree, and use setAttributeNodeNS or setAttributeNode to assign it as the value of an attribute.

Parameters:
namespaceURI   The namespace URI of the attribute to create or alter.
qualifiedName   The qualified name of the attribute to create or alter.
value   The value to set in string form.
Exceptions:
DOMException   INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
NAMESPACE_ERR: Raised if the qualifiedName is malformed, if the qualifiedName has a prefix and the namespaceURI is null or an empty string, if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from "http://www.w3.org/XML/1998/namespace", if the qualifiedName has a prefix that is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/", or if the qualifiedName is "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/".

IDOM_Attr * IDOM_Element::setAttributeNode ( IDOM_Attr * newAttr ) [pure virtual]
 

Adds a new attribute.

If an attribute with that name (nodeName) is already present in the element, it is replaced by the new one.

Parameters:
newAttr   The IDOM_Attr node to add to the attribute list.
Returns:
If the newAttr attribute replaces an existing attribute, the replaced IDOM_Attr node is returned, otherwise null is returned.
Exceptions:
DOMException   WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another IDOM_Element object. The DOM user must explicitly clone IDOM_Attr nodes to re-use them in other elements.

IDOM_Attr * IDOM_Element::setAttributeNodeNS ( IDOM_Attr * newAttr ) [pure virtual]
 

Adds a new attribute.

If an attribute with that local name and namespace URI is already present in the element, it is replaced by the new one.

Parameters:
newAttr   The IDOM_Attr node to add to the attribute list.
Returns:
If the newAttr attribute replaces an existing attribute with the same local name and namespace URI, the replaced IDOM_Attr node is returned, otherwise null is returned.
Exceptions:
DOMException   WRONG_DOCUMENT_ERR: Raised if newAttr was created from a different document than the one that created the element.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
INUSE_ATTRIBUTE_ERR: Raised if newAttr is already an attribute of another IDOM_Element object. The DOM user must explicitly clone IDOM_Attr nodes to re-use them in other elements.


The documentation for this class was generated from the following file:


Copyright © 2000 The Apache Software Foundation. All Rights Reserved.