Objects implementing the DOMNamedNodeMap interface are used to represent collections of nodes that can be accessed by name. 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.

Instance Methods

GetLength( )

The number of nodes in the map. The range of valid child node indices is 0 to length-1 inclusive.

GetNamedItem( String name )

Retrieves a node specified by name.

Item( Integer index )

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

RemoveNamedItem( String name )

Removes a node specified by name.

SetNamedItem( DOMNode node )

Adds a node using its nodeName attribute. 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.

Instance Methods

GetLength

Integer GetLength()

The number of nodes in the map. The range of valid child node indices is 0 to length-1 inclusive.

Returns:

The number of nodes in the map.

GetNamedItem

DOMNode GetNamedItem( String name )

Retrieves a node specified by name.

Parameters

name

The name of the node.

Returns:

A Node (of any type) with the specified nodeName, or null if it does not identify any node in the map.

Item

DOMNode Item( Integer index )

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

Parameters

index

Index into the map.

Returns:

The node at the indexth position in the NamedNodeMap, or null if that is not a valid index.

RemoveNamedItem

DOMNode RemoveNamedItem( String name )

Removes a node specified by name.

Parameters

name

The nodeName of the node to remove. When this NamedNodeMap contains the attributes attached to an element, as returned by the attributes attribute of the Node interface, 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.

Returns:

The node removed from the map if a node with such a name exists.

SetNamedItem

DOMNode SetNamedItem( DOMNode node )

Parameters

node

A node to store in a named node map. The node will later be accessible using the value of the nodeName attribute of the node. If a node with that name is already present in the map, it is replaced by the new one.

Returns:

If the new Node replaces an existing node the replaced Node is returned, otherwise null is returned.