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

词法分析

开发平台:

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_NodeIterator.hpp,v 1.3 2002/11/04 15:04:44 tng Exp $
  58.  */
  59. #ifndef DOM_NodeIterator_HEADER_GUARD_
  60. #define DOM_NodeIterator_HEADER_GUARD_
  61. #include "DOM_NodeFilter.hpp"
  62. #include "DOM_Node.hpp"
  63. XERCES_CPP_NAMESPACE_BEGIN
  64. class NodeIteratorImpl;
  65. /**
  66.  * NodeIterators are used to step through a set of nodes
  67.  * e.g. the set of nodes in a NodeList, the document subtree governed by
  68.  * a particular node, the results of a query, or any other set of nodes.
  69.  * The set of nodes to be iterated is determined by the implementation
  70.  * of the NodeIterator. DOM Level 2 specifies a single NodeIterator
  71.  * implementation for document-order traversal of a document
  72.  * subtree. Instances of these iterators are created by calling
  73.  * <code>DocumentTraversal.createNodeIterator()</code>.
  74.  *
  75.  */
  76. class CDOM_EXPORT DOM_NodeIterator
  77. {
  78.     public:
  79.         /** @name Constructors and assignment operator */
  80.         //@{
  81.         /**
  82.           * Default constructor.
  83.           */
  84.         DOM_NodeIterator ();
  85.         /**
  86.           * Copy constructor.
  87.           *
  88.           * @param other The object to be copied.
  89.           */
  90.         DOM_NodeIterator(const DOM_NodeIterator &other);
  91.         /**
  92.           * Assignment operator.
  93.           *
  94.           * @param other The object to be copied.
  95.           */
  96.         DOM_NodeIterator & operator = (const DOM_NodeIterator &other);
  97.         /**
  98.           * Assignment operator.  This overloaded variant is provided for
  99.           *   the sole purpose of setting a DOM_NodeIterator to null.
  100.           *
  101.           * @param val   Only a value of 0, or null, is allowed.
  102.           */
  103.         DOM_NodeIterator & operator = (const DOM_NullPtr *val);
  104.         //@}
  105.         /** @name Destructor. */
  106.         //@{
  107. /**
  108.   * Destructor for DOM_NodeIterator.
  109.   */
  110.         ~DOM_NodeIterator();
  111.         //@}
  112.         /** @name Equality and Inequality operators. */
  113.         //@{
  114.         /**
  115.          * The equality operator.
  116.          *
  117.          * @param other The object reference with which <code>this</code> object is compared
  118.          * @returns True if both <code>DOM_NodeIterator</code>s refer to the same
  119.          *  actual node, or are both null; return false otherwise.
  120.          */
  121.         bool operator == (const DOM_NodeIterator & other)const;
  122.         /**
  123.           *  Compare with a pointer.  Intended only to allow a convenient
  124.           *    comparison with null.
  125.           */
  126.         bool operator == (const DOM_NullPtr *other) const;
  127.         /**
  128.          * The inequality operator.  See operator ==.
  129.          */
  130.         bool operator != (const DOM_NodeIterator & other) const;
  131.          /**
  132.           *  Compare with a pointer.  Intended only to allow a convenient
  133.           *    comparison with null.
  134.           *
  135.           */
  136.         bool operator != (const DOM_NullPtr * other) const;
  137.         //@}
  138.         /** @name Get functions. */
  139.         //@{
  140.         /**
  141.          * The root node of the <code>NodeIterator</code>, as specified when it
  142.          * was created.
  143.          */
  144.         DOM_Node            getRoot();
  145.         /**
  146.           * Return which node types are presented via the iterator.
  147.           * The available set of constants is defined in the DOM_NodeFilter interface.
  148.           *
  149.           */
  150.         unsigned long       getWhatToShow();
  151.         /**
  152.           * Return The filter used to screen nodes.
  153.           *
  154.           */
  155.         DOM_NodeFilter*     getFilter();
  156.         /**
  157.           * Return the expandEntityReferences flag.
  158.           * The value of this flag determines whether the children of entity reference
  159.           * nodes are visible to the DOM_NodeFilter. If false, they will be skipped over.
  160.           *
  161.           */
  162.         bool getExpandEntityReferences();
  163.         /**
  164.           * Returns the next node in the set and advances the position of the iterator
  165.           * in the set. After a DOM_NodeIterator is created, the first call to nextNode()
  166.           * returns the first node in the set.
  167.           *
  168.           * @exception DOMException
  169.           *   INVALID_STATE_ERR: Raised if this method is called after the
  170.           *   <code>detach</code> method was invoked.
  171.           */
  172.         DOM_Node            nextNode();
  173.         /**
  174.           * Returns the previous node in the set and moves the position of the iterator
  175.           * backwards in the set.
  176.           *
  177.           * @exception DOMException
  178.           *   INVALID_STATE_ERR: Raised if this method is called after the
  179.           *   <code>detach</code> method was invoked.
  180.           */
  181.         DOM_Node            previousNode();
  182.         //@}
  183.         /** @name Detaching functions. */
  184.         //@{
  185.         /**
  186.           * Detaches the iterator from the set which it iterated over, releasing any
  187.           * computational resources and placing the iterator in the INVALID state. After
  188.           * <code>detach</code> has been invoked, calls to <code>nextNode</code> or
  189.           * <code>previousNode</code> will raise the exception INVALID_STATE_ERR.
  190.           *
  191.           */
  192. void detach();
  193.         //@}
  194.     protected:
  195.         DOM_NodeIterator (NodeIteratorImpl* impl);
  196.         friend class DOM_Document;
  197.     private:
  198.         NodeIteratorImpl*                 fImpl;
  199. };
  200. XERCES_CPP_NAMESPACE_END
  201. #endif