org.mdiutil.xml.tree

Class XMLNodesIterator

java.lang.Object

org.mdiutil.xml.tree.XMLNodesIterator

All Implemented Interfaces:

Iterator<XMLNode>

public class XMLNodesIterator
extends Object
implements Iterator<XMLNode>

A tree walker for xml nodes.

Constructor Summary

Constructors

Constructor and Description
XMLNodesIterator(XMLNode rootNode) Create a new XMLNodesIterator.

Method Summary

Modifier and Type	Method and Description
void	addToParentFilters(XMLNode node) Add a node to the parent tags.
XMLNode	firstChild() Moves the TreeWalker to the first visible child of the current node, and returns the new node.
String	getCurrentFilterName() Return the filter name for the current node.
XMLNode	getCurrentNode() Return the node at which the TreeWalker is currently positioned.
int	getLevel() Return the level in the XML subtree, the 0 value designing the root Node.
Map<String,Boolean>	getParentFilterStates() Return the states of the parent tags.
XMLNode	getRoot() The root node of the TreeWalker, as specified when it was created.
boolean	hasCurrentFilterName() Return true if there is a filter name for the current node.
boolean	hasNext() Return true if there is a next node.
boolean	inParentFilter(String filterName) Return true if the current node is inside the specified parent filter.
XMLNode	lastChild() Moves the TreeWalker to the last visible child of the current node, and returns the new node.
XMLNode	next() Moves the iterator to the next node in document order relative to the current node, and returns this node.
XMLNode	nextNode() Moves the TreeWalker to the next visible node in document order relative to the current node, and returns the new node.
XMLNode	nextSibling() Moves the TreeWalker to the next sibling of the current node, and returns the new node.
XMLNode	parentNode() Moves to and returns the closest visible ancestor node of the current node.
XMLNode	previousNode() Moves the TreeWalker to the previous visible node in document order relative to the current node, and returns the new node.
XMLNode	previousSibling() Moves the TreeWalker to the previous sibling of the current node, and returns the new node.
void	setCurrentNode(XMLNode node) Set the current Node.
void	setParentFilters(Map<String,NodeFilter> parentFilters) Set the parent filters to check.
void	setParentFilters(NodeFilter... filters) Set the filters to check.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

XMLNodesIterator

public XMLNodesIterator(XMLNode rootNode)

Create a new XMLNodesIterator.

Parameters:

rootNode - the root Node of this iterator

Method Detail

setParentFilters

public final void setParentFilters(NodeFilter... filters)

Set the filters to check.

Parameters:

filters - the filters

setParentFilters

public final void setParentFilters(Map<String,NodeFilter> parentFilters)

Set the parent filters to check.

Parameters:

parentFilters - the filters

hasCurrentFilterName

public boolean hasCurrentFilterName()

Return true if there is a filter name for the current node.

Returns:

true if there is a filter name for the current node

getCurrentFilterName

public String getCurrentFilterName()

Return the filter name for the current node.

Returns:

the filter name for the current node

getParentFilterStates

public Map<String,Boolean> getParentFilterStates()

Return the states of the parent tags.

Returns:

the states of the parent tags

addToParentFilters

public void addToParentFilters(XMLNode node)

Add a node to the parent tags.

Parameters:

node - the node

inParentFilter

public boolean inParentFilter(String filterName)

Return true if the current node is inside the specified parent filter.

Parameters:

filterName - the filter name

Returns:

true if the current node is inside the specified parent tag

setCurrentNode

public void setCurrentNode(XMLNode node)

Set the current Node.

Parameters:

node - the node

getLevel

public int getLevel()

Return the level in the XML subtree, the 0 value designing the root Node.

Returns:

the level

firstChild

public XMLNode firstChild()

Moves the TreeWalker to the first visible child of the current node, and returns the new node.

Returns:

the first child

getCurrentNode

public XMLNode getCurrentNode()

Return the node at which the TreeWalker is currently positioned.

Returns:

the node

getRoot

public XMLNode getRoot()

The root node of the TreeWalker, as specified when it was created.

Returns:

the root node

lastChild

public XMLNode lastChild()

Moves the TreeWalker to the last visible child of the current node, and returns the new node.

Returns:

the node

next

public XMLNode next()

Moves the iterator to the next node in document order relative to the current node, and returns this node.

Specified by:

next in interface Iterator<XMLNode>

Returns:

the next Node

nextNode

public XMLNode nextNode()

Moves the TreeWalker to the next visible node in document order relative to the current node, and returns the new node.

Returns:

the node

hasNext

public boolean hasNext()

Return true if there is a next node.

Specified by:

hasNext in interface Iterator<XMLNode>

Returns:

true if there is a next node

nextSibling

public XMLNode nextSibling()

Moves the TreeWalker to the next sibling of the current node, and returns the new node.

Returns:

the node

previousSibling

public XMLNode previousSibling()

Moves the TreeWalker to the previous sibling of the current node, and returns the new node.

Returns:

the node

parentNode

public XMLNode parentNode()

Moves to and returns the closest visible ancestor node of the current node.

Returns:

the node

previousNode

public XMLNode previousNode()

Moves the TreeWalker to the previous visible node in document order relative to the current node, and returns the new node.

Returns:

the node