CL_DomNamedNodeMap Class Reference
[clanCore XML]

DOM Named Node Map class. More...

#include <dom_named_node_map.h>

List of all members.

Public Member Functions

Construction

 CL_DomNamedNodeMap ()
 Constructs a DOM NamedNodeMap handle.
 CL_DomNamedNodeMap (const CL_DomNamedNodeMap &copy)
 Constructs a DomNamedNodeMap.
 ~CL_DomNamedNodeMap ()
Attributes

unsigned long get_length () const
 The number of nodes in the map.
Operations

CL_DomNode get_named_item (const CL_DomString &name) const
 Retrieves a node specified by name.
CL_DomNode get_named_item_ns (const CL_DomString &namespace_uri, const CL_DomString &local_name) const
 Retrieves a node specified by namespace URI and local name.
CL_DomNode set_named_item (const CL_DomNode &node)
 Adds a node using its node name attribute.
CL_DomNode set_named_item_ns (const CL_DomNode &node)
 Adds a node using its namespace URI and local name.
CL_DomNode remove_named_item (const CL_DomString &name)
 Removes a node specified by name.
CL_DomNode remove_named_item_ns (const CL_DomString &namespace_uri, const CL_DomString &local_name)
 Removes a node specified by namespace URI and local name.
CL_DomNode item (unsigned long index) const
 Returns the indexth item in the map.

Implementation



CL_SharedPtr
< CL_DomNamedNodeMap_Generic > 
impl
class CL_DomNode
 CL_DomNamedNodeMap (const CL_SharedPtr< CL_DomNamedNodeMap_Generic > &impl)
 Constructs a DomNamedNodeMap.

Detailed Description

DOM Named Node Map class.

Objects implementing the NamedNodeMap 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.


Constructor & Destructor Documentation

CL_DomNamedNodeMap::CL_DomNamedNodeMap (  ) 

Constructs a DOM NamedNodeMap handle.

CL_DomNamedNodeMap::CL_DomNamedNodeMap ( const CL_DomNamedNodeMap copy  ) 

Constructs a DomNamedNodeMap.

Parameters:
copy = Dom Named Node Map
CL_DomNamedNodeMap::~CL_DomNamedNodeMap (  ) 
CL_DomNamedNodeMap::CL_DomNamedNodeMap ( const CL_SharedPtr< CL_DomNamedNodeMap_Generic > &  impl  )  [protected]

Constructs a DomNamedNodeMap.

Parameters:
impl = Shared Ptr

Member Function Documentation

unsigned long CL_DomNamedNodeMap::get_length (  )  const

The number of nodes in the map.

CL_DomNode CL_DomNamedNodeMap::get_named_item ( const CL_DomString name  )  const

Retrieves a node specified by name.

CL_DomNode CL_DomNamedNodeMap::get_named_item_ns ( const CL_DomString namespace_uri,
const CL_DomString local_name 
) const

Retrieves a node specified by namespace URI and local name.

CL_DomNode CL_DomNamedNodeMap::item ( unsigned long  index  )  const

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.

CL_DomNode CL_DomNamedNodeMap::remove_named_item ( const CL_DomString name  ) 

Removes a node specified by name.

If the removed node is an Attr with a default value it is immediately replaced.

Parameters:
name The name of a node to remove. retval: The node removed from the map or null if no node with such a name exists.
CL_DomNode CL_DomNamedNodeMap::remove_named_item_ns ( const CL_DomString namespace_uri,
const CL_DomString local_name 
)

Removes a node specified by namespace URI and local name.

If the removed node is an Attr with a default value it is immediately replaced.

Returns:
The node removed from the map or null if no node with such a name exists.
CL_DomNode CL_DomNamedNodeMap::set_named_item ( const CL_DomNode node  ) 

Adds a node using its node name attribute.

As the node name 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:
node A node to store in a named node map. The node will later be accessible using the value of the node name attribute of the node. If a node with that name is already present in the map, it is replaced by the new one. retval: If the new Node replaces an existing node with the same name the previously existing Node is returned, otherwise null is returned.
CL_DomNode CL_DomNamedNodeMap::set_named_item_ns ( const CL_DomNode node  ) 

Adds a node using its namespace URI and local name.

If a node with that namespace URI and that local name is already present in this map, it is replaced by the new one.


Friends And Related Function Documentation

friend class CL_DomNode [friend]

Member Data Documentation

CL_SharedPtr<CL_DomNamedNodeMap_Generic> CL_DomNamedNodeMap::impl [protected]

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