Main Page   Class Hierarchy   Compound List   File List   Compound Members  

IDOM_NodeFilter.hpp

00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 2001-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) 2001, 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: IDOM_NodeFilter.hpp,v $
00059  * Revision 1.1  2002/05/11 20:14:03  bhavani
00060  * CR#CR062582# adding xercesc 1.7 file
00061  *
00062  * Revision 1.2  2002/02/04 21:11:55  tng
00063  * Remove the phrase "Experimental".
00064  *
00065  * Revision 1.1.1.1  2002/02/01 22:21:56  peiyongz
00066  * sane_include
00067  *
00068  * Revision 1.3  2001/06/04 20:11:53  tng
00069  * IDOM: Complete IDNodeIterator, IDTreeWalker, IDNodeFilter.
00070  *
00071  * Revision 1.2  2001/05/11 13:25:53  tng
00072  * Copyright update.
00073  *
00074  * Revision 1.1.1.1  2001/04/03 00:14:31  andyh
00075  * IDOM
00076  *
00077  */
00078 
00079 // IDOM_NodeFilter.h: interface for the IDOM_NodeFilter class.
00080 //
00082 
00083 #ifndef IDOM_NodeFilter_HEADER_GUARD_
00084 #define IDOM_NodeFilter_HEADER_GUARD_
00085 
00086 #include "IDOM_Node.hpp"
00087 
00088 class IDNodeFilterImpl;
00089 
00090 
00110 class CDOM_EXPORT IDOM_NodeFilter
00111 {
00112     protected:
00113         IDOM_NodeFilter() {};
00114         IDOM_NodeFilter(const IDOM_NodeFilter &other) {};
00115         IDOM_NodeFilter & operator = (const IDOM_NodeFilter &other) {return *this;};
00116 
00117     public:
00120         /*
00121          *    <table><tr><td>FILTER_ACCEPT</td>
00122          *               <td>Accept the node. Navigation methods defined for
00123          *               NodeIterator or TreeWalker will return this node.</td>
00124          *           </tr>
00125          *           <tr>
00126          *               <td>FILTER_REJECT</td>
00127          *               <td>Reject the node. Navigation methods defined for
00128          *               NodeIterator or TreeWalker will not return this
00129          *               node. For TreeWalker, the children of this node will
00130          *               also be rejected. Iterators treat this as a synonym
00131          *               for FILTER_SKIP.</td>
00132          *           </tr>
00133          *           <tr><td>FILTER_SKIP</td>
00134          *               <td>Reject the node. Navigation methods defined for
00135          *               NodeIterator or TreeWalker will not return this
00136          *               node. For both NodeIterator and Treewalker, the
00137          *               children of this node will still be considered.</td>
00138          *           </tr>
00139          *    </table>
00140          *
00141          */
00142         enum FilterAction {FILTER_ACCEPT = 1,
00143                            FILTER_REJECT = 2,
00144                            FILTER_SKIP   = 3};
00145 
00146         enum ShowType {
00147             SHOW_ALL                       = 0x0000FFFF,
00148             SHOW_ELEMENT                   = 0x00000001,
00149             SHOW_ATTRIBUTE                 = 0x00000002,
00150             SHOW_TEXT                      = 0x00000004,
00151             SHOW_CDATA_SECTION             = 0x00000008,
00152             SHOW_ENTITY_REFERENCE          = 0x00000010,
00153             SHOW_ENTITY                    = 0x00000020,
00154             SHOW_PROCESSING_INSTRUCTION    = 0x00000040,
00155             SHOW_COMMENT                   = 0x00000080,
00156             SHOW_DOCUMENT                  = 0x00000100,
00157             SHOW_DOCUMENT_TYPE             = 0x00000200,
00158             SHOW_DOCUMENT_FRAGMENT         = 0x00000400,
00159             SHOW_NOTATION                  = 0x00000800
00160         };
00162 
00174         virtual short acceptNode (const IDOM_Node* node) const =0;
00176 
00177 };
00178 
00179 #endif

Generated on Tue Nov 19 09:36:30 2002 by doxygen1.3-rc1