IDOM_TreeWalker.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) 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_TreeWalker.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:56  tng
  62.  * Copyright update.
  63.  *
  64.  * Revision 1.1.1.1  2001/04/03 00:14:33  andyh
  65.  * IDOM
  66.  *
  67.  */
  68. #ifndef IDOM_TreeWalker_HEADER_GUARD_
  69. #define IDOM_TreeWalker_HEADER_GUARD_
  70. #include "IDOM_Node.hpp"
  71. #include "IDOM_NodeFilter.hpp"
  72. /**
  73.  * <code>IDOM_TreeWalker</code> objects are used to navigate a document tree or
  74.  * subtree using the view of the document defined by its <code>whatToShow</code>
  75.  * flags and any filters that are defined for the <code>IDOM_TreeWalker</code>. Any
  76.  * function which performs navigation using a <code>IDOM_TreeWalker</code> will
  77.  * automatically support any view defined by a <code>IDOM_TreeWalker</code>.
  78.  *
  79.  * Omitting nodes from the logical view of a subtree can result in a structure that is
  80.  * substantially different from the same subtree in the complete, unfiltered document. Nodes
  81.  * that are siblings in the IDOM_TreeWalker view may be children of different, widely separated
  82.  * nodes in the original view. For instance, consider a Filter that skips all nodes except for
  83.  * Text nodes and the root node of a document. In the logical view that results, all text
  84.  * nodes will be siblings and appear as direct children of the root node, no matter how
  85.  * deeply nested the structure of the original document.
  86.  *
  87.  * <p><b>"Experimental - subject to change"</b></p>
  88.  *
  89.  */
  90. class CDOM_EXPORT IDOM_TreeWalker {
  91.     protected:
  92.         IDOM_TreeWalker() {};
  93.         IDOM_TreeWalker(const IDOM_TreeWalker &other) {};
  94.         IDOM_TreeWalker & operator = (const IDOM_TreeWalker &other) {return *this;};
  95.     public:
  96.         /** @name Get functions. */
  97.         //@{
  98.         /**
  99.           * Return which node types are presented via the IDOM_TreeWalker.
  100.           * These constants are defined in the IDOM_NodeFilter interface.
  101.           *
  102.           * <p><b>"Experimental - subject to change"</b></p>
  103.           *
  104.           */
  105.         virtual unsigned long    getWhatToShow()= 0;
  106.         /**
  107.           * Return The filter used to screen nodes.
  108.           *
  109.           * <p><b>"Experimental - subject to change"</b></p>
  110.           *
  111.           */
  112.         virtual IDOM_NodeFilter* getFilter()= 0;
  113.         /**
  114.           * Return the expandEntityReferences flag.
  115.           * The value of this flag determines whether the children of entity reference
  116.           * nodes are visible to the IDOM_TreeWalker. If false, they will be skipped over.
  117.           *
  118.           * <p><b>"Experimental - subject to change"</b></p>
  119.           *
  120.           */
  121.         virtual bool getExpandEntityReferences()= 0;
  122.         /**
  123.           * Return the node at which the IDOM_TreeWalker is currently positioned.
  124.           *
  125.           * <p><b>"Experimental - subject to change"</b></p>
  126.           *
  127.           */
  128.         virtual IDOM_Node* getCurrentNode()= 0;
  129.         /**
  130.           * Moves to and returns the closest visible ancestor node of the current node.
  131.           * If the search for parentNode attempts to step upward from the IDOM_TreeWalker's root
  132.           * node, or if it fails to find a visible ancestor node, this method retains the
  133.           * current position and returns null.
  134.           *
  135.           * <p><b>"Experimental - subject to change"</b></p>
  136.           *
  137.           */
  138.         virtual IDOM_Node* parentNode()= 0;
  139.         /**
  140.           * Moves the <code>IDOM_TreeWalker</code> to the first child of the current node,
  141.           * and returns the new node. If the current node has no children, returns
  142.           * <code>null</code>, and retains the current node.
  143.           *
  144.           * <p><b>"Experimental - subject to change"</b></p>
  145.           *
  146.           */
  147.         virtual IDOM_Node* firstChild()= 0;
  148.         /**
  149.           * Moves the <code>IDOM_TreeWalker</code> to the last child of the current node, and
  150.           * returns the new node. If the current node has no children, returns
  151.           * <code>null</code>, and retains the current node.
  152.           *
  153.           * <p><b>"Experimental - subject to change"</b></p>
  154.           *
  155.           */
  156.         virtual IDOM_Node* lastChild()= 0;
  157.         /**
  158.           * Moves the <code>IDOM_TreeWalker</code> to the previous sibling of the current
  159.           * node, and returns the new node. If the current node has no previous sibling,
  160.           * returns <code>null</code>, and retains the current node.
  161.           *
  162.           * <p><b>"Experimental - subject to change"</b></p>
  163.           *
  164.           */
  165.         virtual IDOM_Node* previousSibling()= 0;
  166.         /**
  167.           * Moves the <code>IDOM_TreeWalker</code> to the next sibling of the current node,
  168.           * and returns the new node. If the current node has no next sibling, returns
  169.           * <code>null</code>, and retains the current node.
  170.           *
  171.           * <p><b>"Experimental - subject to change"</b></p>
  172.           *
  173.           */
  174.         virtual IDOM_Node* nextSibling()= 0;
  175.         /**
  176.           * Moves the <code>IDOM_TreeWalker</code> to the previous visible node in document
  177.           * order relative to the current node, and returns the new node. If the current
  178.           * node has no previous node,
  179.           * or if the search for previousNode attempts to step upward from the IDOM_TreeWalker's
  180.           * root node, returns <code>null</code>, and retains the current node.
  181.           *
  182.           * <p><b>"Experimental - subject to change"</b></p>
  183.           *
  184.           */
  185.         virtual IDOM_Node* previousNode()= 0;
  186.         /**
  187.           * Moves the <code>IDOM_TreeWalker</code> to the next visible node in document order
  188.           * relative to the current node, and returns the new node. If the current node has
  189.           * no next node,
  190.           * or if the search for nextNode attempts to step upward from the IDOM_TreeWalker's
  191.           * root node, returns <code>null</code>, and retains the current node.
  192.           *
  193.           * <p><b>"Experimental - subject to change"</b></p>
  194.           *
  195.           */
  196.         virtual IDOM_Node* nextNode()= 0;
  197.         //@}
  198.         /** @name Set functions. */
  199.         //@{
  200.         /**
  201.           * Set the node at which the IDOM_TreeWalker is currently positioned.
  202.           *
  203.           * <p><b>"Experimental - subject to change"</b></p>
  204.           *
  205.           */
  206.         virtual void setCurrentNode(IDOM_Node* currentNode)= 0;
  207.         //@}
  208. };
  209. #endif