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

Home

Readme
Installation
Build

API Docs
Samples
Programming
Migration
FAQs

Releases
Feedback

PDF Document

Download
Dev Snapshots
CVS Repository
Mail Archive

API Docs for SAX and DOM
 

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

NodeIteratorImpl.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: NodeIteratorImpl.hpp,v $
00059  * Revision 1.5  2000/02/24 20:11:30  abagchi
00060  * Swat for removing Log from API docs
00061  *
00062  * Revision 1.4  2000/02/15 23:17:37  andyh
00063  * Update Doc++ API comments
00064  * NameSpace bugfix and update to track W3C
00065  * Chih Hsiang Chou
00066  *
00067  * Revision 1.3  2000/02/06 07:47:33  rahulj
00068  * Year 2K copyright swat.
00069  *
00070  * Revision 1.2  2000/02/04 01:49:26  aruna1
00071  * TreeWalker and NodeIterator changes
00072  *
00073  * Revision 1.1.1.1  1999/11/09 01:09:16  twl
00074  * Initial checkin
00075  *
00076  * Revision 1.2  1999/11/08 20:44:30  rahul
00077  * Swat for adding in Product name and CVS comment log variable.
00078  *
00079  */
00080 
00081 #ifndef NodeIteratorImpl_HEADER_GUARD_
00082 #define NodeIteratorImpl_HEADER_GUARD_
00083 
00084 
00085 // NodeIteratorImpl.hpp: interface for the NodeIteratorImpl class.
00086 //
00088 
00089 #include "DOM_Node.hpp"
00090 #include "DOM_NodeIterator.hpp"
00091 #include "RefCountedImpl.hpp"
00092 
00093 
00094 class  NodeIteratorImpl : public RefCountedImpl {
00095     protected:
00096         NodeIteratorImpl ();
00097 
00098     public:
00099         virtual ~NodeIteratorImpl ();
00100         NodeIteratorImpl (
00101             DOM_Node root, 
00102             unsigned long whatToShow, 
00103             DOM_NodeFilter* nodeFilter,
00104             bool expandEntityRef);
00105 
00106         NodeIteratorImpl ( const NodeIteratorImpl& toCopy);
00107         
00108         NodeIteratorImpl& operator= (const NodeIteratorImpl& other);
00109         
00110         unsigned long getWhatToShow ();
00111         DOM_NodeFilter* getFilter ();
00112 
00113         DOM_Node nextNode ();
00114         DOM_Node previousNode ();
00115         bool acceptNode (DOM_Node node);
00116         DOM_Node matchNodeOrParent (DOM_Node node);
00117         DOM_Node nextNode (DOM_Node node, bool visitChildren);
00118         DOM_Node previousNode (DOM_Node node);
00119         void removeNode (DOM_Node node);
00120 
00121         void unreferenced();
00122 
00123         void detach ();
00124 
00125         // Get the expandEntity reference flag.
00126         bool getExpandEntityReferences();
00127 
00128 
00129     private:
00130         //
00131         // Data
00132         //
00133         // The root.
00134         DOM_Node fRoot;
00135 
00136         // The whatToShow mask.
00137         unsigned long fWhatToShow;
00138 
00139         // The NodeFilter reference.
00140         DOM_NodeFilter* fNodeFilter;
00141 
00142         // The expandEntity reference flag.
00143         bool  fExpandEntityReferences;
00144 
00145         bool fDetached;
00146 
00147         //
00148         // Iterator state - current node and direction.
00149         //
00150         // Note: The current node and direction are sufficient to implement
00151         // the desired behaviour of the current pointer being _between_
00152         // two nodes. The fCurrentNode is actually the last node returned,
00153         // and the
00154         // direction is whether the pointer is in front or behind this node.
00155         // (usually akin to whether the node was returned via nextNode())
00156         // (eg fForward = true) or previousNode() (eg fForward = false).
00157 
00158         // The last Node returned.
00159         DOM_Node fCurrentNode;
00160 
00161         // The direction of the iterator on the fCurrentNode.
00162         //  <pre>
00163         //  nextNode()  ==      fForward = true;
00164         //  previousNode() ==   fForward = false;
00165         //  </pre>
00166         bool fForward;
00167 
00168 
00169 };
00170 
00171 #endif


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