Xerces-C++: DOMNodeIterator.hpp Source File

Xerces-C++ 3.3.0

DOMNodeIterator.hpp
Go to the documentation of this file.
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18/*
19 * $Id$
20 */
21
22#if !defined(XERCESC_INCLUDE_GUARD_DOMNODEITERATOR_HPP)
23#define XERCESC_INCLUDE_GUARD_DOMNODEITERATOR_HPP
24
25#include <xercesc/dom/DOMNodeFilter.hpp>
26#include <xercesc/dom/DOMNode.hpp>
27
28 XERCES_CPP_NAMESPACE_BEGIN
29
30
44 class CDOM_EXPORT DOMNodeIterator
45{
46protected:
47 // -----------------------------------------------------------------------
48 // Hidden constructors
49 // -----------------------------------------------------------------------
52 DOMNodeIterator() {}
53 DOMNodeIterator(const DOMNodeIterator &) {}
55
56private:
57 // -----------------------------------------------------------------------
58 // Unimplemented constructors and operators
59 // -----------------------------------------------------------------------
62 DOMNodeIterator & operator = (const DOMNodeIterator &);
64
65public:
66 // -----------------------------------------------------------------------
67 // All constructors are hidden, just the destructor is available
68 // -----------------------------------------------------------------------
75 virtual ~DOMNodeIterator() {};
77
78 // -----------------------------------------------------------------------
79 // Virtual DOMNodeFilter interface
80 // -----------------------------------------------------------------------
83 // -----------------------------------------------------------------------
84 // Getter methods
85 // -----------------------------------------------------------------------
91 virtual DOMNode* getRoot() = 0;
103 virtual DOMNodeFilter::ShowType getWhatToShow() = 0;
104
110 virtual DOMNodeFilter* getFilter() = 0;
111
133 virtual bool getExpandEntityReferences() = 0;
134
135 // -----------------------------------------------------------------------
136 // Query methods
137 // -----------------------------------------------------------------------
150 virtual DOMNode* nextNode() = 0;
151
162 virtual DOMNode* previousNode() = 0;
163
173 virtual void detach() = 0;
175
176 // -----------------------------------------------------------------------
177 // Non-standard Extension
178 // -----------------------------------------------------------------------
188 virtual void release() = 0;
190};
191
192#define GetDOMNodeIteratorMemoryManager GET_DIRECT_MM(fDocument)
193
194 XERCES_CPP_NAMESPACE_END
195
196#endif
DOMNodeFilter.hpp
DOMNode.hpp
CDOM_EXPORT
#define CDOM_EXPORT
Definition XercesDefs.hpp:166
XERCES_CPP_NAMESPACE_BEGIN
#define XERCES_CPP_NAMESPACE_BEGIN
Definition XercesDefs.hpp:112
XERCES_CPP_NAMESPACE_END
#define XERCES_CPP_NAMESPACE_END
Definition XercesDefs.hpp:113
DOMNodeFilter
Filters are objects that know how to "filter out" nodes.
Definition DOMNodeFilter.hpp:50
DOMNodeFilter::ShowType
unsigned long ShowType
Definition DOMNodeFilter.hpp:193
DOMNodeIterator
DOMNodeIterators are used to step through a set of nodes, e.g.
Definition DOMNodeIterator.hpp:45
DOMNodeIterator::getRoot
virtual DOMNode * getRoot()=0
The root node of the DOMNodeIterator, as specified when it was created.
DOMNodeIterator::previousNode
virtual DOMNode * previousNode()=0
Returns the previous node in the set and moves the position of the DOMNodeIterator backwards in the s...
DOMNodeIterator::release
virtual void release()=0
Called to indicate that this NodeIterator is no longer in use and that the implementation may relinqu...
DOMNodeIterator::DOMNodeIterator
DOMNodeIterator()
Definition DOMNodeIterator.hpp:52
DOMNodeIterator::detach
virtual void detach()=0
Detaches the DOMNodeIterator from the set which it iterated over, releasing any computational resourc...
DOMNodeIterator::nextNode
virtual DOMNode * nextNode()=0
Returns the next node in the set and advances the position of the DOMNodeIterator in the set.
DOMNodeIterator::getExpandEntityReferences
virtual bool getExpandEntityReferences()=0
Return the expandEntityReferences flag.
DOMNodeIterator::getFilter
virtual DOMNodeFilter * getFilter()=0
The DOMNodeFilter used to screen nodes.
DOMNodeIterator::DOMNodeIterator
DOMNodeIterator(const DOMNodeIterator &)
Definition DOMNodeIterator.hpp:53
DOMNodeIterator::getWhatToShow
virtual DOMNodeFilter::ShowType getWhatToShow()=0
Return which node types are presented via the iterator.
DOMNodeIterator::~DOMNodeIterator
virtual ~DOMNodeIterator()
Destructor.
Definition DOMNodeIterator.hpp:75
DOMNode
The DOMNode interface is the primary datatype for the entire Document Object Model.
Definition DOMNode.hpp:139