com.icl.saxon.om

Class Axis


public final class Axis
extends java.lang.Object

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

Field Summary

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

Method Summary

static byte
getAxisNumber(String name)
Resolve an axis name into a symbolic constant representing the axis

Field Details

ANCESTOR

public static final byte ANCESTOR
Constants representing the axes
Field Value:
0

ANCESTOR_OR_SELF

public static final byte ANCESTOR_OR_SELF
Field Value:
1

ATTRIBUTE

public static final byte ATTRIBUTE
Field Value:
2

CHILD

public static final byte CHILD
Field Value:
3

DESCENDANT

public static final byte DESCENDANT
Field Value:
4

DESCENDANT_OR_SELF

public static final byte DESCENDANT_OR_SELF
Field Value:
5

FOLLOWING

public static final byte FOLLOWING
Field Value:
6

FOLLOWING_SIBLING

public static final byte FOLLOWING_SIBLING
Field Value:
7

NAMESPACE

public static final byte NAMESPACE
Field Value:
8

PARENT

public static final byte PARENT
Field Value:
9

PRECEDING

public static final byte PRECEDING
Field Value:
10

PRECEDING_OR_ANCESTOR

public static final byte PRECEDING_OR_ANCESTOR
Field Value:
13

PRECEDING_SIBLING

public static final byte PRECEDING_SIBLING
Field Value:
11

SELF

public static final byte SELF
Field Value:
12

axisName

public static final String[] axisName
Table giving the name each axis

isForwards

public static final boolean[] isForwards
Table indicating for each axis whether it is in forwards 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.

isReverse

public static final boolean[] isReverse
Table indicating for each axis whether it is in reverse document order

isSubtreeAxis

public static final boolean[] isSubtreeAxis
Table indicating for each axis whether it is contained within the subtree rooted at the origin node.

principalNodeType

public static final short[] principalNodeType
Table indicating the principal node type of each axis

Method Details

getAxisNumber

public static byte getAxisNumber(String name)
            throws XPathException
Resolve an axis name into a symbolic constant representing the axis