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

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2001 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) 2001, 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: IDOM_NodeIterator.hpp,v $
  58.  * Revision 1.3  2001/06/04 20:11:53  tng
  59.  * IDOM: Complete IDNodeIterator, IDTreeWalker, IDNodeFilter.
  60.  *
  61.  * Revision 1.2  2001/05/11 13:25:53  tng
  62.  * Copyright update.
  63.  *
  64.  * Revision 1.1.1.1  2001/04/03 00:14:31  andyh
  65.  * IDOM
  66.  *
  67.  */
  68. #ifndef IDOM_NodeIterator_HEADER_GUARD_
  69. #define IDOM_NodeIterator_HEADER_GUARD_
  70. #include "IDOM_NodeFilter.hpp"
  71. #include "IDOM_Node.hpp"
  72. class IDNodeIteratorImpl;
  73. /**
  74.  * NodeIterators are used to step through a set of nodes
  75.  * e.g. the set of nodes in a NodeList, the document subtree governed by
  76.  * a particular node, the results of a query, or any other set of nodes.
  77.  * The set of nodes to be iterated is determined by the implementation
  78.  * of the NodeIterator. DOM Level 2 specifies a single NodeIterator
  79.  * implementation for document-order traversal of a document
  80.  * subtree. Instances of these iterators are created by calling
  81.  * <code>DocumentTraversal.createNodeIterator()</code>.
  82.  *
  83.  * <p><b>"Experimental - subject to change"</b></p>
  84.  *
  85.  */
  86. class CDOM_EXPORT IDOM_NodeIterator
  87. {
  88.     protected:
  89.         IDOM_NodeIterator() {};
  90.         IDOM_NodeIterator(const IDOM_NodeIterator &other) {};
  91.         IDOM_NodeIterator & operator = (const IDOM_NodeIterator &other) {return *this;};
  92.     public:
  93.         /** @name Get functions. */
  94.         //@{
  95.         /**
  96.           * Return which node types are presented via the iterator.
  97.           * The available set of constants is defined in the IDOM_NodeFilter interface.
  98.           *
  99.           * <p><b>"Experimental - subject to change"</b></p>
  100.           *
  101.           */
  102.         virtual unsigned long       getWhatToShow() = 0;
  103.         /**
  104.           * Return The filter used to screen nodes.
  105.           *
  106.           * <p><b>"Experimental - subject to change"</b></p>
  107.           *
  108.           */
  109.         virtual IDOM_NodeFilter*     getFilter() = 0;
  110.         /**
  111.           * Return the expandEntityReferences flag.
  112.           * The value of this flag determines whether the children of entity reference
  113.           * nodes are visible to the IDOM_NodeFilter. If false, they will be skipped over.
  114.           *
  115.           * <p><b>"Experimental - subject to change"</b></p>
  116.           *
  117.           */
  118.         virtual bool getExpandEntityReferences() = 0;
  119.         /**
  120.           * Returns the next node in the set and advances the position of the iterator
  121.           * in the set. After a IDOM_NodeIterator is created, the first call to nextNode()
  122.           * returns the first node in the set.
  123.           *
  124.           * <p><b>"Experimental - subject to change"</b></p>
  125.           *
  126.           * @exception DOMException
  127.           *   INVALID_STATE_ERR: Raised if this method is called after the
  128.           *   <code>detach</code> method was invoked.
  129.           */
  130.         virtual IDOM_Node*           nextNode() = 0;
  131.         /**
  132.           * Returns the previous node in the set and moves the position of the iterator
  133.           * backwards in the set.
  134.           *
  135.           * <p><b>"Experimental - subject to change"</b></p>
  136.           *
  137.           * @exception DOMException
  138.           *   INVALID_STATE_ERR: Raised if this method is called after the
  139.           *   <code>detach</code> method was invoked.
  140.           */
  141.         virtual IDOM_Node*           previousNode() = 0;
  142.         //@}
  143.         /** @name Detaching functions. */
  144.         //@{
  145.         /**
  146.           * Detaches the iterator from the set which it iterated over, releasing any
  147.           * computational resources and placing the iterator in the INVALID state. After
  148.           * <code>detach</code> has been invoked, calls to <code>nextNode</code> or
  149.           * <code>previousNode</code> will raise the exception INVALID_STATE_ERR.
  150.           *
  151.           * <p><b>"Experimental - subject to change"</b></p>
  152.           *
  153.           */
  154.         virtual void                 detach() = 0;
  155.         //@}
  156. };
  157. #endif