DOMNodeIterator.hpp
Go to the documentation of this file.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* $Id$
*/
#if !defined(XERCESC_INCLUDE_GUARD_DOMNODEITERATOR_HPP)
#define XERCESC_INCLUDE_GUARD_DOMNODEITERATOR_HPP
#include <xercesc/dom/DOMNodeFilter.hpp>
#include <xercesc/dom/DOMNode.hpp>
XERCES_CPP_NAMESPACE_BEGIN
class CDOM_EXPORT DOMNodeIterator
{
protected:
// -----------------------------------------------------------------------
// Hidden constructors
// -----------------------------------------------------------------------
DOMNodeIterator() {}
DOMNodeIterator(const DOMNodeIterator &) {}
private:
// -----------------------------------------------------------------------
// Unimplemented constructors and operators
// -----------------------------------------------------------------------
DOMNodeIterator & operator = (const DOMNodeIterator &);
public:
// -----------------------------------------------------------------------
// All constructors are hidden, just the destructor is available
// -----------------------------------------------------------------------
virtual ~DOMNodeIterator() {};
// -----------------------------------------------------------------------
// Virtual DOMNodeFilter interface
// -----------------------------------------------------------------------
// -----------------------------------------------------------------------
// Getter methods
// -----------------------------------------------------------------------
virtual DOMNode* getRoot() = 0;
virtual DOMNodeFilter::ShowType getWhatToShow() = 0;
virtual DOMNodeFilter* getFilter() = 0;
virtual bool getExpandEntityReferences() = 0;
// -----------------------------------------------------------------------
// Query methods
// -----------------------------------------------------------------------
virtual DOMNode* nextNode() = 0;
virtual DOMNode* previousNode() = 0;
virtual void detach() = 0;
// -----------------------------------------------------------------------
// Non-standard Extension
// -----------------------------------------------------------------------
virtual void release() = 0;
};
#define GetDOMNodeIteratorMemoryManager GET_DIRECT_MM(fDocument)
XERCES_CPP_NAMESPACE_END
#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