class DOM_NodeIterator

NodeIterators are used to step through a set of nodes e

Inheritance:


Public

Constructors and assignment operator
DOM_NodeIterator ()
Default constructor
DOM_NodeIterator (const DOM_NodeIterator &other)
Copy constructor
DOM_NodeIterator& operator = (const DOM_NodeIterator &other)
Assignment operator
DOM_NodeIterator& operator = (const DOM_NullPtr *val)
Assignment operator
Destructor.
~DOM_NodeIterator ()
Destructor for DOM_NodeIterator
Detaching functions.
void detach ()
Detaches the iterator from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state
Equality and Inequality operators.
bool operator == (const DOM_NodeIterator & other) const
The equality operator
bool operator == (const DOM_NullPtr *other) const
Compare with a pointer
bool operator != (const DOM_NodeIterator & other) const
The inequality operator
bool operator != (const DOM_NullPtr * other) const
Compare with a pointer
Get functions.
unsigned long getWhatToShow ()
Return which node types are presented via the iterator
DOM_NodeFilter* getFilter ()
Return The filter used to screen nodes
bool getExpandEntityReferences ()
Return the expandEntityReferences flag
DOM_Node nextNode ()
Returns the next node in the set and advances the position of the iterator in the set
DOM_Node previousNode ()
Returns the previous node in the set and moves the position of the iterator backwards in the set

Documentation

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().

"Experimental - subject to change"

Constructors and assignment operator

DOM_NodeIterator()
Default constructor

DOM_NodeIterator(const DOM_NodeIterator &other)
Copy constructor.
Parameters:
other - The object to be copied.

DOM_NodeIterator& operator = (const DOM_NodeIterator &other)
Assignment operator.
Parameters:
other - The object to be copied.

DOM_NodeIterator& operator = (const DOM_NullPtr *val)
Assignment operator. This overloaded variant is provided for the sole purpose of setting a DOM_NodeIterator to null.
Parameters:
val. - Only a value of 0, or null, is allowed.

Destructor.

~DOM_NodeIterator()
Destructor for DOM_NodeIterator

Equality and Inequality operators.

bool operator == (const DOM_NodeIterator & other) const
The equality operator.
Returns:
s True if both DOM_NodeIterators refer to the same actual node, or are both null; return false otherwise.
Parameters:
other - The object reference with which this object is compared

bool operator == (const DOM_NullPtr *other) const
Compare with a pointer. Intended only to allow a convenient comparison with null.

bool operator != (const DOM_NodeIterator & other) const
The inequality operator. See operator ==.

bool operator != (const DOM_NullPtr * other) const
Compare with a pointer. Intended only to allow a convenient comparison with null.

Get functions.

unsigned long getWhatToShow()
Return which node types are presented via the iterator. The available set of constants is defined in the DOM_NodeFilter interface.

"Experimental - subject to change"

DOM_NodeFilter* getFilter()
Return The filter used to screen nodes.

"Experimental - subject to change"

bool getExpandEntityReferences()
Return the expandEntityReferences flag. The value of this flag determines whether the children of entity reference nodes are visible to the DOM_NodeFilter. If false, they will be skipped over.

"Experimental - subject to change"

DOM_Node nextNode()
Returns the next node in the set and advances the position of the iterator in the set. After a DOM_NodeIterator is created, the first call to nextNode() returns the first node in the set.

"Experimental - subject to change"

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

DOM_Node previousNode()
Returns the previous node in the set and moves the position of the iterator backwards in the set.

"Experimental - subject to change"

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

Detaching functions.

void detach()
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.

"Experimental - subject to change"


This class has no child classes.

alphabetic index hierarchy of classes


Xerces-C XML Parser for C++ Version 1.1
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.

generated by doc++