Xerces-C++: DOMNodeIterator.hpp Source File

00001 #ifndef DOMNodeIterator_HEADER_GUARD_
00002 #define DOMNodeIterator_HEADER_GUARD_
00003 
00004 /*
00005  * Copyright 2001-2002,2004 The Apache Software Foundation.
00006  * 
00007  * Licensed under the Apache License, Version 2.0 (the "License");
00008  * you may not use this file except in compliance with the License.
00009  * You may obtain a copy of the License at
00010  * 
00011  *      http://www.apache.org/licenses/LICENSE-2.0
00012  * 
00013  * Unless required by applicable law or agreed to in writing, software
00014  * distributed under the License is distributed on an "AS IS" BASIS,
00015  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00016  * See the License for the specific language governing permissions and
00017  * limitations under the License.
00018  */
00019 
00020 /*
00021  * $Id: DOMNodeIterator.hpp 176280 2005-01-07 15:32:34Z amassari $
00022  */
00023 
00024 #include <xercesc/dom/DOMNodeFilter.hpp>
00025 #include <xercesc/dom/DOMNode.hpp>
00026 
00027 XERCES_CPP_NAMESPACE_BEGIN
00028 
00029 
00043 class  DOMNodeIterator
00044 {
00045 protected:
00046     // -----------------------------------------------------------------------
00047     //  Hidden constructors
00048     // -----------------------------------------------------------------------
00051     DOMNodeIterator() {}
00052     DOMNodeIterator(const DOMNodeIterator &) {}
00054 
00055 private:    
00056     // -----------------------------------------------------------------------
00057     // Unimplemented constructors and operators
00058     // -----------------------------------------------------------------------
00061     DOMNodeIterator & operator = (const DOMNodeIterator &);
00063 
00064 public:
00065     // -----------------------------------------------------------------------
00066     //  All constructors are hidden, just the destructor is available
00067     // -----------------------------------------------------------------------
00074     virtual ~DOMNodeIterator() {};
00076 
00077     // -----------------------------------------------------------------------
00078     //  Virtual DOMNodeFilter interface
00079     // -----------------------------------------------------------------------
00082     // -----------------------------------------------------------------------
00083     //  Getter methods
00084     // -----------------------------------------------------------------------
00090     virtual DOMNode*           getRoot() = 0;
00102     virtual unsigned long      getWhatToShow() = 0;
00103 
00109     virtual DOMNodeFilter*     getFilter() = 0;
00110 
00132     virtual bool               getExpandEntityReferences() = 0;
00133 
00134     // -----------------------------------------------------------------------
00135     //  Query methods
00136     // -----------------------------------------------------------------------
00149     virtual DOMNode*           nextNode() = 0;
00150 
00161     virtual DOMNode*           previousNode() = 0;
00162 
00172     virtual void               detach() = 0;
00174 
00175     // -----------------------------------------------------------------------
00176     //  Non-standard Extension
00177     // -----------------------------------------------------------------------
00187     virtual void               release() = 0;
00189 };
00190 
00191 #define GetDOMNodeIteratorMemoryManager GET_DIRECT_MM(fDocument)
00192 
00193 XERCES_CPP_NAMESPACE_END
00194 
00195 #endif