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: IDTreeWalkerImpl.hpp,v $ 00059 * Revision 1.1 2002/05/11 20:17:12 bhavani 00060 * CR#CR062582# adding xercesc 1.7 file 00061 * 00062 * Revision 1.2 2002/02/04 21:20:59 tng 00063 * Add DOM 2 Level missing functions: 00064 * 1. NodeIterator::getRoot 00065 * 2. TreeWalker::getRoot 00066 * 3. Element::hasAttribute 00067 * 4. Element::hasAttributeNS 00068 * 5. Node::hasAttributes 00069 * 6. Node::isSupported 00070 * 00071 * Revision 1.1.1.1 2002/02/01 22:21:57 peiyongz 00072 * sane_include 00073 * 00074 * Revision 1.3 2001/06/04 20:11:53 tng 00075 * IDOM: Complete IDNodeIterator, IDTreeWalker, IDNodeFilter. 00076 * 00077 * Revision 1.2 2001/05/11 13:26:00 tng 00078 * Copyright update. 00079 * 00080 * Revision 1.1.1.1 2001/04/03 00:14:35 andyh 00081 * IDOM 00082 * 00083 */ 00084 00085 #ifndef IDTreeWalkerImpl_HEADER_GUARD_ 00086 #define IDTreeWalkerImpl_HEADER_GUARD_ 00087 00088 00089 #include "IDOM_TreeWalker.hpp" 00090 00091 00092 class CDOM_EXPORT IDTreeWalkerImpl : public IDOM_TreeWalker { 00093 private: 00094 // The whatToShow mask. 00095 unsigned long fWhatToShow; 00096 00097 // The NodeFilter reference. 00098 IDOM_NodeFilter* fNodeFilter; 00099 00100 // The current Node. 00101 IDOM_Node* fCurrentNode; 00102 00103 // The root Node. 00104 IDOM_Node* fRoot; 00105 00106 // The expandEntity reference flag. 00107 bool fExpandEntityReferences; 00108 00109 public: 00110 // Implementation Note: No state is kept except the data above 00111 // (fWhatToShow, fNodeFilter, fCurrentNode, fRoot) such that 00112 // setters could be created for these data values and the 00113 // implementation will still work. 00114 00116 IDTreeWalkerImpl ( 00117 IDOM_Node* root, 00118 unsigned long whatToShow, 00119 IDOM_NodeFilter* nodeFilter, 00120 bool expandEntityRef); 00121 IDTreeWalkerImpl (const IDTreeWalkerImpl& twi); 00122 IDTreeWalkerImpl& operator= (const IDTreeWalkerImpl& twi); 00123 00124 // Return the root node. 00125 virtual IDOM_Node* getRoot (); 00126 00127 // Return the whatToShow value. 00128 virtual unsigned long getWhatToShow (); 00129 00130 // Return the NodeFilter. 00131 virtual IDOM_NodeFilter* getFilter (); 00132 00133 00134 // Return the current IDOM_Node. 00135 virtual IDOM_Node* getCurrentNode (); 00136 00137 // Return the current Node. 00138 virtual void setCurrentNode (IDOM_Node* node); 00139 00140 // Return the parent Node from the current node, 00141 // after applying filter, whatToshow. 00142 // If result is not null, set the current Node. 00143 virtual IDOM_Node* parentNode (); 00144 00145 // Return the first child Node from the current node, 00146 // after applying filter, whatToshow. 00147 // If result is not null, set the current Node. 00148 virtual IDOM_Node* firstChild (); 00149 00150 // Return the last child Node from the current node, 00151 // after applying filter, whatToshow. 00152 // If result is not null, set the current Node. 00153 virtual IDOM_Node* lastChild (); 00154 00155 // Return the previous sibling Node from the current node, 00156 // after applying filter, whatToshow. 00157 // If result is not null, set the current Node. 00158 virtual IDOM_Node* previousSibling (); 00159 00160 // Return the next sibling Node from the current node, 00161 // after applying filter, whatToshow. 00162 // If result is not null, set the current Node. 00163 00164 virtual IDOM_Node* nextSibling (); 00165 // Return the previous Node from the current node, 00166 // after applying filter, whatToshow. 00167 // If result is not null, set the current Node. 00168 virtual IDOM_Node* previousNode (); 00169 00170 // Return the next Node from the current node, 00171 // after applying filter, whatToshow. 00172 // If result is not null, set the current Node. 00173 virtual IDOM_Node* nextNode (); 00174 00175 // Get the expandEntity reference flag. 00176 virtual bool getExpandEntityReferences(); 00177 00178 protected: 00179 00180 // Internal function. 00181 // Return the parent Node, from the input node 00182 // after applying filter, whatToshow. 00183 // The current node is not consulted or set. 00184 IDOM_Node* getParentNode (IDOM_Node* node); 00185 00186 // Internal function. 00187 // Return the nextSibling Node, from the input node 00188 // after applying filter, whatToshow. 00189 // The current node is not consulted or set. 00190 IDOM_Node* getNextSibling (IDOM_Node* node); 00191 00192 // Internal function. 00193 // Return the previous sibling Node, from the input node 00194 // after applying filter, whatToshow. 00195 // The current node is not consulted or set. 00196 IDOM_Node* getPreviousSibling (IDOM_Node* node); 00197 00198 // Internal function. 00199 // Return the first child Node, from the input node 00200 // after applying filter, whatToshow. 00201 // The current node is not consulted or set. 00202 IDOM_Node* getFirstChild (IDOM_Node* node); 00203 00204 // Internal function. 00205 // Return the last child Node, from the input node 00206 // after applying filter, whatToshow. 00207 // The current node is not consulted or set. 00208 IDOM_Node* getLastChild (IDOM_Node* node); 00209 00210 // The node is accepted if it passes the whatToShow and the filter. 00211 short acceptNode (IDOM_Node* node); 00212 00213 00214 }; 00215 00216 #endif