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

词法分析

开发平台:

Visual C++

  1. #ifndef DOMDocumentTraversal_HEADER_GUARD_
  2. #define DOMDocumentTraversal_HEADER_GUARD_
  3. /*
  4.  * The Apache Software License, Version 1.1
  5.  *
  6.  * Copyright (c) 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) 2002, 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: DOMDocumentTraversal.hpp,v 1.6 2003/03/07 19:59:02 tng Exp $
  60. */
  61. #include <xercesc/util/XercesDefs.hpp>
  62. XERCES_CPP_NAMESPACE_BEGIN
  63. class DOMNode;
  64. class DOMNodeFilter;
  65. class DOMNodeIterator;
  66. class DOMTreeWalker;
  67. /**
  68.  * <code>DOMDocumentTraversal</code> contains methods that create
  69.  * <code>DOMNodeIterators</code> and <code>DOMTreeWalkers</code> to traverse a
  70.  * node and its children in document order (depth first, pre-order
  71.  * traversal, which is equivalent to the order in which the start tags occur
  72.  * in the text representation of the document). In DOMs which support the
  73.  * Traversal feature, <code>DOMDocumentTraversal</code> will be implemented by
  74.  * the same objects that implement the DOMDocument interface.
  75.  * <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>.
  76.  * @since DOM Level 2
  77.  */
  78. class CDOM_EXPORT DOMDocumentTraversal {
  79. protected:
  80.     // -----------------------------------------------------------------------
  81.     //  Hidden constructors
  82.     // -----------------------------------------------------------------------
  83.     /** @name Hidden constructors */
  84.     //@{    
  85.     DOMDocumentTraversal() {};
  86.     //@}
  87. private:
  88.     // -----------------------------------------------------------------------
  89.     // Unimplemented constructors and operators
  90.     // -----------------------------------------------------------------------
  91.     /** @name Unimplemented constructors and operators */
  92.     //@{
  93.     DOMDocumentTraversal(const DOMDocumentTraversal &);
  94.     DOMDocumentTraversal & operator = (const DOMDocumentTraversal &);
  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 ~DOMDocumentTraversal() {};
  107.     //@}
  108.     // -----------------------------------------------------------------------
  109.     //  Virtual DOMDocumentRange interface
  110.     // -----------------------------------------------------------------------
  111.     /** @name Functions introduced in DOM Level 2 */
  112.     //@{
  113.     /**
  114.      * Creates a NodeIterator object.   (DOM2)
  115.      *
  116.      * NodeIterators are used to step through a set of nodes, e.g. the set of nodes in a NodeList, the
  117.      * document subtree governed by a particular node, the results of a query, or any other set of nodes.
  118.      * The set of nodes to be iterated is determined by the implementation of the NodeIterator. DOM Level 2
  119.      * specifies a single NodeIterator implementation for document-order traversal of a document subtree.
  120.      * Instances of these iterators are created by calling <code>DOMDocumentTraversal.createNodeIterator()</code>.
  121.      *
  122.      * To produce a view of the document that has entity references expanded and does not
  123.      * expose the entity reference node itself, use the <code>whatToShow</code> flags to hide the entity
  124.      * reference node and set expandEntityReferences to true when creating the iterator. To
  125.      * produce a view of the document that has entity reference nodes but no entity expansion,
  126.      * use the <code>whatToShow</code> flags to show the entity reference node and set
  127.      * expandEntityReferences to false.
  128.      *
  129.      * @param root The root node of the DOM tree
  130.      * @param whatToShow This attribute determines which node types are presented via the iterator.
  131.      * @param filter The filter used to screen nodes
  132.      * @param entityReferenceExpansion The value of this flag determines whether the children of entity reference nodes are
  133.      *                   visible to the iterator. If false, they will be skipped over.
  134.      * @since DOM Level 2
  135.      */
  136.     virtual DOMNodeIterator *createNodeIterator(DOMNode         *root,
  137.                                                    unsigned long    whatToShow,
  138.                                                    DOMNodeFilter* filter,
  139.                                                    bool             entityReferenceExpansion) = 0;
  140.     /**
  141.      * Creates a TreeWalker object.   (DOM2)
  142.      *
  143.      * TreeWalker objects are used to navigate a document tree or subtree using the view of the document defined
  144.      * by its whatToShow flags and any filters that are defined for the TreeWalker. Any function which performs
  145.      * navigation using a TreeWalker will automatically support any view defined by a TreeWalker.
  146.      *
  147.      * Omitting nodes from the logical view of a subtree can result in a structure that is substantially different from
  148.      * the same subtree in the complete, unfiltered document. Nodes that are siblings in the TreeWalker view may
  149.      * be children of different, widely separated nodes in the original view. For instance, consider a Filter that skips
  150.      * all nodes except for DOMText nodes and the root node of a document. In the logical view that results, all text
  151.      * nodes will be siblings and appear as direct children of the root node, no matter how deeply nested the
  152.      * structure of the original document.
  153.      *
  154.      * To produce a view of the document that has entity references expanded
  155.      * and does not expose the entity reference node itself, use the whatToShow
  156.      * flags to hide the entity reference node and set <code>expandEntityReferences</code> to
  157.      * true when creating the TreeWalker. To produce a view of the document
  158.      * that has entity reference nodes but no entity expansion, use the
  159.      * <code>whatToShow</code> flags to show the entity reference node and set
  160.      * <code>expandEntityReferences</code> to false
  161.      *
  162.      * @param root The root node of the DOM tree
  163.      * @param whatToShow This attribute determines which node types are presented via the tree-walker.
  164.      * @param filter The filter used to screen nodes
  165.      * @param entityReferenceExpansion The value of this flag determines whether the children of entity reference nodes are
  166.      *                   visible to the tree-walker. If false, they will be skipped over.
  167.      * @since DOM Level 2
  168.      */
  169.     virtual DOMTreeWalker  *createTreeWalker(DOMNode        *root,
  170.                                                unsigned long     whatToShow,
  171.                                                DOMNodeFilter  *filter,
  172.                                                bool              entityReferenceExpansion) = 0;
  173.     //@}
  174. };
  175. XERCES_CPP_NAMESPACE_END
  176. #endif