org.planx.xpath.expr.axis
Class AncestorAxis

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

public class AncestorAxis
extends Axis

Ancestor axis and ancestor-or-self axis.

Constructor Summary

AncestorAxis()
Create an ancestor axis.

AncestorAxis(boolean includeSelf)
If includeSelf is true create an ancestor-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) Return an iterator over the nodes of this axis.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AncestorAxis

public AncestorAxis()

Create an ancestor axis.

AncestorAxis

public AncestorAxis(boolean includeSelf)

If includeSelf is true create an ancestor-or-self axis. If includeSelf is false create an ancestor axis.

Method Detail

iterator

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

Description copied from class: Axis

Return an iterator over the nodes of this axis.

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