org.planx.xpath.expr.axis
Class DescendantAxis

java.lang.Object
  org.planx.xpath.expr.axis.Axis
      org.planx.xpath.expr.axis.DescendantAxis

Direct Known Subclasses:

AnyAxis

public class DescendantAxis
extends Axis

Descendant axis and descendant-or-self axis.

Constructor Summary

DescendantAxis()
Create a descendant axis.

DescendantAxis(boolean includeSelf)
If includeSelf is true create a descendant-or-self axis.

Method Summary

int	getPrincipalNodeType() The principal node type of this axis is Navigator.ELEMENT.
boolean	isReverse() Returns true if this axis is a reverse axis.
AxisIterator	iterator(Object contextNode, Navigator navigator) The descendant nodes are visited in document order.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DescendantAxis

public DescendantAxis()

Create a descendant axis.

DescendantAxis

public DescendantAxis(boolean includeSelf)

If includeSelf is true create a descendant-or-self axis. If includeSelf is false create a descendant axis.

Method Detail

iterator

public AxisIterator iterator(Object contextNode,
                             Navigator navigator)
                      throws XPathException

The descendant nodes are visited in document order.

Specified by:

iterator in class Axis

Throws:

XPathException

getPrincipalNodeType

public int getPrincipalNodeType()

The principal node type of this axis is Navigator.ELEMENT.

Specified by:

getPrincipalNodeType in class Axis

isReverse

public boolean isReverse()

Description copied from class: Axis

Returns true if this axis is a reverse axis. I.e. returns nodes in reverse document order.

Specified by:

isReverse in class Axis

toString

public String toString()

Overrides:

toString in class Object