http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Download
Installation
Build

API Docs
Samples
Schema

FAQs
Programming
Migration

Releases
Bug-Reporting
Feedback

Y2K Compliance
PDF Document

CVS Repository
Mail Archive

API Docs for SAX and DOM
 

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

DOM_NodeFilter.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 1999-2002 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Xerces" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache\@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation, and was
00051  * originally based on software copyright (c) 1999, International
00052  * Business Machines, Inc., http://www.ibm.com .  For more information
00053  * on the Apache Software Foundation, please see
00054  * <http://www.apache.org/>.
00055  */
00056 
00057 /*
00058  * $Log: DOM_NodeFilter.hpp,v $
00059  * Revision 1.2  2002/02/04 19:57:15  tng
00060  * Remove the phrase "Experimental".
00061  *
00062  * Revision 1.1.1.1  2002/02/01 22:21:46  peiyongz
00063  * sane_include
00064  *
00065  * Revision 1.10  2000/10/20 22:03:04  andyh
00066  * DOM NodeFileter - define values for FilterAction enum to match those in the DOM spec.
00067  *
00068  * Revision 1.9  2000/05/11 00:07:38  abagchi
00069  * Removed tables. It was confusing doxygen
00070  *
00071  * Revision 1.8  2000/03/11 03:19:13  chchou
00072  * Fix bug # 19, add const keyword to API
00073  *
00074  * Revision 1.7  2000/02/24 20:11:28  abagchi
00075  * Swat for removing Log from API docs
00076  *
00077  * Revision 1.6  2000/02/17 17:47:25  andyh
00078  * Update Doc++ API comments
00079  * NameSpace update to track W3C
00080  * Changes were made by Chih Hsiang Chou
00081  *
00082  * Revision 1.5  2000/02/15 23:17:37  andyh
00083  * Update Doc++ API comments
00084  * NameSpace bugfix and update to track W3C
00085  * Chih Hsiang Chou
00086  *
00087  * Revision 1.4  2000/02/10 21:47:12  abagchi
00088  * Added API docs
00089  *
00090  * Revision 1.3  2000/02/06 07:47:30  rahulj
00091  * Year 2K copyright swat.
00092  *
00093  * Revision 1.2  2000/02/04 01:49:28  aruna1
00094  * TreeWalker and NodeIterator changes
00095  *
00096  * Revision 1.1.1.1  1999/11/09 01:09:00  twl
00097  * Initial checkin
00098  *
00099  * Revision 1.2  1999/11/08 20:44:19  rahul
00100  * Swat for adding in Product name and CVS comment log variable.
00101  *
00102  */
00103 
00104 // DOM_NodeFilter.h: interface for the DOM_NodeFilter class.
00105 //
00107 
00108 #ifndef DOM_NodeFilter_HEADER_GUARD_
00109 #define DOM_NodeFilter_HEADER_GUARD_
00110 
00111 #include "DOM_Node.hpp"
00112 
00113 class NodeFilterImpl;
00114 
00115 
00135 class  DOM_NodeFilter
00136 {
00137     public:
00140     /*
00141       *     <table><tr><td>FILTER_ACCEPT</td>
00142       *            <td>Accept the node. Navigation methods defined for
00143       *                NodeIterator or TreeWalker will return this node.</td>
00144       *         </tr>
00145       *         <tr><td>
00146       *               FILTER_REJECT</td>
00147       *               <td>Reject the node. Navigation methods defined for
00148       *               NodeIterator or TreeWalker will not return this
00149       *               node. For TreeWalker, the children of this node will
00150       *               also be rejected. Iterators treat this as a synonym
00151       *               for FILTER_SKIP.</td>
00152       *         </tr>
00153       *         <tr><td>FILTER_SKIP</td>
00154       *              <td>Reject the node. Navigation methods defined for
00155       *                  NodeIterator or TreeWalker will not return this
00156       *                  node. For both NodeIterator and Treewalker, the
00157       *                  children of this node will still be considered.</td>
00158       *         </tr>
00159       *     </table>
00160       *
00161       */
00162         enum FilterAction {FILTER_ACCEPT = 1,
00163                            FILTER_REJECT = 2,
00164                            FILTER_SKIP   = 3};
00165 
00166         enum ShowType {
00167             SHOW_ALL                       = 0x0000FFFF,
00168             SHOW_ELEMENT                   = 0x00000001,
00169             SHOW_ATTRIBUTE                 = 0x00000002,
00170             SHOW_TEXT                      = 0x00000004,
00171             SHOW_CDATA_SECTION             = 0x00000008,
00172             SHOW_ENTITY_REFERENCE          = 0x00000010,
00173             SHOW_ENTITY                    = 0x00000020,
00174             SHOW_PROCESSING_INSTRUCTION    = 0x00000040,
00175             SHOW_COMMENT                   = 0x00000080,
00176             SHOW_DOCUMENT                  = 0x00000100,
00177             SHOW_DOCUMENT_TYPE             = 0x00000200,
00178             SHOW_DOCUMENT_FRAGMENT         = 0x00000400,
00179             SHOW_NOTATION                  = 0x00000800
00180         };
00182 
00185 
00188         DOM_NodeFilter();
00190 
00193 
00196         virtual ~DOM_NodeFilter();
00198 
00201 
00210         virtual short acceptNode (const DOM_Node &node) const =0;
00212 
00213     private:
00214         DOM_NodeFilter(const DOM_NodeFilter &other);
00215         DOM_NodeFilter & operator = (const DOM_NodeFilter &other);
00216         bool operator == (const DOM_NodeFilter &other) const;
00217         bool operator != (const DOM_NodeFilter &other) const;
00218 };
00219 
00220 #endif


Copyright © 2000 The Apache Software Foundation. All Rights Reserved.