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

词法分析

开发平台:

Visual C++

  1. #ifndef DOMNodeIterator_HEADER_GUARD_
  2. #define DOMNodeIterator_HEADER_GUARD_
  3. /*
  4.  * The Apache Software License, Version 1.1
  5.  *
  6.  * Copyright (c) 2001-2002 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.  * $Id: DOMNodeIterator.hpp,v 1.7 2003/03/07 19:59:07 tng Exp $
  60.  */
  61. #include "DOMNodeFilter.hpp"
  62. #include "DOMNode.hpp"
  63. XERCES_CPP_NAMESPACE_BEGIN
  64. /**
  65.  * <code>DOMNodeIterators</code> are used to step through a set of nodes, e.g.
  66.  * the set of nodes in a <code>DOMNodeList</code>, the document subtree
  67.  * governed by a particular <code>DOMNode</code>, the results of a query, or
  68.  * any other set of nodes. The set of nodes to be iterated is determined by
  69.  * the implementation of the <code>DOMNodeIterator</code>. DOM Level 2
  70.  * specifies a single <code>DOMNodeIterator</code> implementation for
  71.  * document-order traversal of a document subtree. Instances of these
  72.  * <code>DOMNodeIterators</code> are created by calling
  73.  * <code>DOMDocumentTraversal</code><code>.createNodeIterator()</code>.
  74.  * <p>See also the <a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Traversal-Range-20001113'>Document Object Model (DOM) Level 2 Traversal and Range Specification</a>.
  75.  * @since DOM Level 2
  76.  */
  77. class CDOM_EXPORT DOMNodeIterator
  78. {
  79. protected:
  80.     // -----------------------------------------------------------------------
  81.     //  Hidden constructors
  82.     // -----------------------------------------------------------------------
  83.     /** @name Hidden constructors */
  84.     //@{    
  85.     DOMNodeIterator() {};
  86.     //@}
  87. private:    
  88.     // -----------------------------------------------------------------------
  89.     // Unimplemented constructors and operators
  90.     // -----------------------------------------------------------------------
  91.     /** @name Unimplemented constructors and operators */
  92.     //@{
  93.     DOMNodeIterator(const DOMNodeIterator &);
  94.     DOMNodeIterator & operator = (const DOMNodeIterator &);
  95.     //@}
  96. public:
  97.     // -----------------------------------------------------------------------
  98.     //  All constructors are hidden, just the destructor is available
  99.     // -----------------------------------------------------------------------
  100.     /** @name Destructor */
  101.     //@{
  102.     /**
  103.      * Destructor
  104.      *
  105.      */
  106.     virtual ~DOMNodeIterator() {};
  107.     //@}
  108.     // -----------------------------------------------------------------------
  109.     //  Virtual DOMNodeFilter interface
  110.     // -----------------------------------------------------------------------
  111.     /** @name Functions introduced in DOM Level 2 */
  112.     //@{
  113.     // -----------------------------------------------------------------------
  114.     //  Getter methods
  115.     // -----------------------------------------------------------------------
  116.     /**
  117.      * The <code>root</code> node of the <code>DOMNodeIterator</code>, as specified
  118.      * when it was created.
  119.      * @since DOM Level 2
  120.      */
  121.     virtual DOMNode*           getRoot() = 0;
  122.     /**
  123.      * Return which node types are presented via the iterator.
  124.      * This attribute determines which node types are presented via the
  125.      * <code>DOMNodeIterator</code>. The available set of constants is defined
  126.      * in the <code>DOMNodeFilter</code> interface.  Nodes not accepted by
  127.      * <code>whatToShow</code> will be skipped, but their children may still
  128.      * be considered. Note that this skip takes precedence over the filter,
  129.      * if any.
  130.      * @since DOM Level 2
  131.      *
  132.      */
  133.     virtual unsigned long      getWhatToShow() = 0;
  134.     /**
  135.      * The <code>DOMNodeFilter</code> used to screen nodes.
  136.      *
  137.      * @since DOM Level 2
  138.      */
  139.     virtual DOMNodeFilter*     getFilter() = 0;
  140.     /**
  141.      * Return the expandEntityReferences flag.
  142.      * The value of this flag determines whether the children of entity
  143.      * reference nodes are visible to the <code>DOMNodeIterator</code>. If
  144.      * false, these children  and their descendants will be rejected. Note
  145.      * that this rejection takes precedence over <code>whatToShow</code> and
  146.      * the filter. Also note that this is currently the only situation where
  147.      * <code>DOMNodeIterators</code> may reject a complete subtree rather than
  148.      * skipping individual nodes.
  149.      * <br>
  150.      * <br> To produce a view of the document that has entity references
  151.      * expanded and does not expose the entity reference node itself, use
  152.      * the <code>whatToShow</code> flags to hide the entity reference node
  153.      * and set <code>expandEntityReferences</code> to true when creating the
  154.      * <code>DOMNodeIterator</code>. To produce a view of the document that has
  155.      * entity reference nodes but no entity expansion, use the
  156.      * <code>whatToShow</code> flags to show the entity reference node and
  157.      * set <code>expandEntityReferences</code> to false.
  158.      *
  159.      * @since DOM Level 2
  160.      */
  161.     virtual bool               getExpandEntityReferences() = 0;
  162.     // -----------------------------------------------------------------------
  163.     //  Query methods
  164.     // -----------------------------------------------------------------------
  165.     /**
  166.      * Returns the next node in the set and advances the position of the
  167.      * <code>DOMNodeIterator</code> in the set. After a
  168.      * <code>DOMNodeIterator</code> is created, the first call to
  169.      * <code>nextNode()</code> returns the first node in the set.
  170.      * @return The next <code>DOMNode</code> in the set being iterated over, or
  171.      *   <code>null</code> if there are no more members in that set.
  172.      * @exception DOMException
  173.      *   INVALID_STATE_ERR: Raised if this method is called after the
  174.      *   <code>detach</code> method was invoked.
  175.      * @since DOM Level 2
  176.      */
  177.     virtual DOMNode*           nextNode() = 0;
  178.     /**
  179.      * Returns the previous node in the set and moves the position of the
  180.      * <code>DOMNodeIterator</code> backwards in the set.
  181.      * @return The previous <code>DOMNode</code> in the set being iterated over,
  182.      *   or <code>null</code> if there are no more members in that set.
  183.      * @exception DOMException
  184.      *   INVALID_STATE_ERR: Raised if this method is called after the
  185.      *   <code>detach</code> method was invoked.
  186.      * @since DOM Level 2
  187.      */
  188.     virtual DOMNode*           previousNode() = 0;
  189.     /**
  190.      * Detaches the <code>DOMNodeIterator</code> from the set which it iterated
  191.      * over, releasing any computational resources and placing the
  192.      * <code>DOMNodeIterator</code> in the INVALID state. After
  193.      * <code>detach</code> has been invoked, calls to <code>nextNode</code>
  194.      * or <code>previousNode</code> will raise the exception
  195.      * INVALID_STATE_ERR.
  196.      * @since DOM Level 2
  197.      */
  198.     virtual void               detach() = 0;
  199.     //@}
  200.     // -----------------------------------------------------------------------
  201.     //  Non-standard Extension
  202.     // -----------------------------------------------------------------------
  203.     /** @name Non-standard Extension */
  204.     //@{
  205.     /**
  206.      * Called to indicate that this NodeIterator is no longer in use
  207.      * and that the implementation may relinquish any resources associated with it.
  208.      * (release() will call detach() where appropriate)
  209.      *
  210.      * Access to a released object will lead to unexpected result.
  211.      */
  212.     virtual void               release() = 0;
  213.     //@}
  214. };
  215. XERCES_CPP_NAMESPACE_END
  216. #endif