2005/5/9

     
 

class XMLNamedNodeMap

artefaktur
Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   Namespace Members   Compound Members   Related Pages  

acdk::xml::dom::XMLNamedNodeMap Class Reference

#include <XMLNamedNodeMap.h>

Inheritance diagram for acdk::xml::dom::XMLNamedNodeMap:

acdk::lang::Object org::w3c::dom::NamedNodeMap acdk::lang::ObjectBase acdk::lang::dmi::StdDispatch List of all members.

Detailed Description

API: org.w3c.dom<br>.

Author:
Roger Rene Kommer
Version:
Revision
1.5
Date:
Date
2005/02/05 10:45:36


Public Member Functions

 XMLNamedNodeMap (IN(RXMLAttrArray) attrs)
virtual RNode getNamedItem (IN(acdk::lang::RString) name)
 Retrieves a node specified by name.

virtual RNode setNamedItem (IN(RNode) arg) throw ( RDOMException )
 Adds a node using its nodeName attribute.

virtual RNode removeNamedItem (IN(RString) name) throw ( RDOMException )
virtual RNode item (int index)
 Returns the indexth item in the map.

virtual int getLength ()
 The number of nodes in this map.


Protected Attributes

RXMLAttrArray _attributes


Constructor & Destructor Documentation

acdk::xml::dom::XMLNamedNodeMap::XMLNamedNodeMap IN(RXMLAttrArray attrs  )  [inline]
 


Member Function Documentation

virtual int acdk::xml::dom::XMLNamedNodeMap::getLength  )  [inline, virtual]
 

The number of nodes in this map.

The range of valid child node indices is 0 to length-1 inclusive.

Implements org::w3c::dom::NamedNodeMap.

virtual RNode acdk::xml::dom::XMLNamedNodeMap::getNamedItem IN(acdk::lang::RString name  )  [inline, virtual]
 

Retrieves a node specified by name.

Parameters:
name The nodeName of a node to retrieve.
Returns:
A Node (of any type) with the specified nodeName, or null if it does not identify any node in this map.

Implements org::w3c::dom::NamedNodeMap.

virtual RNode acdk::xml::dom::XMLNamedNodeMap::item int  index  )  [inline, virtual]
 

Returns the indexth item in the map.

If index is greater than or equal to the number of nodes in this map, this returns null.

Parameters:
index Index into this map.
Returns:
The node at the indexth position in the map, or null if that is not a valid index.

Implements org::w3c::dom::NamedNodeMap.

virtual RNode acdk::xml::dom::XMLNamedNodeMap::removeNamedItem IN(RString name  )  throw ( RDOMException ) [inline, virtual]
 

virtual RNode acdk::xml::dom::XMLNamedNodeMap::setNamedItem IN(RNode arg  )  throw ( RDOMException ) [inline, virtual]
 

Adds a node using its nodeName attribute.

If a node with that name is already present in this map, it is replaced by the new one. Replacing a node by itself has no effect.
As the nodeName attribute is used to derive the name which the node must be stored under, multiple nodes of certain types (those that have a special string value) cannot be stored as the names would clash. This is seen as preferable to allowing nodes to be aliased.

Parameters:
arg A node to store in this map. The node will later be accessible using the value of its nodeName attribute.
Returns:
If the new Node replaces an existing node the replaced Node is returned, otherwise null is returned.
Exceptions:
DOMException WRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created this map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
INUSE_ATTRIBUTE_ERR: Raised if arg is an Attr that is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.
HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node doesn't belong in this NamedNodeMap. Examples would include trying to insert something other than an Attr node into an Element's map of attributes, or a non-Entity node into the DocumentType's map of Entities.

Implements org::w3c::dom::NamedNodeMap.


Member Data Documentation

RXMLAttrArray acdk::xml::dom::XMLNamedNodeMap::_attributes [protected]