IDOM_NamedNodeMap.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:10k
源码类别:

xml/soap/webservice

开发平台:

C/C++

  1. #ifndef IDOM_NamedNodeMap_HEADER_GUARD_
  2. #define IDOM_NamedNodeMap_HEADER_GUARD_
  3. /*
  4.  * The Apache Software License, Version 1.1
  5.  *
  6.  * Copyright (c) 2001 The Apache Software Foundation.  All rights
  7.  * reserved.
  8.  *
  9.  * Redistribution and use in source and binary forms, with or without
  10.  * modification, are permitted provided that the following conditions
  11.  * are met:
  12.  *
  13.  * 1. Redistributions of source code must retain the above copyright
  14.  *    notice, this list of conditions and the following disclaimer.
  15.  *
  16.  * 2. Redistributions in binary form must reproduce the above copyright
  17.  *    notice, this list of conditions and the following disclaimer in
  18.  *    the documentation and/or other materials provided with the
  19.  *    distribution.
  20.  *
  21.  * 3. The end-user documentation included with the redistribution,
  22.  *    if any, must include the following acknowledgment:
  23.  *       "This product includes software developed by the
  24.  *        Apache Software Foundation (http://www.apache.org/)."
  25.  *    Alternately, this acknowledgment may appear in the software itself,
  26.  *    if and wherever such third-party acknowledgments normally appear.
  27.  *
  28.  * 4. The names "Xerces" and "Apache Software Foundation" must
  29.  *    not be used to endorse or promote products derived from this
  30.  *    software without prior written permission. For written
  31.  *    permission, please contact apache@apache.org.
  32.  *
  33.  * 5. Products derived from this software may not be called "Apache",
  34.  *    nor may "Apache" appear in their name, without prior written
  35.  *    permission of the Apache Software Foundation.
  36.  *
  37.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  38.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  39.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  40.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  41.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  42.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  43.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  44.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  45.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  46.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  47.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  48.  * SUCH DAMAGE.
  49.  * ====================================================================
  50.  *
  51.  * This software consists of voluntary contributions made by many
  52.  * individuals on behalf of the Apache Software Foundation, and was
  53.  * originally based on software copyright (c) 2001, International
  54.  * Business Machines, Inc., http://www.ibm.com .  For more information
  55.  * on the Apache Software Foundation, please see
  56.  * <http://www.apache.org/>.
  57.  */
  58. /*
  59.  * $Log: IDOM_NamedNodeMap.hpp,v $
  60.  * Revision 1.2  2001/05/11 13:25:53  tng
  61.  * Copyright update.
  62.  *
  63.  * Revision 1.1.1.1  2001/04/03 00:14:30  andyh
  64.  * IDOM
  65.  *
  66.  */
  67. #include <util/XercesDefs.hpp>
  68. class IDOM_Node;
  69. /**
  70. *  <code>NamedNodeMap</code>s  are used to
  71. * represent collections of nodes that can be accessed by name.
  72. *
  73. * Note that <code>NamedNodeMap</code> does not inherit from <code>NodeList</code>;
  74. * <code>NamedNodeMap</code>s are not maintained in any particular order.
  75. * Nodes contained in a <code>NamedNodeMap</code> may
  76. * also be accessed by an ordinal index, but this is simply to allow
  77. * convenient enumeration of the contents, and
  78. * does not imply that the DOM specifies an order to these Nodes.
  79. */
  80. class CDOM_EXPORT IDOM_NamedNodeMap {
  81. protected:
  82.     IDOM_NamedNodeMap() {};
  83.     IDOM_NamedNodeMap(const IDOM_NamedNodeMap &other) {};
  84.     IDOM_NamedNodeMap & operator = (const IDOM_NamedNodeMap &other) {return *this;};
  85. public:
  86.     /** @name Destructor. */
  87.     //@{
  88.     virtual ~IDOM_NamedNodeMap() {};
  89.     //@}
  90.     /** @name Set functions. */
  91.     //@{
  92.     /**
  93.     * Adds a node using its <code>nodeName</code> attribute.
  94.     *
  95.     * <br>As the <code>nodeName</code> attribute is used to derive the name
  96.     * which the node must be stored under, multiple nodes of certain types
  97.     * (those that have a "special" string value) cannot be stored as the names
  98.     * would clash. This is seen as preferable to allowing nodes to be aliased.
  99.     * @param arg A node to store in a named node map. The node will later be
  100.     *   accessible using the value of the <code>nodeName</code> attribute of
  101.     *   the node. If a node with that name is already present in the map, it
  102.     *   is replaced by the new one.
  103.     * @return If the new <code>Node</code> replaces an existing node the
  104.     *   replaced <code>Node</code> is returned,
  105.     *   otherwise <code>null</code> is returned.
  106.     * @exception DOMException
  107.     *   WRONG_DOCUMENT_ERR: Raised if <code>arg</code> was created from a
  108.     *   different document than the one that created the
  109.     *   <code>NamedNodeMap</code>.
  110.     *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this
  111.     *   <code>NamedNodeMap</code> is readonly.
  112.     *   <br>INUSE_ATTRIBUTE_ERR: Raised if <code>arg</code> is an
  113.     *   <code>Attr</code> that is already an attribute of another
  114.     *   <code>Element</code> object. The DOM user must explicitly clone
  115.     *   <code>Attr</code> nodes to re-use them in other elements.
  116.     */
  117.     virtual IDOM_Node   *setNamedItem(IDOM_Node *arg) = 0;
  118.     //@}
  119.     /** @name Get functions. */
  120.     //@{
  121.     /**
  122.     * Returns the <code>index</code>th item in the map.
  123.     *
  124.     * If <code>index</code>
  125.     * is greater than or equal to the number of nodes in the map, this returns
  126.     * <code>null</code>.
  127.     * @param index Index into the map.
  128.     * @return The node at the <code>index</code>th position in the
  129.     *   <code>NamedNodeMap</code>, or <code>null</code> if that is not a valid
  130.     *   index.
  131.     */
  132.     virtual IDOM_Node     *item(unsigned int index) const = 0;
  133.     /**
  134.     * Retrieves a node specified by name.
  135.     *
  136.     * @param name The <code>nodeName</code> of a node to retrieve.
  137.     * @return A <code>IDOM_Node</code> (of any type) with the specified <code>nodeName</code>, or
  138.     *   <code>null</code> if it does not identify any node in
  139.     *   the map.
  140.     */
  141.     virtual IDOM_Node   *getNamedItem(const XMLCh *name) const = 0;
  142.     /**
  143.     * The number of nodes in the map.
  144.     *
  145.     * The range of valid child node indices is
  146.     * 0 to <code>length-1</code> inclusive.
  147.     */
  148.     virtual unsigned int   getLength() const = 0;
  149.     //@}
  150.     /** @name Functions to change the node collection. */
  151.     //@{
  152.     /**
  153.     * Removes a node specified by name.
  154.     *
  155.     * If the removed node is an
  156.     * <code>Attr</code> with a default value it is immediately replaced.
  157.     * @param name The <code>nodeName</code> of a node to remove.
  158.     * @return The node removed from the map or <code>null</code> if no node
  159.     *   with such a name exists.
  160.     * @exception DOMException
  161.     *   NOT_FOUND_ERR: Raised if there is no node named <code>name</code> in
  162.     *   the map.
  163.     * <br>
  164.     *   NO_MODIFICATION_ALLOWED_ERR: Raised if this <code>NamedNodeMap</code>
  165.     *   is readonly.
  166.     */
  167.     virtual IDOM_Node    *removeNamedItem(const XMLCh *name) = 0;
  168.     //@}
  169.     /** @name Functions introduced in DOM Level 2. */
  170.     //@{
  171.     /**
  172.      * Retrieves a node specified by local name and namespace URI.
  173.      *
  174.      * <p><b>"Experimental - subject to change"</b></p>
  175.      *
  176.      * @param namespaceURI The <em>namespace URI</em> of
  177.      *    the node to retrieve.
  178.      * @param localName The <em>local name</em> of the node to retrieve.
  179.      * @return A <code>IDOM_Node</code> (of any type) with the specified
  180.      *    local name and namespace URI, or <code>null</code> if they do not
  181.      *    identify any node in the map.
  182.      */
  183.     virtual IDOM_Node   *getNamedItemNS(const XMLCh *namespaceURI,
  184.                                         const XMLCh *localName) const = 0;
  185.     /**
  186.      * Adds a node using its <CODE>namespaceURI</CODE> and <CODE>localName</CODE>.
  187.      *
  188.      * <p><b>"Experimental - subject to change"</b></p>
  189.      *
  190.      * @param arg A node to store in a named node map. The node will later be
  191.      *       accessible using the value of the <CODE>namespaceURI</CODE> and
  192.      *       <CODE>localName</CODE> attribute of the node. If a node with those
  193.      *       namespace URI and local name is already present in the map, it is
  194.      *       replaced by the new one.
  195.      * @return If the new <code>IDOM_Node</code> replaces an existing node the
  196.      *   replaced <code>IDOM_Node</code> is returned,
  197.      *   otherwise <code>null</code> is returned.
  198.      * @exception DOMException
  199.      *   WRONG_DOCUMENT_ERR: Raised if <code>arg</code> was created from a
  200.      *   different document than the one that created the
  201.      *   <code>IDOM_NamedNodeMap</code>.
  202.      *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this
  203.      *   <code>vNamedNodeMap</code> is readonly.
  204.      *   <br>INUSE_ATTRIBUTE_ERR: Raised if <code>arg</code> is an
  205.      *   <code>DOM_Attr</code> that is already an attribute of another
  206.      *   <code>DOM_Element</code> object. The DOM user must explicitly clone
  207.      *   <code>DOM_Attr</code> nodes to re-use them in other elements.
  208.      */
  209.     virtual IDOM_Node   *setNamedItemNS(IDOM_Node *arg) = 0;
  210.     /**
  211.      * Removes a node specified by local name and namespace URI.
  212.      *
  213.      * <p><b>"Experimental - subject to change"</b></p>
  214.      *
  215.      * @param namespaceURI The <em>namespace URI</em> of
  216.      *    the node to remove.
  217.      * @param localName The <em>local name</em> of the
  218.      *    node to remove. When this <code>IDOM_NamedNodeMap</code> contains the
  219.      *    attributes attached to an element, as returned by the attributes
  220.      *    attribute of the <code>IDOM_Node</code> interface, if the removed
  221.      *    attribute is known to have a default value, an attribute
  222.      *    immediately appears containing the default value
  223.      *    as well as the corresponding namespace URI, local name, and prefix.
  224.      * @return The node removed from the map if a node with such a local name
  225.      *    and namespace URI exists.
  226.      * @exception DOMException
  227.      *   NOT_FOUND_ERR: Raised if there is no node named <code>name</code> in
  228.      *   the map.
  229.      * <br>
  230.      *   NO_MODIFICATION_ALLOWED_ERR: Raised if this <code>IDOM_NamedNodeMap</code>
  231.      *   is readonly.
  232.      */
  233.     virtual IDOM_Node     *removeNamedItemNS(const XMLCh *namespaceURI,
  234.                                           const XMLCh *localName) = 0;
  235.     //@}
  236. };
  237. #endif