org.htmlparser.util
Class NodeTreeWalker
- NodeIterator
public class NodeTreeWalker
A class for walking a tree of
Node
objects, in either a depth-first or breadth-first manner.
The following two diagrams show the represent tree traversal with the two different methods.
Depth-first traversal | Breadth-first traversal |
---|

|

|
protected Node | mCurrentNode - The current Node element, which will be a child of the root Node, or null.
|
protected boolean | mDepthFirst - Whether the tree traversal method used is depth-first (default) or breadth-first.
|
protected int | mMaxDepth - The maximum depth (child-parent links) from which this NodeTreeWalker may be removed from the root Node.
|
protected Node | mNextNode - The next Node element after the current Node element.
|
protected Node | mRootNode - The root Node element which defines the scope of the current tree to walk.
|
NodeTreeWalker(Node rootNode) - Creates a new instance of NodeTreeWalker using depth-first tree traversal, without limits on how deep it may traverse.
|
NodeTreeWalker(Node rootNode, boolean depthFirst) - Creates a new instance of NodeTreeWalker using the specified type of tree traversal, without limits on how deep it may traverse.
|
NodeTreeWalker(Node rootNode, boolean depthFirst, int maxDepth) - Creates a new instance of NodeTreeWalker using the specified type of tree traversal and maximum depth from the root Node to traverse.
|
Node | getCurrentNode() - Get the Node in the tree that the NodeTreeWalker is current at.
|
int | getCurrentNodeDepth() - Get the number of places down that the current Node is from the root Node.
|
int | getMaxDepth() - The maximum depth (number of child-parent links) below the root Node that this NodeTreeWalker may traverse.
|
protected Node | getNextNodeBreadthFirst() - Traverses to the next Node from the current Node using breadth-first tree traversal
|
protected Node | getNextNodeDepthFirst() - Traverses to the next Node from the current Node using depth-first tree traversal
|
Node | getRootNode() - Get the root Node that defines the scope of the tree to traverse.
|
boolean | hasMoreNodes() - Returns whether or not there are more nodes available based on the current configuration of this NodeTreeWalker.
|
protected void | initRootNode(Node rootNode) - Sets the root Node to be the given Node.
|
boolean | isDepthFirst() - Whether the NodeTreeWalker is currently set to use depth-first or breadth-first tree traversal.
|
Node | nextNode() - Traverses to the next Node from the current Node, using either depth-first or breadth-first tree traversal as appropriate.
|
void | removeMaxDepthRestriction() - Removes any restrictions in place that prevent this NodeTreeWalker from traversing beyond a certain depth.
|
void | reset() - Resets the current position in the tree,
such that calling
nextNode() will return the first Node again.
|
void | setCurrentNodeAsRootNode() - Sets the current Node as the root Node.
|
void | setDepthFirst(boolean depthFirst) - Sets whether the NodeTreeWalker should use depth-first or breadth-first tree traversal.
|
void | setRootNode(Node rootNode) - Sets the specified Node as the root Node.
|
mCurrentNode
protected Node mCurrentNode
The current Node element, which will be a child of the root Node, or null.
mDepthFirst
protected boolean mDepthFirst
Whether the tree traversal method used is depth-first (default) or breadth-first.
mMaxDepth
protected int mMaxDepth
The maximum depth (child-parent links) from which this NodeTreeWalker may be removed from the root Node.
A value of -1 indicates that there is no depth restriction.
mNextNode
protected Node mNextNode
The next Node element after the current Node element.
Stored for internal use only.
mRootNode
protected Node mRootNode
The root Node element which defines the scope of the current tree to walk.
NodeTreeWalker
public NodeTreeWalker(Node rootNode)
Creates a new instance of NodeTreeWalker using depth-first tree traversal, without limits on how deep it may traverse.
rootNode
- Node The Node to set as the root of the tree.
NodeTreeWalker
public NodeTreeWalker(Node rootNode,
boolean depthFirst)
Creates a new instance of NodeTreeWalker using the specified type of tree traversal, without limits on how deep it may traverse.
rootNode
- The Node to set as the root of the tree.depthFirst
- Whether to use depth-first (true) or breadth-first (false) tree traversal.
NodeTreeWalker
public NodeTreeWalker(Node rootNode,
boolean depthFirst,
int maxDepth)
Creates a new instance of NodeTreeWalker using the specified type of tree traversal and maximum depth from the root Node to traverse.
rootNode
- The Node to set as the root of the tree.depthFirst
- Whether to use depth-first (true) or breadth-first (false) tree traversal.maxDepth
- The maximum depth from the root Node that this NodeTreeWalker may traverse. This must be > 0 or equal to -1.
getCurrentNode
public Node getCurrentNode()
Get the Node in the tree that the NodeTreeWalker is current at.
getCurrentNodeDepth
public int getCurrentNodeDepth()
Get the number of places down that the current Node is from the root Node.
Returns 1 if current Node is a child of the root Node.
Returns 0 if this NodeTreeWalker has not yet traversed to any Nodes.
- The depth the current Node is from the root Node.
getMaxDepth
public int getMaxDepth()
The maximum depth (number of child-parent links) below the root Node that this NodeTreeWalker may traverse.
- The maximum depth that this NodeTreeWalker can traverse to.
getNextNodeBreadthFirst
protected Node getNextNodeBreadthFirst()
Traverses to the next Node from the current Node using breadth-first tree traversal
- The next Node from the current Node using breadth-first tree traversal.
getNextNodeDepthFirst
protected Node getNextNodeDepthFirst()
Traverses to the next Node from the current Node using depth-first tree traversal
- The next Node from the current Node using depth-first tree traversal.
getRootNode
public Node getRootNode()
Get the root Node that defines the scope of the tree to traverse.
hasMoreNodes
public boolean hasMoreNodes()
Returns whether or not there are more nodes available based on the current configuration of this NodeTreeWalker.
- hasMoreNodes in interface NodeIterator
- True if there are more Nodes available, based on the current configuration, or false otherwise.
initRootNode
protected void initRootNode(Node rootNode)
throws NullPointerException
Sets the root Node to be the given Node.
Resets the current position in the tree.
rootNode
- The Node to set as the root of the tree.
isDepthFirst
public boolean isDepthFirst()
Whether the NodeTreeWalker is currently set to use depth-first or breadth-first tree traversal.
- True if depth-first tree-traversal is used, or false if breadth-first tree-traversal is being used.
nextNode
public Node nextNode()
Traverses to the next Node from the current Node, using either depth-first or breadth-first tree traversal as appropriate.
- nextNode in interface NodeIterator
- The next Node from the current Node.
removeMaxDepthRestriction
public void removeMaxDepthRestriction()
Removes any restrictions in place that prevent this NodeTreeWalker from traversing beyond a certain depth.
reset
public void reset()
Resets the current position in the tree,
such that calling nextNode()
will return the first Node again.
setCurrentNodeAsRootNode
public void setCurrentNodeAsRootNode()
throws NullPointerException
Sets the current Node as the root Node.
Resets the current position in the tree.
setDepthFirst
public void setDepthFirst(boolean depthFirst)
Sets whether the NodeTreeWalker should use depth-first or breadth-first tree traversal.
depthFirst
- Whether to use depth-first (true) or breadth-first (false) tree traversal.
setRootNode
public void setRootNode(Node rootNode)
throws NullPointerException
Sets the specified Node as the root Node.
Resets the current position in the tree.
rootNode
- The Node to set as the root of the tree.
| © 2005 Derrick Oswald Mai 08, 2008 |
HTML Parser is an open source library released under LGPL. |  |