DOM_NodeFilter.hpp Source 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.10  2000/10/20 22:03:04  andyh

00060  * DOM NodeFileter - define values for FilterAction enum to match those in the DOM spec.

00061  *
00062  * Revision 1.9  2000/05/11 00:07:38  abagchi

00063  * Removed tables. It was confusing doxygen

00064  *
00065  * Revision 1.8  2000/03/11 03:19:13  chchou

00066  * Fix bug # 19, add const keyword to API

00067  *
00068  * Revision 1.7  2000/02/24 20:11:28  abagchi

00069  * Swat for removing Log from API docs

00070  *
00071  * Revision 1.6  2000/02/17 17:47:25  andyh

00072  * Update Doc++ API comments

00073  * NameSpace update to track W3C

00074  * Changes were made by Chih Hsiang Chou

00075  *
00076  * Revision 1.5  2000/02/15 23:17:37  andyh

00077  * Update Doc++ API comments

00078  * NameSpace bugfix and update to track W3C

00079  * Chih Hsiang Chou

00080  *
00081  * Revision 1.4  2000/02/10 21:47:12  abagchi

00082  * Added API docs

00083  *
00084  * Revision 1.3  2000/02/06 07:47:30  rahulj

00085  * Year 2K copyright swat.

00086  *
00087  * Revision 1.2  2000/02/04 01:49:28  aruna1

00088  * TreeWalker and NodeIterator changes

00089  *
00090  * Revision 1.1.1.1  1999/11/09 01:09:00  twl

00091  * Initial checkin

00092  *
00093  * Revision 1.2  1999/11/08 20:44:19  rahul

00094  * Swat for adding in Product name and CVS comment log variable.

00095  *
00096  */
00097 
00098 // DOM_NodeFilter.h: interface for the DOM_NodeFilter class.
00099 //
00101 
00102 #ifndef DOM_NodeFilter_HEADER_GUARD_
00103 #define DOM_NodeFilter_HEADER_GUARD_
00104 
00105 #include "DOM_Node.hpp"
00106 
00107 class NodeFilterImpl;
00108 
00109 
00131 class  DOM_NodeFilter
00132 {
00133     public:
00136     /*
00137       *     <table><tr><td>FILTER_ACCEPT</td>

00138       *            <td>Accept the node. Navigation methods defined for

00139       *                NodeIterator or TreeWalker will return this node.</td>

00140       *         </tr>

00141       *         <tr><td>

00142       *               FILTER_REJECT</td>

00143       *               <td>Reject the node. Navigation methods defined for

00144       *               NodeIterator or TreeWalker will not return this

00145       *               node. For TreeWalker, the children of this node will

00146       *               also be rejected. Iterators treat this as a synonym

00147       *               for FILTER_SKIP.</td>

00148       *         </tr>

00149       *         <tr><td>FILTER_SKIP</td>

00150       *              <td>Reject the node. Navigation methods defined for

00151       *                  NodeIterator or TreeWalker will not return this

00152       *                  node. For both NodeIterator and Treewalker, the

00153       *                  children of this node will still be considered.</td>

00154       *         </tr>

00155       *     </table>

00156       *
00157       */
00158         enum FilterAction {FILTER_ACCEPT = 1,
00159                            FILTER_REJECT = 2,
00160                            FILTER_SKIP   = 3};
00161 
00162         enum ShowType {
00163             SHOW_ALL                       = 0x0000FFFF,
00164             SHOW_ELEMENT                   = 0x00000001,
00165             SHOW_ATTRIBUTE                 = 0x00000002,
00166             SHOW_TEXT                      = 0x00000004,
00167             SHOW_CDATA_SECTION             = 0x00000008,
00168             SHOW_ENTITY_REFERENCE          = 0x00000010,
00169             SHOW_ENTITY                    = 0x00000020,
00170             SHOW_PROCESSING_INSTRUCTION    = 0x00000040,
00171             SHOW_COMMENT                   = 0x00000080,
00172             SHOW_DOCUMENT                  = 0x00000100,
00173             SHOW_DOCUMENT_TYPE             = 0x00000200,
00174             SHOW_DOCUMENT_FRAGMENT         = 0x00000400,
00175             SHOW_NOTATION                  = 0x00000800
00176         };
00178 
00181 
00184         DOM_NodeFilter();
00186 
00189 
00192         virtual ~DOM_NodeFilter();
00194 
00197 
00208         virtual short acceptNode (const DOM_Node &node) const =0;
00210 
00211     private:
00212         DOM_NodeFilter(const DOM_NodeFilter &other);
00213         DOM_NodeFilter & operator = (const DOM_NodeFilter &other);
00214         bool operator == (const DOM_NodeFilter &other) const;
00215         bool operator != (const DOM_NodeFilter &other) const;
00216 };
00217 
00218 #endif