2005/5/9

org::w3c::dom::NamedNodeMap Class Reference

Inheritance diagram for org::w3c::dom::NamedNodeMap:

Detailed Description

Note that NamedNodeMap does not inherit from NodeList; NamedNodeMaps are not maintained in any particular order. Objects contained in an object implementing NamedNodeMap may also be accessed by an ordinal index, but this is simply to allow convenient enumeration of the contents of a NamedNodeMap, and does not imply that the DOM specifies an order to these Nodes.

NamedNodeMap objects in the DOM are live.

See also the Document acdk::lang::Object Model (DOM) Level 3 Core Specification.

Author:

Roger Rene Kommer

Version:

Revision

1.13

Date:

Date

2005/02/05 10:45:37

Public Member Functions
virtual RNode	getNamedItem (IN(acdk::lang::RString) name)=0
	Retrieves a node specified by name.
virtual RNode	setNamedItem (IN(RNode) arg)=0 throw ( RDOMException )
	Adds a node using its nodeName attribute.
virtual RNode	removeNamedItem (IN(acdk::lang::RString) name)=0 throw ( RDOMException )
	Removes a node specified by name.
virtual RNode	item (int index)=0
	Returns the indexth item in the map.
virtual int	getLength ()=0
	The number of nodes in this map.

Member Function Documentation

virtual int org::w3c::dom::NamedNodeMap::getLength (   )  [pure virtual]

The number of nodes in this map. The range of valid child node indices is 0 to length-1 inclusive. Implemented in acdk::xml::dom::XMLNamedNodeMap, and acdk::xml::libxmldom::LibXMLNamedNodeMap.

virtual RNode org::w3c::dom::NamedNodeMap::getNamedItem (  IN(acdk::lang::RString)  name  )  [pure 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. Implemented in acdk::xml::dom::XMLNamedNodeMap.

virtual RNode org::w3c::dom::NamedNodeMap::item (  int  index  )  [pure 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. Implemented in acdk::xml::dom::XMLNamedNodeMap, and acdk::xml::libxmldom::LibXMLNamedNodeMap.

virtual RNode org::w3c::dom::NamedNodeMap::removeNamedItem (  IN(acdk::lang::RString)  name  )  throw ( RDOMException ) [pure virtual]

Removes a node specified by name. When this map contains the attributes attached to an element, 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. Parameters: name  The nodeName of the node to remove. Returns: The node removed from this map if a node with such a name exists. Exceptions: DOMException  NOT_FOUND_ERR: Raised if there is no node named name in this map. NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.

virtual RNode org::w3c::dom::NamedNodeMap::setNamedItem (  IN(RNode)  arg  )  throw ( RDOMException ) [pure 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. Implemented in acdk::xml::dom::XMLNamedNodeMap.