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

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  * 
  4.  * Copyright (c) 1999-2000 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.  * $Log: DOM_NodeList.hpp,v $
  58.  * Revision 1.9  2000/04/19 02:26:16  aruna1
  59.  * Full support for DOM_EntityReference, DOM_Entity and DOM_DocumentType introduced
  60.  *
  61.  * Revision 1.8  2000/03/02 19:53:56  roddey
  62.  * This checkin includes many changes done while waiting for the
  63.  * 1.1.0 code to be finished. I can't list them all here, but a list is
  64.  * available elsewhere.
  65.  *
  66.  * Revision 1.7  2000/02/24 20:11:28  abagchi
  67.  * Swat for removing Log from API docs
  68.  *
  69.  * Revision 1.6  2000/02/10 20:38:46  abagchi
  70.  * Added docs for equality operators
  71.  *
  72.  * Revision 1.5  2000/02/06 07:47:30  rahulj
  73.  * Year 2K copyright swat.
  74.  *
  75.  * Revision 1.4  2000/02/04 01:49:27  aruna1
  76.  * TreeWalker and NodeIterator changes
  77.  *
  78.  * Revision 1.3  2000/01/22 01:38:29  andyh
  79.  * Remove compiler warnings in DOM impl classes
  80.  *
  81.  * Revision 1.2  2000/01/05 01:16:08  andyh
  82.  * DOM Level 2 core, namespace support added.
  83.  *
  84.  * Revision 1.1.1.1  1999/11/09 01:09:02  twl
  85.  * Initial checkin
  86.  *
  87.  * Revision 1.2  1999/11/08 20:44:20  rahul
  88.  * Swat for adding in Product name and CVS comment log variable.
  89.  *
  90.  */
  91. #ifndef DOM_NodeList_HEADER_GUARD_
  92. #define DOM_NodeList_HEADER_GUARD_
  93. #include <util/XercesDefs.hpp>
  94. #include <dom/DOM_Node.hpp>
  95. class NodeListImpl;
  96. /**
  97.  * The <code>NodeList</code> interface provides the abstraction of an ordered 
  98.  * collection of nodes.  NodeLists are created by DOM_Document::getElementsByTagName(), 
  99.  * DOM_Node::getChildNodes(), 
  100.  *
  101.  * <p>The items in the <code>NodeList</code> are accessible via an integral 
  102.  * index, starting from 0. 
  103.  *
  104.  * NodeLists are "live", in that any changes to the document tree are immediately
  105.  * reflected in any NodeLists that may have been created for that tree.
  106.  */
  107. class  CDOM_EXPORT DOM_NodeList {
  108. private:
  109.     NodeListImpl *fImpl;
  110. public:
  111.     /** @name Constructors and assignment operator */
  112.     //@{
  113.     /**
  114.       * Default constructor for DOM_NodeList.  The resulting object does not
  115.       * refer to an actual NodeList; it will compare == to 0, and is similar
  116.       * to a null object reference variable in Java.  It may subsequently be
  117.       * assigned to refer to an actual NodeList.
  118.       *
  119.       */
  120.     DOM_NodeList();
  121.     /**
  122.       * Copy constructor.
  123.       *
  124.       * @param other The object to be copied.
  125.       */
  126.     DOM_NodeList(const DOM_NodeList &other);
  127.     /**
  128.       * Assignment operator.
  129.       *
  130.       * @param other The object to be copied.
  131.       */
  132.     DOM_NodeList & operator = (const DOM_NodeList &other);
  133.     /**
  134.       * Assignment operator.  This overloaded variant is provided for
  135.       *   the sole purpose of setting a DOM_Node reference variable to
  136.       *   zero.  Nulling out a reference variable in this way will decrement
  137.       *   the reference count on the underlying Node object that the variable
  138.       *   formerly referenced.  This effect is normally obtained when reference
  139.       *   variable goes out of scope, but zeroing them can be useful for
  140.       *   global instances, or for local instances that will remain in scope
  141.       *   for an extended time,  when the storage belonging to the underlying
  142.       *   node needs to be reclaimed.
  143.       *
  144.       * @param val.  Only a value of 0, or null, is allowed.
  145.       */
  146.     DOM_NodeList & operator = (const DOM_NullPtr *val);
  147.     //@}
  148.     /** @name Destructor. */
  149.     //@{
  150.  /**
  151.   * Destructor for DOM_NodeList.  The object being destroyed is the reference
  152.       * object, not the underlying NodeList node itself.
  153.   *
  154.       * <p>Like most other DOM types in this implementation, memory management
  155.       * of Node Lists is automatic.  Instances of DOM_NodeList function
  156.       * as references to an underlying heap based implementation object,
  157.       * and should never be explicitly new-ed or deleted in application code, but
  158.       * should appear only as local variables or function parameters.
  159.   */
  160.     ~DOM_NodeList();
  161.     //@}
  162.     /** @name Comparison operators. */
  163.     //@{
  164.     /**
  165.       *  Equality operator.
  166.       *  Compares whether two node list
  167.       *  variables refer to the same underlying node list.  It does
  168.       *  not compare the contents of the node lists themselves.
  169.       *
  170.       *  @param other The value to be compared
  171.       *  @return Returns true if node list refers to same underlying node list
  172.       */
  173.     bool operator == (const DOM_NodeList &other) const;
  174.     /**
  175.      *  Use this comparison operator to test whether a Node List reference
  176.      *  is null.
  177.      *
  178.      *  @param nullPtr The value to be compared, which must be 0 or null.
  179.      *  @return Returns true if node list reference is null
  180.      */
  181.     bool operator == (const DOM_NullPtr *nullPtr) const;
  182.      /**
  183.       *  Inequality operator.
  184.       *  Compares whether two node list
  185.       *  variables refer to the same underlying node list.  It does
  186.       *  not compare the contents of the node lists themselves.
  187.       *
  188.       *  @param other The value to be compared
  189.       *  @return Returns true if node list refers to a different underlying node list
  190.       */
  191.     bool operator != (const DOM_NodeList &other) const;
  192.     /**
  193.      *  Use this comparison operator to test whether a Node List reference
  194.      *  is not null.
  195.      *
  196.      *  @param nullPtr The value to be compared, which must be 0 or null.
  197.      *  @return Returns true if node list reference is not null
  198.      */
  199.     bool operator != (const DOM_NullPtr *nullPtr) const; 
  200.     //@}
  201.     /** @name Get functions. */
  202.     //@{
  203.     /**
  204.      * Returns the <code>index</code>th item in the collection. 
  205.      *
  206.      * If <code>index</code> is greater than or equal to the number of nodes in 
  207.      * the list, this returns <code>null</code>.
  208.      *
  209.      * @param index Index into the collection.
  210.      * @return The node at the <code>index</code>th position in the 
  211.      *   <code>NodeList</code>, or <code>null</code> if that is not a valid 
  212.      *   index.
  213.      */
  214.     DOM_Node  item(unsigned int index) const;
  215.     /**
  216.      * Returns the number of nodes in the list. 
  217.      *
  218.      * The range of valid child node indices is 0 to <code>length-1</code> inclusive. 
  219.      */
  220.     unsigned int getLength() const;
  221.     //@}
  222. protected:
  223.     DOM_NodeList(NodeListImpl *impl);
  224.     friend class DOM_Document;
  225.     friend class DOM_Element;
  226.     friend class DOM_Node;
  227.     friend class DOM_Entity;
  228. };
  229. #endif