Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

Public Member Functions | Protected Member Functions | List of all members
XalanNamedNodeMap Class Reference
Inheritance diagram for XalanNamedNodeMap:
XalanEmptyNamedNodeMap XalanSourceTreeElementA XercesNamedNodeMapBridge XercesNamedNodeMapWrapper XalanSourceTreeElementANS

Public Member Functions

 XalanNamedNodeMap ()
virtual ~XalanNamedNodeMap ()
Set functions.
virtual XalanNodesetNamedItem (XalanNode *arg)=0
 Adds a node using its nodeName attribute.
virtual XalanNodeitem (unsigned int index) const =0
 Returns the indexth item in the map.
Get functions.
virtual XalanNodegetNamedItem (const XalanDOMString &name) const =0
 Retrieves a node specified by name.
virtual unsigned int getLength () const =0
 The number of nodes in the map.
Functions to change the node collection.
virtual XalanNoderemoveNamedItem (const XalanDOMString &name)=0
 Removes a node specified by name.
Functions introduced in DOM Level 2.
virtual XalanNodegetNamedItemNS (const XalanDOMString &namespaceURI, const XalanDOMString &localName) const =0
 Retrieves a node specified by local name and namespace URI.
virtual XalanNodesetNamedItemNS (XalanNode *arg)=0
 Adds a node using its namespaceURI and localName.
virtual XalanNoderemoveNamedItemNS (const XalanDOMString &namespaceURI, const XalanDOMString &localName)=0
 Removes a node specified by local name and namespace URI.

Protected Member Functions

 XalanNamedNodeMap (const XalanNamedNodeMap &theSource)
XalanNamedNodeMapoperator= (const XalanNamedNodeMap &theSource)
bool operator== (const XalanNamedNodeMap &theRHS) const

Constructor & Destructor Documentation

XalanNamedNodeMap::XalanNamedNodeMap ( )
virtual XalanNamedNodeMap::~XalanNamedNodeMap ( )
virtual
XalanNamedNodeMap::XalanNamedNodeMap ( const XalanNamedNodeMap theSource)
protected

Member Function Documentation

virtual unsigned int XalanNamedNodeMap::getLength ( ) const
pure virtual

The number of nodes in the map.

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

Implemented in XercesNamedNodeMapBridge, XercesNamedNodeMapWrapper, and XalanEmptyNamedNodeMap.

virtual XalanNode* XalanNamedNodeMap::getNamedItem ( const XalanDOMString name) const
pure virtual

Retrieves a node specified by name.

Parameters
nameThe 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 the map.

Implemented in XercesNamedNodeMapBridge, XercesNamedNodeMapWrapper, and XalanEmptyNamedNodeMap.

virtual XalanNode* XalanNamedNodeMap::getNamedItemNS ( const XalanDOMString namespaceURI,
const XalanDOMString localName 
) const
pure virtual

Retrieves a node specified by local name and namespace URI.

Parameters
namespaceURIThe namespace URI of the node to retrieve.
localNameThe local name of the node to retrieve.
Returns
A Node (of any type) with the specified local name and namespace URI, or null if they do not identify any node in the map.

Implemented in XercesNamedNodeMapBridge, XercesNamedNodeMapWrapper, and XalanEmptyNamedNodeMap.

virtual XalanNode* XalanNamedNodeMap::item ( unsigned int  index) const
pure virtual

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
indexIndex into the map.
Returns
The node at the indexth position in the NamedNodeMap, or null if that is not a valid index.

Implemented in XercesNamedNodeMapBridge, XercesNamedNodeMapWrapper, and XalanEmptyNamedNodeMap.

XalanNamedNodeMap& XalanNamedNodeMap::operator= ( const XalanNamedNodeMap theSource)
protected
bool XalanNamedNodeMap::operator== ( const XalanNamedNodeMap theRHS) const
protected
virtual XalanNode* XalanNamedNodeMap::removeNamedItem ( const XalanDOMString name)
pure virtual

Removes a node specified by name.

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

Parameters
nameThe nodeName of a node to remove.
Returns
The node removed from the map or null if no node with such a name exists.
Exceptions
DOMExceptionNOT_FOUND_ERR: Raised if there is no node named name in the map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this NamedNodeMap is readonly.

Implemented in XercesNamedNodeMapBridge, XercesNamedNodeMapWrapper, and XalanEmptyNamedNodeMap.

virtual XalanNode* XalanNamedNodeMap::removeNamedItemNS ( const XalanDOMString namespaceURI,
const XalanDOMString localName 
)
pure virtual

Removes a node specified by local name and namespace URI.

Parameters
namespaceURIThe namespace URI of the node to remove.
localNameThe local name 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.
Returns
The node removed from the map if a node with such a local name and namespace URI exists.
Exceptions
DOMExceptionNOT_FOUND_ERR: Raised if there is no node named name in the map.
NO_MODIFICATION_ALLOWED_ERR: Raised if this NamedNodeMap is readonly.

Implemented in XercesNamedNodeMapBridge, XercesNamedNodeMapWrapper, and XalanEmptyNamedNodeMap.

virtual XalanNode* XalanNamedNodeMap::setNamedItem ( XalanNode arg)
pure virtual

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.

Parameters
argA 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.
Exceptions
DOMExceptionWRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created the NamedNodeMap.
NO_MODIFICATION_ALLOWED_ERR: Raised if this NamedNodeMap 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.

Implemented in XercesNamedNodeMapBridge, XercesNamedNodeMapWrapper, and XalanEmptyNamedNodeMap.

virtual XalanNode* XalanNamedNodeMap::setNamedItemNS ( XalanNode arg)
pure virtual

Adds a node using its namespaceURI and localName.

Parameters
argA node to store in a named node map. The node will later be accessible using the value of the namespaceURI and localName attribute of the node. If a node with those namespace URI and local 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.
Exceptions
DOMExceptionWRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created the NamedNodeMap.
NO_MODIFICATION_ALLOWED_ERR: Raised if this NamedNodeMap 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.

Implemented in XercesNamedNodeMapBridge, XercesNamedNodeMapWrapper, and XalanEmptyNamedNodeMap.


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

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

dot

Xalan-C++ XSLT Processor Version 1.10
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.

Apache Logo