class DOM_NodeFilter

Filters are objects that know how to "filter out" nodes

Inheritance:


Public

Constructors
DOM_NodeFilter ()
Default constructor for DOM_NodeFilter
Destructor.
virtual ~DOM_NodeFilter ()
Destructor for DOM_NodeFilter
Enumerators for Node Filter
enum FilterAction
FILTER_ACCEPT Accept the node
Test function.
virtual short acceptNode (DOM_Node node)
Test whether a specified node is visible in the logical view of a DOM_TreeWalker or DOM_NodeIterator

Documentation

Filters are objects that know how to "filter out" nodes. If a DOM_NodeIterator or DOM_TreeWalker is given a filter, it applies the filter before it returns the next node. If the filter says to accept the node, the iterator returns it; otherwise, the iterator looks for the next node and pretends that the node that was rejected was not there. The DOM does not provide any filters. Filter is just an interface that users can implement to provide their own filters. Filters do not need to know how to iterate, nor do they need to know anything about the data structure that is being iterated. 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 iterators, encouraging code reuse.

"Experimental - subject to change"

Enumerators for Node Filter

enum FilterAction
FILTER_ACCEPT Accept the node. Navigation methods defined for NodeIterator or TreeWalker will return this node.
FILTER_REJECT Reject the node. Navigation methods defined for NodeIterator or TreeWalker will not return this node. For TreeWalker, the children of this node will also be rejected. Iterators treat this as a synonym for FILTER_SKIP.
FILTER_SKIP Reject the node. Navigation methods defined for NodeIterator or TreeWalker will not return this node. For both NodeIterator and Treewalker, the children of this node will still be considered.

Constructors

DOM_NodeFilter()
Default constructor for DOM_NodeFilter

Destructor.

virtual ~DOM_NodeFilter()
Destructor for DOM_NodeFilter

Test function.

virtual short acceptNode(DOM_Node node)
Test whether a specified node is visible in the logical view of a DOM_TreeWalker or DOM_NodeIterator. This function will be called by the implementation of DOM_TreeWalker and DOM_NodeIterator; it is not intended to be called directly from user code.

"Experimental - subject to change"

Returns:
A constant to determine whether the node is accepted, rejected, or skipped.
Parameters:
node - The node to check to see if it passes the filter or not.


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++