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

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_NodeFilter.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. // IDOM_NodeFilter.h: interface for the IDOM_NodeFilter class.
  69. //
  70. //////////////////////////////////////////////////////////////////////
  71. #ifndef IDOM_NodeFilter_HEADER_GUARD_
  72. #define IDOM_NodeFilter_HEADER_GUARD_
  73. #include "IDOM_Node.hpp"
  74. class IDNodeFilterImpl;
  75. /**
  76.  * Filters are objects that know how to "filter out" nodes. If a
  77.  * <code>IDOM_NodeIterator</code> or <code>IDOM_TreeWalker</code> is given a
  78.  * filter, it applies the filter before it returns the next node.
  79.  *
  80.  * If the filter says to accept the node, the iterator returns it; otherwise, the
  81.  * iterator looks for the next node and pretends that the node that was rejected
  82.  * was not there.
  83.  *
  84.  *  The DOM does not provide any filters. Filter is just an interface that users can
  85.  *  implement to provide their own filters.
  86.  *
  87.  *  Filters do not need to know how to iterate, nor do they need to know anything
  88.  *  about the data structure that is being iterated. This makes it very easy to write
  89.  *  filters, since the only thing they have to know how to do is evaluate a single node.
  90.  *  One filter may be used with a number of different kinds of iterators, encouraging
  91.  *  code reuse.
  92.  *
  93.  * <p><b>"Experimental - subject to change"</b></p>
  94.  *
  95.  */
  96. class CDOM_EXPORT IDOM_NodeFilter
  97. {
  98.     protected:
  99.         IDOM_NodeFilter() {};
  100.         IDOM_NodeFilter(const IDOM_NodeFilter &other) {};
  101.         IDOM_NodeFilter & operator = (const IDOM_NodeFilter &other) {return *this;};
  102.     public:
  103.         /** @name Enumerators for Node Filter */
  104.         //@{
  105.         /*
  106.          *    <table><tr><td>FILTER_ACCEPT</td>
  107.          *               <td>Accept the node. Navigation methods defined for
  108.          *               NodeIterator or TreeWalker will return this node.</td>
  109.          *           </tr>
  110.          *           <tr>
  111.          *               <td>FILTER_REJECT</td>
  112.          *               <td>Reject the node. Navigation methods defined for
  113.          *               NodeIterator or TreeWalker will not return this
  114.          *               node. For TreeWalker, the children of this node will
  115.          *               also be rejected. Iterators treat this as a synonym
  116.          *               for FILTER_SKIP.</td>
  117.          *           </tr>
  118.          *           <tr><td>FILTER_SKIP</td>
  119.          *               <td>Reject the node. Navigation methods defined for
  120.          *               NodeIterator or TreeWalker will not return this
  121.          *               node. For both NodeIterator and Treewalker, the
  122.          *               children of this node will still be considered.</td>
  123.          *           </tr>
  124.          *    </table>
  125.          *
  126.          */
  127.         enum FilterAction {FILTER_ACCEPT = 1,
  128.                            FILTER_REJECT = 2,
  129.                            FILTER_SKIP   = 3};
  130.         enum ShowType {
  131.             SHOW_ALL                       = 0x0000FFFF,
  132.             SHOW_ELEMENT                   = 0x00000001,
  133.             SHOW_ATTRIBUTE                 = 0x00000002,
  134.             SHOW_TEXT                      = 0x00000004,
  135.             SHOW_CDATA_SECTION             = 0x00000008,
  136.             SHOW_ENTITY_REFERENCE          = 0x00000010,
  137.             SHOW_ENTITY                    = 0x00000020,
  138.             SHOW_PROCESSING_INSTRUCTION    = 0x00000040,
  139.             SHOW_COMMENT                   = 0x00000080,
  140.             SHOW_DOCUMENT                  = 0x00000100,
  141.             SHOW_DOCUMENT_TYPE             = 0x00000200,
  142.             SHOW_DOCUMENT_FRAGMENT         = 0x00000400,
  143.             SHOW_NOTATION                  = 0x00000800
  144.         };
  145.         //@}
  146.         /** @name Test function. */
  147.         //@{
  148.         /**
  149.          * Test whether a specified node is visible in the logical view of a IDOM_TreeWalker
  150.          * or IDOM_NodeIterator. This function will be called by the implementation of
  151.          * IDOM_TreeWalker and IDOM_NodeIterator; it is not intended to be called directly from user
  152.          * code.
  153.          *
  154.          * <p><b>"Experimental - subject to change"</b></p>
  155.          *
  156.          * @param node The node to check to see if it passes the filter or not.
  157.          * @return A constant to determine whether the node is accepted, rejected, or skipped.
  158.          */
  159.         virtual short acceptNode (const IDOM_Node* node) const =0;
  160.         //@}
  161. };
  162. #endif