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

Home

Readme
Download
Installation
Build

API Docs
Samples
Schema

FAQs
Programming
Migration

Releases
Bug-Reporting
Feedback

Y2K Compliance
PDF Document

CVS Repository
Mail Archive

API Docs for SAX and DOM
 

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

IDOM_NodeIterator Class Reference

NodeIterators are used to step through a set of nodes e.g. More...

#include <IDOM_NodeIterator.hpp>

List of all members.

Public Methods

Get functions.
virtual IDOM_NodegetRoot ()=0
 The root node of the NodeIterator, as specified when it was created.

virtual unsigned long getWhatToShow ()=0
 Return which node types are presented via the iterator. More...

virtual IDOM_NodeFiltergetFilter ()=0
 Return The filter used to screen nodes.

virtual bool getExpandEntityReferences ()=0
 Return the expandEntityReferences flag. More...

virtual IDOM_NodenextNode ()=0
 Returns the next node in the set and advances the position of the iterator in the set. More...

virtual IDOM_NodepreviousNode ()=0
 Returns the previous node in the set and moves the position of the iterator backwards in the set. More...

Detaching functions.
virtual void detach ()=0
 Detaches the iterator from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state. More...


Protected Methods

 IDOM_NodeIterator ()
 IDOM_NodeIterator (const IDOM_NodeIterator &other)
IDOM_NodeIterator& operator= (const IDOM_NodeIterator &other)


Detailed Description

NodeIterators are used to step through a set of nodes e.g.

the set of nodes in a NodeList, the document subtree governed by a particular node, the results of a query, or any other set of nodes. The set of nodes to be iterated is determined by the implementation of the NodeIterator. DOM Level 2 specifies a single NodeIterator implementation for document-order traversal of a document subtree. Instances of these iterators are created by calling DocumentTraversal.createNodeIterator().


Constructor & Destructor Documentation

IDOM_NodeIterator::IDOM_NodeIterator ( ) [protected]
 

IDOM_NodeIterator::IDOM_NodeIterator ( const IDOM_NodeIterator & other ) [protected]
 


Member Function Documentation

void IDOM_NodeIterator::detach ( ) [pure virtual]
 

Detaches the iterator from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state.

After detach has been invoked, calls to nextNode or previousNode will raise the exception INVALID_STATE_ERR.

bool IDOM_NodeIterator::getExpandEntityReferences ( ) [pure virtual]
 

Return the expandEntityReferences flag.

The value of this flag determines whether the children of entity reference nodes are visible to the IDOM_NodeFilter. If false, they will be skipped over.

IDOM_NodeFilter * IDOM_NodeIterator::getFilter ( ) [pure virtual]
 

Return The filter used to screen nodes.

IDOM_Node * IDOM_NodeIterator::getRoot ( ) [pure virtual]
 

The root node of the NodeIterator, as specified when it was created.

unsigned long IDOM_NodeIterator::getWhatToShow ( ) [pure virtual]
 

Return which node types are presented via the iterator.

The available set of constants is defined in the IDOM_NodeFilter interface.

IDOM_Node * IDOM_NodeIterator::nextNode ( ) [pure virtual]
 

Returns the next node in the set and advances the position of the iterator in the set.

After a IDOM_NodeIterator is created, the first call to nextNode() returns the first node in the set.

Exceptions:
DOMException   INVALID_STATE_ERR: Raised if this method is called after the detach method was invoked.

IDOM_NodeIterator & IDOM_NodeIterator::operator= ( const IDOM_NodeIterator & other ) [protected]
 

IDOM_Node * IDOM_NodeIterator::previousNode ( ) [pure virtual]
 

Returns the previous node in the set and moves the position of the iterator backwards in the set.

Exceptions:
DOMException   INVALID_STATE_ERR: Raised if this method is called after the detach method was invoked.


The documentation for this class was generated from the following file:


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