org.cip4.jdflib.elementwalker

Class ElementWalker

java.lang.Object

org.cip4.jdflib.elementwalker.ElementWalker

Direct Known Subclasses:

BaseElementWalker, PackageElementWalker

public class ElementWalker
extends java.lang.Object

elementwalker class that allows you to traverse a dom tree starting at a given root

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log
protected IWalkerFactory	theFactory

Constructor Summary

Constructors

Constructor and Description
ElementWalker(IWalkerFactory _theFactory)

Method Summary

Modifier and Type	Method and Description
IWalkerFactory	getFactory() Getter for theFactory attribute.
java.lang.String	toString()
int	walkTree(KElement e, KElement trackElem) walk the tree starting at e.
int	walkTreeKidsFirst(KElement e) walk the tree starting at e.

Methods inherited from class java.lang.Object

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

Field Detail

theFactory

protected final IWalkerFactory theFactory

log

protected final org.apache.commons.logging.Log log

Constructor Detail

ElementWalker

public ElementWalker(IWalkerFactory _theFactory)

Parameters:

_theFactory - used to find the individual instances for the children

Method Detail

walkTree

public int walkTree(KElement e,
                    KElement trackElem)

walk the tree starting at e.

Parameters:

e - the root element to walk, must not be null

trackElem - a parallel element to e that may additionally be modified during the walk, may be null

Returns:

n the number of traversed elements

walkTreeKidsFirst

public int walkTreeKidsFirst(KElement e)

walk the tree starting at e.

Parameters:

e - the root element to walk

Returns:

n the number of traversed elements

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

getFactory

public IWalkerFactory getFactory()

Getter for theFactory attribute.

Returns:

the theFactory