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

API Docs

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-2000 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.9  2000/05/11 00:07:38  abagchi
00060  * Removed tables. It was confusing doxygen
00061  *
00062  * Revision 1.8  2000/03/11 03:19:13  chchou
00063  * Fix bug # 19, add const keyword to API
00064  *
00065  * Revision 1.7  2000/02/24 20:11:28  abagchi
00066  * Swat for removing Log from API docs
00067  *
00068  * Revision 1.6  2000/02/17 17:47:25  andyh
00069  * Update Doc++ API comments
00070  * NameSpace update to track W3C
00071  * Changes were made by Chih Hsiang Chou
00072  *
00073  * Revision 1.5  2000/02/15 23:17:37  andyh
00074  * Update Doc++ API comments
00075  * NameSpace bugfix and update to track W3C
00076  * Chih Hsiang Chou
00077  *
00078  * Revision 1.4  2000/02/10 21:47:12  abagchi
00079  * Added API docs
00080  *
00081  * Revision 1.3  2000/02/06 07:47:30  rahulj
00082  * Year 2K copyright swat.
00083  *
00084  * Revision 1.2  2000/02/04 01:49:28  aruna1
00085  * TreeWalker and NodeIterator changes
00086  *
00087  * Revision 1.1.1.1  1999/11/09 01:09:00  twl
00088  * Initial checkin
00089  *
00090  * Revision 1.2  1999/11/08 20:44:19  rahul
00091  * Swat for adding in Product name and CVS comment log variable.
00092  *
00093  */
00094 
00095 // DOM_NodeFilter.h: interface for the DOM_NodeFilter class.
00096 //
00098 
00099 #ifndef DOM_NodeFilter_HEADER_GUARD_
00100 #define DOM_NodeFilter_HEADER_GUARD_
00101 
00102 #include "DOM_Node.hpp"
00103 
00104 class NodeFilterImpl;
00105 
00106 
00128 class  DOM_NodeFilter
00129 {
00130     public:
00132         //@{
00133     /*
00134       *     <table><tr><td>FILTER_ACCEPT</td>
00135       *            <td>Accept the node. Navigation methods defined for
00136       *                NodeIterator or TreeWalker will return this node.</td>
00137       *         </tr>
00138       *         <tr><td>
00139       *               FILTER_REJECT</td>
00140       *               <td>Reject the node. Navigation methods defined for
00141       *               NodeIterator or TreeWalker will not return this
00142       *               node. For TreeWalker, the children of this node will
00143       *               also be rejected. Iterators treat this as a synonym
00144       *               for FILTER_SKIP.</td>
00145       *         </tr>
00146       *         <tr><td>FILTER_SKIP</td>
00147       *              <td>Reject the node. Navigation methods defined for
00148       *                  NodeIterator or TreeWalker will not return this
00149       *                  node. For both NodeIterator and Treewalker, the
00150       *                  children of this node will still be considered.</td>
00151       *         </tr>
00152       *     </table>
00153       *
00154       */
00155         enum FilterAction {FILTER_ACCEPT, FILTER_REJECT, FILTER_SKIP};
00156         enum ShowType {
00157             SHOW_ALL                       = 0x0000FFFF,
00158             SHOW_ELEMENT                   = 0x00000001,
00159             SHOW_ATTRIBUTE                 = 0x00000002,
00160             SHOW_TEXT                      = 0x00000004,
00161             SHOW_CDATA_SECTION             = 0x00000008,
00162             SHOW_ENTITY_REFERENCE          = 0x00000010,
00163             SHOW_ENTITY                    = 0x00000020,
00164             SHOW_PROCESSING_INSTRUCTION    = 0x00000040,
00165             SHOW_COMMENT                   = 0x00000080,
00166             SHOW_DOCUMENT                  = 0x00000100,
00167             SHOW_DOCUMENT_TYPE             = 0x00000200,
00168             SHOW_DOCUMENT_FRAGMENT         = 0x00000400,
00169             SHOW_NOTATION                  = 0x00000800
00170         };
00171     //@}
00172 
00174         //@{
00178         DOM_NodeFilter();
00179         //@}
00180 
00182         //@{
00186         virtual ~DOM_NodeFilter();
00187         //@}
00188 
00190         //@{
00202         virtual short acceptNode (const DOM_Node &node) const =0;
00203         //@}
00204 
00205     private:
00206         DOM_NodeFilter(const DOM_NodeFilter &other);
00207         DOM_NodeFilter & operator = (const DOM_NodeFilter &other);
00208         bool operator == (const DOM_NodeFilter &other) const;
00209         bool operator != (const DOM_NodeFilter &other) const;
00210 };
00211 
00212 #endif


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