class NodeFilter

Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   Namespace Members   Compound Members   Related Pages  

org::w3c::dom::traversal::NodeFilter Class Reference

#include <NodeFilter.h>

List of all members.

Detailed Description

Filters are objects that know how to filter out nodes.

If a NodeIterator or TreeWalker is given a NodeFilter, it applies the filter before it returns the next node. If the filter says to accept the node, the traversal logic returns it; otherwise, traversal looks for the next node and pretends that the node that was rejected was not there.

The DOM does not provide any filters. NodeFilter is just an interface that users can implement to provide their own filters.

NodeFilters do not need to know how to traverse from node to node, nor do they need to know anything about the data structure that is being traversed. This makes it very easy to write filters, since the only thing they have to know how to do is evaluate a single node. One filter may be used with a number of different kinds of traversals, encouraging code reuse.

See also the Document acdk::lang::Object Model (DOM) Level 2 Traversal and Range Specification.

DOM Level 2

Public Member Functions

virtual short acceptNode (IN(RNode) n)=0
 Test whether a specified node is visible in the logical view of a TreeWalker or NodeIterator.

Member Function Documentation

virtual short org::w3c::dom::traversal::NodeFilter::acceptNode IN(RNode n  )  [pure virtual]

Test whether a specified node is visible in the logical view of a TreeWalker or NodeIterator.

This function will be called by the implementation of TreeWalker and NodeIterator; it is not normally called directly from user code. (Though you could do so if you wanted to use the same filter to guide your own application logic.)

n The node to check to see if it passes the filter or not.
A constant to determine whether the node is accepted, rejected, or skipped, as defined above.