NamedNodeMap Interface

Table 4-7 summarizes the methods of available through the NamedNodeMap interface.

XmlDomGetNamedItem

Retrieves an item from a NamedNodeMap, specified by name (which should be in the data encoding). This is a non-namespace-aware function; it just matches (case sensitively) on the whole qualified name. Note this function differs from the DOM spec in that the index of the matching item is also returned.

xmlnode* XmlDomGetNamedItem(
   xmlctx *xctx,
   xmlnamedmap *map,
   oratext *name)

xctx

IN

map

IN

name

IN

(xmlnode *) Node with the specified name [or NULL]

XmlDomGetNamedItemNS

Retrieves an item from a NamedNodeMap, specified by URI and localname (which should be in the data encoding). Note this function differs from the DOM spec in that the index of the matching item is also returned.

xmlnode* XmlDomGetNamedItemNS(
   xmlctx *xctx,
   xmlnamedmap *map, 
   oratext *uri,
   oratext *local)

xctx

IN

map

IN

uri

IN

local

IN

(xmlnode *) node with given local name and namespace URI [or NULL]

XmlDomGetNodeMapItem

Retrieves an item from a NamedNodeMap, specified by name (which should be in the data encoding). This is a non-namespace-aware function; it just matches (case sensitively) on the whole qualified name. Note this function differs from the DOM specification in that the index of the matching item is also returned. Named "item" in W3C specification.

xmlnode* XmlDomGetNodeMapItem(
   xmlctx *xctx, 
   xmlnamedmap *map, 
   ub4 index)

xctx

IN

map

IN

index

IN

(xmlnode *) node at the nth position in the map (or NULL)

XmlDomGetNodeMapLength

Returns the number of nodes in a NamedNodeMap (the length). Note that nodes are referred to by index, and the range of valid indexes is 0 through length-1.

ub4 XmlDomGetNodeMapLength(
   xmlctx *xctx,
   xmlnamedmap *map)

xctx

IN

map

IN

(ub4) number of nodes in NamedNodeMap

XmlDomRemoveNamedItem

Removes a node from a NamedNodeMap, specified by name. This is a non-namespace-aware function; it just matches (case sensitively) on the whole qualified name. If the removed node is an attribute with default value (not specified), it is immediately replaced. The removed node is returned; if no removal took place, NULL is returned.

xmlnode* XmlDomRemoveNamedItem(
   xmlctx *xctx,
   xmlnamedmap *map,
   oratext *name)

xctx

IN

map

IN

name

IN

(xmlnode *) node removed from this map

XmlDomRemoveNamedItemNS

Removes a node from a NamedNodeMap, specified by URI and localname. If the removed node is an attribute with default value (not specified), it is immediately replaced. The removed node is returned; if no removal took place, NULL is returned.

xmlnode* XmlDomRemoveNamedItemNS(
   xmlctx *xctx,
   xmlnamedmap *map, 
   oratext *uri,
   oratext *local)

xctx

IN

map

IN

uri

IN

local

IN

(xmlnode *) node removed from this map

XmlDomSetNamedItem

Adds a new node to a NamedNodeMap. If a node already exists with the given name, replaces the old node and returns it. If no such named node exists, adds the new node to the map and sets old to NULL. This is a non-namespace-aware function; it just matches (case sensitively) on the whole qualified name. Since some node types have fixed names (Text, Comment, and so on), trying to set another of the same type will always cause replacement.

xmlnode* XmlDomSetNamedItem(
   xmlctx *xctx,
   xmlnamedmap *map,
   xmlnode *newNode)

xctx

IN

map

IN

newNode

IN

(xmlnode *) the replaced node (or NULL)

XmlDomSetNamedItemNS

Adds a new node to a NamedNodeMap. If a node already exists with the given URI and localname, replaces the old node and returns it. If no such named node exists, adds the new node to the map and sets old to NULL. Since some node types have fixed names (Text, Comment, and so on), trying to set another of the same type will always cause replacement.

xmlnode* XmlDomSetNamedItemNS(
   xmlctx *xctx, 
   xmlnamedmap *map, 
   xmlnode *newNode)

xctx

IN

map

IN

newNode

IN

(xmlnode *) replaced Node [or NULL]