org.apache.axis2.om.impl.llom
Class OMNavigator

java.lang.Object
  extended byorg.apache.axis2.om.impl.llom.OMNavigator

public class OMNavigator
extends java.lang.Object

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
OMNavigator()
          Constructor OMNavigator
OMNavigator(OMNode node)
          Constructor OMNavigator
 
Method Summary
 void init(OMNode node)
          Method init
 boolean isCompleted()
          The completed status
 boolean isNavigable()
          the navigable status
 OMNode next()
          get 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

OMNavigator

public OMNavigator()
Constructor OMNavigator


OMNavigator

public OMNavigator(OMNode node)
Constructor OMNavigator

Parameters:
node -
Method Detail

init

public void init(OMNode node)
Method init

Parameters:
node -

next

public OMNode next()
get the next node

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

visited

public boolean visited()
Method visited

Returns:

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()
the navigable status

Returns:

isCompleted

public boolean isCompleted()
The completed status

Returns: