org.apache.axiom.om.impl.dom
Class DOMNavigator

java.lang.Object
  extended by org.apache.axiom.om.impl.dom.DOMNavigator

public class DOMNavigator
extends java.lang.Object

This is exactly the same as org.apache.axiom.om.impl.om.OMNavigator, only the llom specifics are changed to dom. Refer to the testClass to find out how to use features like isNavigable, isComplete and step.


Field Summary
protected  OMNode node
          Field node
 
Constructor Summary
DOMNavigator()
          Constructor OMNavigator.
DOMNavigator(OMNode node)
          Constructor OMNavigator.
 
Method Summary
 void init(OMNode node)
          Method init.
 boolean isCompleted()
          Returns the completed status.
 boolean isNavigable()
          Returns the navigable status.
 OMNode next()
          Gets the next node.
 void step()
          This is a very special method.
 boolean visited()
          Method visited.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

node

protected OMNode node
Field node

Constructor Detail

DOMNavigator

public DOMNavigator()
Constructor OMNavigator.


DOMNavigator

public DOMNavigator(OMNode node)
Constructor OMNavigator.

Parameters:
node -
Method Detail

init

public void init(OMNode node)
Method init.

Parameters:
node -

next

public OMNode next()
Gets the next node.

Returns:
Returns OMNode in the sequence of preorder traversal. Note however that an element node is treated slightly differently. Once the element is passed it returns the same element in the next encounter as well.

visited

public boolean visited()
Method visited.

Returns:
Returns boolean.

step

public void step()
This is a very special method. This allows the navigator to step once it has reached the existing OM. At this point the isNavigable method will return false but the isComplete method may return false which means that the navigating the given element is not complete but the navigator cannot proceed.


isNavigable

public boolean isNavigable()
Returns the navigable status.

Returns:
Returns boolean.

isCompleted

public boolean isCompleted()
Returns the completed status.

Returns:
Returns boolean.


Copyright © 2004-2009 The Apache Software Foundation. All Rights Reserved.