DOM_NamedNodeMap.hpp
上传用户:zhuqijet
上传日期:2013-06-25
资源大小:10074k
文件大小:13k
源码类别:

词法分析

开发平台:

Visual C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 1999, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56. /*
  57.  * $Id: DOM_NamedNodeMap.hpp,v 1.3 2002/11/04 15:04:44 tng Exp $
  58.  */
  59. #ifndef DOM_NamedNodeMap_HEADER_GUARD_
  60. #define DOM_NamedNodeMap_HEADER_GUARD_
  61. #include <xercesc/util/XercesDefs.hpp>
  62. #include "DOM_Node.hpp"
  63. XERCES_CPP_NAMESPACE_BEGIN
  64. class NamedNodeMapImpl;
  65. /**
  66. *  <code>NamedNodeMap</code>s  are used to
  67. * represent collections of nodes that can be accessed by name.
  68. *
  69. * Note that <code>NamedNodeMap</code> does not inherit from <code>NodeList</code>;
  70. * <code>NamedNodeMap</code>s are not maintained in any particular order.
  71. * Nodes contained in a <code>NamedNodeMap</code> may
  72. * also be accessed by an ordinal index, but this is simply to allow
  73. * convenient enumeration of the contents, and
  74. * does not imply that the DOM specifies an order to these Nodes.
  75. */
  76. class CDOM_EXPORT DOM_NamedNodeMap {
  77. private:
  78.     void     *fImpl;
  79. short    flagElem;
  80. static const unsigned short NNM_ELEMENT;
  81. static const unsigned short NNM_OTHER;
  82. public:
  83.     /** @name Constructors and assignment operator */
  84.     //@{
  85.     /**
  86.       * Default constructor for DOM_NamedNodeMap.  The resulting object does not
  87.       * refer to an actual DOM_NamedNodeMap node; it will compare == to 0, and is similar
  88.       * to a null object reference variable in Java. NamedNopes are instantiated
  89.       * by these methods:  DOM_Node::getAttributes, DOM_DocumentType::getEntities
  90.       * andDOM_DocumentType::getNotations
  91.       *
  92.       */
  93.     DOM_NamedNodeMap();
  94.     /**
  95.       * Copy constructor.  Creates a new <code>DOM_NamedNodeMap</code> reference object
  96.       * that refers to the same underlying NamedNodeMap as the original.
  97.       *
  98.       * @param other The object to be copied.
  99.       */
  100.     DOM_NamedNodeMap(const DOM_NamedNodeMap &other);
  101.     /**
  102.       * Assignment operator.
  103.       *
  104.       * @param other The object to be copied.
  105.       */
  106.     DOM_NamedNodeMap & operator = (const DOM_NamedNodeMap &other);
  107.     /**
  108.       * Assignment operator.
  109.       *
  110.       * @param other The object to be copied.
  111.       */
  112.     DOM_NamedNodeMap & operator = (const DOM_NullPtr *other);
  113.     //@}
  114.     /** @name Destructor. */
  115.     //@{
  116.     /**
  117.       * Destructor for DOM_NamedNodeMap.  The object being destroyed is the reference
  118.       * object, not the underlying NamedNodeMap itself.
  119.       *
  120.       * <p>Like most other DOM types in this implementation, memory management
  121.       * of named node maps is automatic.  Instances of DOM_NamedNodeMap function
  122.       * as references to an underlying heap based implementation object,
  123.       * and should never be explicitly new-ed or deleted in application code, but
  124.       * should appear only as local variables or function parameters.
  125.   *
  126.   */
  127.     ~DOM_NamedNodeMap();
  128.     //@}
  129.     /** @Comparisons. */
  130.     //@{
  131.     /**
  132.      *  Test whether this NamedNodeMap reference refers to the same underlying
  133.      *  named node map as the other reference object.  This does not
  134.      *  compare the contents of two different objects.
  135.      *
  136.      *  @param other The value to be compared
  137.      *  @return Returns true if the underlying named node map is same
  138.      */
  139.     bool operator == (const DOM_NamedNodeMap &other) const;
  140.     /**
  141.      *  Test whether this NamedNodeMap reference refers to a different underlying
  142.      *  named node map as the other reference object.  This does not
  143.      *  compare the contents of two different objects.
  144.      *
  145.      *  @param other The value to be compared
  146.      *  @return Returns true if the underlying named node map is different
  147.      */
  148.     bool operator != (const DOM_NamedNodeMap &other) const;
  149.     /**
  150.      *  Use this comparison operator to test whether a Named Node Map reference
  151.      *  is null.
  152.      *
  153.      *  @param p The value to be compared, which must be 0 or null.
  154.      *  @return Returns true if the named node map is null
  155.      */
  156.     bool operator == (const DOM_NullPtr *p) const;
  157.     /**
  158.      *  Use this comparison operator to test whether a Named Node Map reference
  159.      *  is not null.
  160.      *
  161.      *  @param p The value to be compared, which must not be 0 or null.
  162.      *  @return Returns true if the named node map is not null
  163.      */
  164.     bool operator != (const DOM_NullPtr *p) const;
  165.     //@}
  166.     /** @name Set functions. */
  167.     //@{
  168.     /**
  169.     * Adds a node using its <code>nodeName</code> attribute.
  170.     *
  171.     * <br>As the <code>nodeName</code> attribute is used to derive the name
  172.     * which the node must be stored under, multiple nodes of certain types
  173.     * (those that have a "special" string value) cannot be stored as the names
  174.     * would clash. This is seen as preferable to allowing nodes to be aliased.
  175.     * @param arg A node to store in a named node map. The node will later be
  176.     *   accessible using the value of the <code>nodeName</code> attribute of
  177.     *   the node. If a node with that name is already present in the map, it
  178.     *   is replaced by the new one.
  179.     * @return If the new <code>Node</code> replaces an existing node the
  180.     *   replaced <code>Node</code> is returned,
  181.     *   otherwise <code>null</code> is returned.
  182.     * @exception DOMException
  183.     *   WRONG_DOCUMENT_ERR: Raised if <code>arg</code> was created from a
  184.     *   different document than the one that created the
  185.     *   <code>NamedNodeMap</code>.
  186.     *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this
  187.     *   <code>NamedNodeMap</code> is readonly.
  188.     *   <br>INUSE_ATTRIBUTE_ERR: Raised if <code>arg</code> is an
  189.     *   <code>Attr</code> that is already an attribute of another
  190.     *   <code>Element</code> object. The DOM user must explicitly clone
  191.     *   <code>Attr</code> nodes to re-use them in other elements.
  192.     */
  193.     DOM_Node               setNamedItem(DOM_Node arg);
  194.     //@}
  195.     /** @name Get functions. */
  196.     //@{
  197.     /**
  198.     * Returns the <code>index</code>th item in the map.
  199.     *
  200.     * If <code>index</code>
  201.     * is greater than or equal to the number of nodes in the map, this returns
  202.     * <code>null</code>.
  203.     * @param index Index into the map.
  204.     * @return The node at the <code>index</code>th position in the
  205.     *   <code>NamedNodeMap</code>, or <code>null</code> if that is not a valid
  206.     *   index.
  207.     */
  208.     DOM_Node               item(unsigned int index) const;
  209.     /**
  210.     * Retrieves a node specified by name.
  211.     *
  212.     * @param name The <code>nodeName</code> of a node to retrieve.
  213.     * @return A <code>DOM_Node</code> (of any type) with the specified <code>nodeName</code>, or
  214.     *   <code>null</code> if it does not identify any node in
  215.     *   the map.
  216.     */
  217.     DOM_Node               getNamedItem(const DOMString &name) const;
  218.     /**
  219.     * The number of nodes in the map.
  220.     *
  221.     * The range of valid child node indices is
  222.     * 0 to <code>length-1</code> inclusive.
  223.     */
  224.     unsigned int           getLength() const;
  225.     //@}
  226.     /** @name Functions to change the node collection. */
  227.     //@{
  228.     /**
  229.     * Removes a node specified by name.
  230.     *
  231.     * If the removed node is an
  232.     * <code>Attr</code> with a default value it is immediately replaced.
  233.     * @param name The <code>nodeName</code> of a node to remove.
  234.     * @return The node removed from the map or <code>null</code> if no node
  235.     *   with such a name exists.
  236.     * @exception DOMException
  237.     *   NOT_FOUND_ERR: Raised if there is no node named <code>name</code> in
  238.     *   the map.
  239.     * <br>
  240.     *   NO_MODIFICATION_ALLOWED_ERR: Raised if this <code>NamedNodeMap</code>
  241.     *   is readonly.
  242.     */
  243.     DOM_Node               removeNamedItem(const DOMString &name);
  244.     //@}
  245.     /** @name Functions introduced in DOM Level 2. */
  246.     //@{
  247.     /**
  248.      * Retrieves a node specified by local name and namespace URI.
  249.      *
  250.      * @param namespaceURI The <em>namespace URI</em> of
  251.      *    the node to retrieve.
  252.      * @param localName The <em>local name</em> of the node to retrieve.
  253.      * @return A <code>DOM_Node</code> (of any type) with the specified
  254.      *    local name and namespace URI, or <code>null</code> if they do not
  255.      *    identify any node in the map.
  256.      */
  257.     DOM_Node               getNamedItemNS(const DOMString &namespaceURI,
  258. const DOMString &localName);
  259.     /**
  260.      * Adds a node using its <CODE>namespaceURI</CODE> and <CODE>localName</CODE>.
  261.      *
  262.      * @param arg A node to store in a named node map. The node will later be
  263.      *       accessible using the value of the <CODE>namespaceURI</CODE> and
  264.      *       <CODE>localName</CODE> attribute of the node. If a node with those
  265.      *       namespace URI and local name is already present in the map, it is
  266.      *       replaced by the new one.
  267.      * @return If the new <code>DOM_Node</code> replaces an existing node the
  268.      *   replaced <code>DOM_Node</code> is returned,
  269.      *   otherwise <code>null</code> is returned.
  270.      * @exception DOMException
  271.      *   WRONG_DOCUMENT_ERR: Raised if <code>arg</code> was created from a
  272.      *   different document than the one that created the
  273.      *   <code>DOM_NamedNodeMap</code>.
  274.      *   <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this
  275.      *   <code>vNamedNodeMap</code> is readonly.
  276.      *   <br>INUSE_ATTRIBUTE_ERR: Raised if <code>arg</code> is an
  277.      *   <code>DOM_Attr</code> that is already an attribute of another
  278.      *   <code>DOM_Element</code> object. The DOM user must explicitly clone
  279.      *   <code>DOM_Attr</code> nodes to re-use them in other elements.
  280.      */
  281.     DOM_Node               setNamedItemNS(DOM_Node arg);
  282.     /**
  283.      * Removes a node specified by local name and namespace URI.
  284.      *
  285.      * @param namespaceURI The <em>namespace URI</em> of
  286.      *    the node to remove.
  287.      * @param localName The <em>local name</em> of the
  288.      *    node to remove. When this <code>DOM_NamedNodeMap</code> contains the
  289.      *    attributes attached to an element, as returned by the attributes
  290.      *    attribute of the <code>DOM_Node</code> interface, if the removed
  291.      *    attribute is known to have a default value, an attribute
  292.      *    immediately appears containing the default value
  293.      *    as well as the corresponding namespace URI, local name, and prefix.
  294.      * @return The node removed from the map if a node with such a local name
  295.      *    and namespace URI exists.
  296.      * @exception DOMException
  297.      *   NOT_FOUND_ERR: Raised if there is no node named <code>name</code> in
  298.      *   the map.
  299.      * <br>
  300.      *   NO_MODIFICATION_ALLOWED_ERR: Raised if this <code>DOM_NamedNodeMap</code>
  301.      *   is readonly.
  302.      */
  303.     DOM_Node               removeNamedItemNS(const DOMString &namespaceURI,
  304. const DOMString &localName);
  305.     //@}
  306.  protected:
  307.     DOM_NamedNodeMap(NamedNodeMapImpl *impl);
  308. DOM_NamedNodeMap(NodeImpl *impl);
  309.     friend class DOM_DocumentType;
  310.     friend class DOM_Node;
  311. };
  312. XERCES_CPP_NAMESPACE_END
  313. #endif