XMLTreeWalker

java.lang.Object
- org.mdiutil.xml.XMLTreeWalker

All Implemented Interfaces:

org.w3c.dom.traversal.TreeWalker
```
public class XMLTreeWalker
extends Object
implements org.w3c.dom.traversal.TreeWalker
```
This class implements the interface TreeWalker.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MODE_ROOT` The mode for traversing under the root node.
`static int`	`MODE_SLICE` The mode for traversing from the root node to another node.

Constructor Summary

Constructors
Constructor and Description
`XMLTreeWalker(Document doc)` Create a new XMLTreeWalker.
`XMLTreeWalker(Node rootNode)` Create a new XMLTreeWalker, in the default `MODE_ROOT` mode.
`XMLTreeWalker(Node rootNode, Node lastNode)` Create a new XMLTreeWalker, in the `MODE_SLICE` mode.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Node`	`firstChild()` Moves the TreeWalker to the first visible child of the current node, and returns the new node.
`Node`	`getCurrentNode()` Return the node at which the TreeWalker is currently positioned.
`boolean`	`getExpandEntityReferences()` Return the value of this flag determines whether the children of entity reference nodes are visible to the TreeWalker.
`org.w3c.dom.traversal.NodeFilter`	`getFilter()` Return the filter used to screen nodes.
`Node`	`getLastNode()` Return the last Node of the DOM tree to traverse (more specifically, the DOM tree, the walker will stop the iteration just before this Node.
`int`	`getLevel()` Return the level in the XML subtree, the 0 value designing the root Node.
`Node`	`getRoot()` The root node of the TreeWalker, as specified when it was created.
`int`	`getTraversalMode()` Return the mode used to traverse the DOM tree.
`int`	`getWhatToShow()` This attribute determines which node types are presented via the TreeWalker.
`Node`	`lastChild()` Moves the TreeWalker to the last visible child of the current node, and returns the new node.
`Node`	`nextNode()` Moves the TreeWalker to the next visible node in document order relative to the current node, and returns the new node.
`Node`	`nextSibling()` Moves the TreeWalker to the next sibling of the current node, and returns the new node.
`Node`	`parentNode()` Moves to and returns the closest visible ancestor node of the current node.
`Node`	`previousNode()` Moves the TreeWalker to the previous visible node in document order relative to the current node, and returns the new node.
`Node`	`previousSibling()` Moves the TreeWalker to the previous sibling of the current node, and returns the new node.
`void`	`setCurrentNode(Node node)`
`void`	`setExpandEntityReferences(boolean expand)` Not used for the moment.
`void`	`setFilter(org.w3c.dom.traversal.NodeFilter filter)` Set the node filter.
`void`	`setNodeType(int type)` Not used for the moment.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MODE_ROOT
```
public static final int MODE_ROOT
```
    The mode for traversing under the root node.
    
    See Also:
    
    Constant Field Values
  - MODE_SLICE
```
public static final int MODE_SLICE
```
    The mode for traversing from the root node to another node.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - XMLTreeWalker
```
public XMLTreeWalker(Node rootNode)
```
    Create a new XMLTreeWalker, in the default MODE_ROOT mode.
    
    Parameters:
    
    rootNode - the root Node of this walker
  - XMLTreeWalker
```
public XMLTreeWalker(Node rootNode,
                     Node lastNode)
```
    Create a new XMLTreeWalker, in the MODE_SLICE mode. The DOM hierarchy from the rootNode to the Node previous to the lastNode will be traversed. If the lastNode is null, the DOM tree will be traversed up to the last DOM Node.
    
    Parameters:
    
    rootNode - the root Node of this walker
    
    lastNode - the last Node of this walker
  - XMLTreeWalker
```
public XMLTreeWalker(Document doc)
```
    Create a new XMLTreeWalker.
    
    Parameters:
    
    doc - the Document whose DocumentElement will be used as root Node
- Method Detail
  - getTraversalMode
```
public int getTraversalMode()
```
    Return the mode used to traverse the DOM tree.
    - MODE_ROOT : only the Nodes under the getRoot() Node are traversed
    - MODE_SLICE : the hierarchy from the getRoot() Node to the Node previous to getLastNode() is traversed
    Returns:
    
    the mode
  - setNodeType
```
public void setNodeType(int type)
```
    Not used for the moment.
  - setFilter
```
public void setFilter(org.w3c.dom.traversal.NodeFilter filter)
```
    Set the node filter. Not used for the moment.
    
    Parameters:
    
    filter -
  - setExpandEntityReferences
```
public void setExpandEntityReferences(boolean expand)
```
    Not used for the moment.
  - setCurrentNode
```
public void setCurrentNode(Node node)
```
    Specified by:
    
    setCurrentNode in interface org.w3c.dom.traversal.TreeWalker
  - getFilter
```
public org.w3c.dom.traversal.NodeFilter getFilter()
```
    Return the filter used to screen nodes.
    
    Specified by:
    
    getFilter in interface org.w3c.dom.traversal.TreeWalker
    
    Returns:
    
    the filter
  - getLevel
```
public int getLevel()
```
    Return the level in the XML subtree, the 0 value designing the root Node. The level will always be >= 0 in the MODE_ROOT mode, but it can be < 0 in the MODE_SLICE mode, as the last Node can be higher in the DOM hierarchy than the root node.
    
    Returns:
    
    the level
  - firstChild
```
public Node firstChild()
```
    Moves the TreeWalker to the first visible child of the current node, and returns the new node.
    
    Specified by:
    
    firstChild in interface org.w3c.dom.traversal.TreeWalker
    
    Returns:
    
    the first child
  - getCurrentNode
```
public Node getCurrentNode()
```
    Return the node at which the TreeWalker is currently positioned.
    
    Specified by:
    
    getCurrentNode in interface org.w3c.dom.traversal.TreeWalker
    
    Returns:
    
    the node
  - getExpandEntityReferences
```
public boolean getExpandEntityReferences()
```
    Return the value of this flag determines whether the children of entity reference nodes are visible to the TreeWalker.
    
    Specified by:
    
    getExpandEntityReferences in interface org.w3c.dom.traversal.TreeWalker
    
    Returns:
    
    true if the children of entity reference nodes are visible to the TreeWalker
  - getRoot
```
public Node getRoot()
```
    The root node of the TreeWalker, as specified when it was created. It is guaranteed that the TreeWalker will never walk outside the subtree defined by this rootNode.
    
    Specified by:
    
    getRoot in interface org.w3c.dom.traversal.TreeWalker
    
    Returns:
    
    the root node
  - getLastNode
```
public Node getLastNode()
```
    Return the last Node of the DOM tree to traverse (more specifically, the DOM tree, the walker will stop the iteration just before this Node. If the mode is MODE_ROOT, this is guaranteed to be null.
    
    Returns:
    
    the last Node of the DOM tree to traverse
  - getWhatToShow
```
public int getWhatToShow()
```
    This attribute determines which node types are presented via the TreeWalker.
    
    Specified by:
    
    getWhatToShow in interface org.w3c.dom.traversal.TreeWalker
    
    Returns:
    
    the node types
  - lastChild
```
public Node lastChild()
```
    Moves the TreeWalker to the last visible child of the current node, and returns the new node.
    
    Specified by:
    
    lastChild in interface org.w3c.dom.traversal.TreeWalker
  - nextNode
```
public Node nextNode()
```
    Moves the TreeWalker to the next visible node in document order relative to the current node, and returns the new node.
    - If the mode MODE_ROOT, we traverse the DOM tree under the getRoot() node
    - If the mode MODE_SLICE, we traverse the DOM tree beginning from the getRoot() node,
    Specified by:
    
    nextNode in interface org.w3c.dom.traversal.TreeWalker
  - nextSibling
```
public Node nextSibling()
```
    Moves the TreeWalker to the next sibling of the current node, and returns the new node.
    
    Specified by:
    
    nextSibling in interface org.w3c.dom.traversal.TreeWalker
  - previousSibling
```
public Node previousSibling()
```
    Moves the TreeWalker to the previous sibling of the current node, and returns the new node.
    
    Specified by:
    
    previousSibling in interface org.w3c.dom.traversal.TreeWalker
  - parentNode
```
public Node parentNode()
```
    Moves to and returns the closest visible ancestor node of the current node.
    
    Specified by:
    
    parentNode in interface org.w3c.dom.traversal.TreeWalker
  - previousNode
```
public Node previousNode()
```
    Moves the TreeWalker to the previous visible node in document order relative to the current node, and returns the new node.
    
    Specified by:
    
    previousNode in interface org.w3c.dom.traversal.TreeWalker

Class XMLTreeWalker

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MODE_ROOT

MODE_SLICE

Constructor Detail

XMLTreeWalker

XMLTreeWalker

XMLTreeWalker

Method Detail

getTraversalMode

setNodeType

setFilter

setExpandEntityReferences

setCurrentNode

getFilter

getLevel

firstChild

getCurrentNode

getExpandEntityReferences

getRoot

getLastNode

getWhatToShow

lastChild

nextNode

nextSibling

previousSibling

parentNode

previousNode