org.apache.axiom.om.impl.common

Class OMNavigator

java.lang.Object

org.apache.axiom.om.impl.common.OMNavigator

public class OMNavigator
extends java.lang.Object

Refer to the test, org.apache.axiom.om.OMNavigatorTest, to find out how to use features like isNavigable, isComplete and step.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	backtracked Field backtracked
private boolean	end Field end
private boolean	isDataSourceALeaf
private OMSerializable	next Field next
protected OMSerializable	node Field node
private OMSerializable	root Field root
private boolean	start Field start
private boolean	visited Field visited

Constructor Summary

Constructors

Constructor and Description
OMNavigator() Constructor OMNavigator.
OMNavigator(OMSerializable node) Constructor OMNavigator.

Method Summary

Modifier and Type	Method and Description
private OMNode	_getFirstChild(OMContainer node)
OMSerializable	getNext() Get the next information item.
private OMNode	getNextSibling(OMNode node)
void	init(OMSerializable node) Method init.
boolean	isCompleted() Returns the completed status.
private boolean	isLeaf(OMSerializable n)
boolean	isNavigable() Returns the navigable status.
private boolean	isOMSourcedElement(OMSerializable node)
OMNode	next() Get the next node.
void	setDataSourceIsLeaf(boolean value) Indicate if an OMSourcedElement with a OMDataSource should be considered as an interior element node or as a leaf.
void	step() This is a very special method.
private void	updateNextNode() Private method to encapsulate the searching logic.
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 OMSerializable node

Field node

visited

private boolean visited

Field visited

next

private OMSerializable next

Field next

root

private OMSerializable root

Field root

backtracked

private boolean backtracked

Field backtracked

end

private boolean end

Field end

start

private boolean start

Field start

isDataSourceALeaf

private boolean isDataSourceALeaf

Constructor Detail

OMNavigator

public OMNavigator()

Constructor OMNavigator.

OMNavigator

public OMNavigator(OMSerializable node)

Constructor OMNavigator.

Parameters:

node -

Method Detail

init

public void init(OMSerializable node)

Method init.

Parameters:

node -

setDataSourceIsLeaf

public void setDataSourceIsLeaf(boolean value)

Indicate if an OMSourcedElement with a OMDataSource should be considered as an interior element node or as a leaf.

Parameters:

value - boolean

getNext

public OMSerializable getNext()

Get the next information item.

Returns:

the next information item in the sequence of preorder traversal. Note however that a container (document or element) is treated slightly differently. Once the container is passed it returns the same item in the next encounter as well.

next

public OMNode next()

Get the next node. This method only exists for compatibility with existing code. It may throw a ClassCastException if an attempt is made to use it on a navigator that was created from an OMDocument.

Returns:

the next node

See Also:

getNext()

updateNextNode

private void updateNextNode()

Private method to encapsulate the searching logic.

isLeaf

private boolean isLeaf(OMSerializable n)

Parameters:

n - OMNode

Returns:

true if this OMNode should be considered a leaf node

isOMSourcedElement

private boolean isOMSourcedElement(OMSerializable node)

_getFirstChild

private OMNode _getFirstChild(OMContainer node)

Parameters:

node -

Returns:

first child or null

getNextSibling

private OMNode getNextSibling(OMNode node)

Parameters:

node -

Returns:

next sibling or null

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 and 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.