Class Axis

java.lang.Object

com.icl.saxon.om.Axis

public final class Axis
extends Object

An axis, that is a direction of navigation in the document structure.

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	ANCESTOR	Constants representing the axes
static final byte	ANCESTOR_OR_SELF
static final byte	ATTRIBUTE
static final String[]	axisName	Table giving the name each axis
static final byte	CHILD
static final byte	DESCENDANT
static final byte	DESCENDANT_OR_SELF
static final byte	FOLLOWING
static final byte	FOLLOWING_SIBLING
static final boolean[]	isForwards	Table indicating for each axis whether it is in forwards document order
static final boolean[]	isPeerAxis	Table indicating for each axis whether it is a peer axis.
static final boolean[]	isReverse	Table indicating for each axis whether it is in reverse document order
static final boolean[]	isSubtreeAxis	Table indicating for each axis whether it is contained within the subtree rooted at the origin node.
static final byte	NAMESPACE
static final byte	PARENT
static final byte	PRECEDING
static final byte	PRECEDING_OR_ANCESTOR
static final byte	PRECEDING_SIBLING
static final short[]	principalNodeType	Table indicating the principal node type of each axis
static final byte	SELF

Constructor Summary

Constructors

Constructor	Description
Axis()

Method Summary

Modifier and Type	Method	Description
static byte	getAxisNumber(String name)	Resolve an axis name into a symbolic constant representing the axis

Methods inherited from class Object

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

Field Details

ANCESTOR

public static final byte ANCESTOR

Constants representing the axes

See Also:

• Constant Field Values

ANCESTOR_OR_SELF

public static final byte ANCESTOR_OR_SELF

See Also:

• Constant Field Values

ATTRIBUTE

public static final byte ATTRIBUTE

See Also:

• Constant Field Values

CHILD

public static final byte CHILD

See Also:

• Constant Field Values

DESCENDANT

public static final byte DESCENDANT

See Also:

• Constant Field Values

DESCENDANT_OR_SELF

public static final byte DESCENDANT_OR_SELF

See Also:

• Constant Field Values

FOLLOWING

public static final byte FOLLOWING

See Also:

• Constant Field Values

FOLLOWING_SIBLING

public static final byte FOLLOWING_SIBLING

See Also:

• Constant Field Values

NAMESPACE

public static final byte NAMESPACE

See Also:

• Constant Field Values

PARENT

public static final byte PARENT

See Also:

• Constant Field Values

PRECEDING

public static final byte PRECEDING

See Also:

• Constant Field Values

PRECEDING_SIBLING

public static final byte PRECEDING_SIBLING

See Also:

• Constant Field Values

SELF

public static final byte SELF

See Also:

• Constant Field Values

PRECEDING_OR_ANCESTOR

public static final byte PRECEDING_OR_ANCESTOR

See Also:

• Constant Field Values

principalNodeType

public static final short[] principalNodeType

Table indicating the principal node type of each axis

isForwards

public static final boolean[] isForwards

Table indicating for each axis whether it is in forwards document order

isReverse

public static final boolean[] isReverse

Table indicating for each axis whether it is in reverse document order

isPeerAxis

public static final boolean[] isPeerAxis

Table indicating for each axis whether it is a peer axis. An axis is a peer axis if no node on the axis is an ancestor of another node on the axis.

isSubtreeAxis

public static final boolean[] isSubtreeAxis

Table indicating for each axis whether it is contained within the subtree rooted at the origin node.

axisName

public static final String[] axisName

Table giving the name each axis

Constructor Details

Axis

public Axis()

Method Details

getAxisNumber

public static byte getAxisNumber(String name)
                          throws XPathException

Resolve an axis name into a symbolic constant representing the axis

Throws:

XPathException