#ifndef DOMNamedNodeMap_HEADER_GUARD_ #define DOMNamedNodeMap_HEADER_GUARD_ /* * The Apache Software License, Version 1.1 * * Copyright (c) 2001-2002 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Xerces" and "Apache Software Foundation" must * not be used to endorse or promote products derived from this * software without prior written permission. For written * permission, please contact apache\@apache.org. * * 5. Products derived from this software may not be called "Apache", * nor may "Apache" appear in their name, without prior written * permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation, and was * originally based on software copyright (c) 2001, International * Business Machines, Inc., http://www.ibm.com . For more information * on the Apache Software Foundation, please see * . */ /* * $Id: DOMNamedNodeMap.hpp,v 1.8 2003/03/07 19:59:06 tng Exp $ */ #include XERCES_CPP_NAMESPACE_BEGIN class DOMNode; /** * DOMNamedNodeMaps are used to * represent collections of nodes that can be accessed by name. * * Note that DOMNamedNodeMap does not inherit from DOMNodeList; * DOMNamedNodeMaps are not maintained in any particular order. * Nodes contained in a DOMNamedNodeMap may * also be accessed by an ordinal index, but this is simply to allow * convenient enumeration of the contents, and * does not imply that the DOM specifies an order to these Nodes. * * @since DOM Level 1 */ class CDOM_EXPORT DOMNamedNodeMap { protected: // ----------------------------------------------------------------------- // Hidden constructors // ----------------------------------------------------------------------- /** @name Hidden constructors */ //@{ DOMNamedNodeMap() {}; //@} private: // ----------------------------------------------------------------------- // Unimplemented constructors and operators // ----------------------------------------------------------------------- /** @name Unimplemented constructors and operators */ //@{ DOMNamedNodeMap(const DOMNamedNodeMap &); DOMNamedNodeMap & operator = (const DOMNamedNodeMap &); //@} public: // ----------------------------------------------------------------------- // All constructors are hidden, just the destructor is available // ----------------------------------------------------------------------- /** @name Destructor */ //@{ /** * Destructor * */ virtual ~DOMNamedNodeMap() {}; //@} // ----------------------------------------------------------------------- // Virtual DOMNamedNodeMap interface // ----------------------------------------------------------------------- /** @name Functions introduced in DOM Level 1 */ //@{ // ----------------------------------------------------------------------- // Setter methods // ----------------------------------------------------------------------- /** * 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. * @param arg 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. * @return If the new DOMNode replaces an existing node the * replaced DOMNode is returned, * otherwise null is returned. * @exception DOMException * WRONG_DOCUMENT_ERR: Raised if arg was created from a * different document than the one that created the * DOMNamedNodeMap. *
NO_MODIFICATION_ALLOWED_ERR: Raised if this * DOMNamedNodeMap is readonly. *
INUSE_ATTRIBUTE_ERR: Raised if arg is an * DOMAttr that is already an attribute of another * DOMElement object. The DOM user must explicitly clone * DOMAttr nodes to re-use them in other elements. * @since DOM Level 1 */ virtual DOMNode *setNamedItem(DOMNode *arg) = 0; // ----------------------------------------------------------------------- // Getter methods // ----------------------------------------------------------------------- /** * 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. * @param index Index into the map. * @return The node at the indexth position in the * DOMNamedNodeMap, or null if that is not a valid * index. * @since DOM Level 1 */ virtual DOMNode *item(XMLSize_t index) const = 0; /** * Retrieves a node specified by name. * * @param name The nodeName of a node to retrieve. * @return A DOMNode (of any type) with the specified nodeName, or * null if it does not identify any node in * the map. * @since DOM Level 1 */ virtual DOMNode *getNamedItem(const XMLCh *name) const = 0; /** * The number of nodes in the map. * * The range of valid child node indices is * 0 to length-1 inclusive. * @since DOM Level 1 */ virtual XMLSize_t getLength() const = 0; // ----------------------------------------------------------------------- // Node methods // ----------------------------------------------------------------------- /** * Removes a node specified by name. * * If the removed node is an * DOMAttr with a default value it is immediately replaced. * @param name The nodeName of a node to remove. * @return The node removed from the map if a node with such a name exists. * @exception DOMException * NOT_FOUND_ERR: Raised if there is no node named name in * the map. *
* NO_MODIFICATION_ALLOWED_ERR: Raised if this DOMNamedNodeMap * is readonly. * @since DOM Level 1 */ virtual DOMNode *removeNamedItem(const XMLCh *name) = 0; //@} /** @name Functions introduced in DOM Level 2 */ //@{ /** * Retrieves a node specified by local name and namespace URI. * * @param namespaceURI The namespace URI of * the node to retrieve. * @param localName The local name of the node to retrieve. * @return A DOMNode (of any type) with the specified * local name and namespace URI, or null if they do not * identify any node in the map. * @since DOM Level 2 */ virtual DOMNode *getNamedItemNS(const XMLCh *namespaceURI, const XMLCh *localName) const = 0; /** * Adds a node using its namespaceURI and localName. * * @param arg A 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. * @return If the new DOMNode replaces an existing node the * replaced DOMNode is returned, * otherwise null is returned. * @exception DOMException * WRONG_DOCUMENT_ERR: Raised if arg was created from a * different document than the one that created the * DOMNamedNodeMap. *
NO_MODIFICATION_ALLOWED_ERR: Raised if this * DOMNamedNodeMap is readonly. *
INUSE_ATTRIBUTE_ERR: Raised if arg is an * DOMAttr that is already an attribute of another * DOMElement object. The DOM user must explicitly clone * DOMAttr nodes to re-use them in other elements. * @since DOM Level 2 */ virtual DOMNode *setNamedItemNS(DOMNode *arg) = 0; /** * Removes a node specified by local name and namespace URI. * * @param namespaceURI The namespace URI of * the node to remove. * @param localName The local name of the * node to remove. When this DOMNamedNodeMap contains the * attributes attached to an element, as returned by the attributes * attribute of the DOMNode 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. * @return The node removed from the map if a node with such a local name * and namespace URI exists. * @exception DOMException * NOT_FOUND_ERR: Raised if there is no node named name in * the map. *
* NO_MODIFICATION_ALLOWED_ERR: Raised if this DOMNamedNodeMap * is readonly. * @since DOM Level 2 */ virtual DOMNode *removeNamedItemNS(const XMLCh *namespaceURI, const XMLCh *localName) = 0; //@} }; XERCES_CPP_NAMESPACE_END #endif