Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Public Member Functions | Protected Member Functions

XercesDOMWalker Class Reference

#include <XercesDOMWalker.hpp>

Inherited by XercesDocumentWrapper::BuildWrapperTreeWalker, and XercesDOMFormatterWalker.

List of all members.

Public Member Functions

Protected Member Functions


Detailed Description

Definition at line 32 of file XercesDOMWalker.hpp.


Constructor & Destructor Documentation

XercesDOMWalker::XercesDOMWalker (  ) 

Constructor.

virtual XercesDOMWalker::~XercesDOMWalker (  )  [virtual]

Member Function Documentation

virtual bool XercesDOMWalker::endNode ( const DOMNodeType node  )  [protected, pure virtual]

Called when leaving a node.

Parameters:
node The node
Returns:
return false if traversal should continue, or true if it should not.

Implemented in XercesDocumentWrapper::BuildWrapperTreeWalker, and XercesDOMFormatterWalker.

virtual bool XercesDOMWalker::endNode ( DOMNodeType node  )  [protected, virtual]

Called when leaving a node.

Parameters:
node The node
Returns:
return false if traversal should continue, or true if it should not.
virtual bool XercesDOMWalker::startNode ( DOMNodeType node  )  [protected, virtual]

Called when first walking a node.

Parameters:
node The node
Returns:
return false if traversal should continue, or true if it should not.
virtual bool XercesDOMWalker::startNode ( const DOMNodeType node  )  [protected, pure virtual]

Called when first walking a node.

Parameters:
node The node
Returns:
return false if traversal should continue, or true if it should not.

Implemented in XercesDocumentWrapper::BuildWrapperTreeWalker, and XercesDOMFormatterWalker.

const DOMNodeType* XercesDOMWalker::traverse ( const DOMNodeType pos,
const DOMNodeType parent 
)

Perform a document-order traversal stopping at the provided parent node.

Derived classes and stop the traversal by returning true from startNode() or endNode(). If that happens, the function will return the next node in document order. If desired, the caller can start traversing the tree again from that point. Note that terminal nodes will always have startNode() and endNode() called before the traversal terminates.

Parameters:
pos The node in the tree with which to start the walk
parent The parent of pos. Note that for multiple calls that continue the traversal, this node must remain the same.
Returns:
parent if the traversal completes, or the next node if the traversal doesn't complete.
DOMNodeType* XercesDOMWalker::traverse ( DOMNodeType pos,
DOMNodeType parent 
)

Perform a document-order traversal stopping at the provided parent node.

Derived classes and stop the traversal by returning true from startNode() or endNode(). If that happens, the function will return the next node in document order. If desired, the caller can start traversing the tree again from that point. Note that terminal nodes will always have startNode() and endNode() called before the traversal terminates.

Parameters:
pos The node in the tree with which to start the walk
parent The parent of pos. Note that for multiple calls that continue the traversal, this node must remain the same.
Returns:
parent if the traversal completes, or the next node if the traversal doesn't complete.
DOMNodeType* XercesDOMWalker::traverse ( DOMNodeType pos  ) 

Perform a document-order traversal.

Derived classes and stop the traversal by returning true from startNode() or endNode(). If that happens, the function will return the next node in document order. If desired, the caller can start traversing the tree again from that point. Note that terminal nodes will always have startNode() and endNode() called before the traversal terminates.

Parameters:
pos The node in the tree with which to start the walk
Returns:
0 if the traversal completes, or the next node if the traversal doesn't complete.
const DOMNodeType* XercesDOMWalker::traverse ( const DOMNodeType pos  ) 

Perform a document-order traversal.

Derived classes and stop the traversal by returning true from startNode() or endNode(). If that happens, the function will return the next node in document order. If desired, the caller can start traversing the tree again from that point. Note that terminal nodes will always have startNode() and endNode() called before the traversal terminates.

Parameters:
pos The node in the tree with which to start the walk
Returns:
0 if the traversal completes, or the next node if the traversal doesn't complete.
void XercesDOMWalker::traverseSubtree ( const DOMNodeType pos  ) 

Perform a pre-order traversal.

Parameters:
pos starting node
void XercesDOMWalker::traverseSubtree ( DOMNodeType pos  ) 

Perform a document-order traversal.

Parameters:
pos starting node

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

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo