org.apache.xml.dtm

Class Axis


public final class Axis
extends java.lang.Object

Specifies values related to XPath Axes.

The ancestor, descendant, following, preceding and self axes partition a document (ignoring attribute and namespace nodes): they do not overlap and together they contain all the nodes in the document.

Field Summary

static int
ALL
A non-xpath axis, returns all nodes in the tree from and including the root.
static int
ALLFROMNODE
A non-xpath axis, traversing the subtree including the subtree root, descendants, attributes, and namespace node decls.
static int
ANCESTOR
The ancestor axis contains the ancestors of the context node; the ancestors of the context node consist of the parent of context node and the parent's parent and so on; thus, the ancestor axis will always include the root node, unless the context node is the root node.
static int
ANCESTORORSELF
the ancestor-or-self axis contains the context node and the ancestors of the context node; thus, the ancestor axis will always include the root node.
static int
ATTRIBUTE
the attribute axis contains the attributes of the context node; the axis will be empty unless the context node is an element.
static int
CHILD
The child axis contains the children of the context node.
static int
DESCENDANT
The descendant axis contains the descendants of the context node; a descendant is a child or a child of a child and so on; thus the descendant axis never contains attribute or namespace nodes.
static int
DESCENDANTORSELF
The descendant-or-self axis contains the context node and the descendants of the context node.
static int
DESCENDANTSFROMROOT
A non-xpath axis, returns all nodes that aren't namespaces or attributes, from and including the root.
static int
DESCENDANTSORSELFFROMROOT
A non-xpath axis, returns all nodes that aren't namespaces or attributes, from and including the root.
static int
FILTEREDLIST
A non-xpath axis, for functions.
static int
FOLLOWING
the following axis contains all nodes in the same document as the context node that are after the context node in document order, excluding any descendants and excluding attribute nodes and namespace nodes.
static int
FOLLOWINGSIBLING
The following-sibling axis contains all the following siblings of the context node; if the context node is an attribute node or namespace node, the following-sibling axis is empty.
static int
NAMESPACE
The namespace axis contains the namespace nodes of the context node; the axis will be empty unless the context node is an element.
static int
NAMESPACEDECLS
The namespace axis contains the namespace nodes of the context node; the axis will be empty unless the context node is an element.
static int
PARENT
The parent axis contains the parent of the context node, if there is one.
static int
PRECEDING
The preceding axis contains all nodes in the same document as the context node that are before the context node in document order, excluding any ancestors and excluding attribute nodes and namespace nodes
static int
PRECEDINGANDANCESTOR
A non-xpath axis, traversing the the preceding and the ancestor nodes, needed for inverseing select patterns to match patterns.
static int
PRECEDINGSIBLING
The preceding-sibling axis contains all the preceding siblings of the context node; if the context node is an attribute node or namespace node, the preceding-sibling axis is empty.
static int
ROOT
A non-xpath axis, returns root only.
static int
SELF
The self axis contains just the context node itself.

Method Summary

static String
getNames(int index)
static int
getNamesLength()
static boolean
isReverse(int axis)

Field Details

ALL

public static final int ALL
A non-xpath axis, returns all nodes in the tree from and including the root.
Field Value:
16

ALLFROMNODE

public static final int ALLFROMNODE
A non-xpath axis, traversing the subtree including the subtree root, descendants, attributes, and namespace node decls.
Field Value:
14

ANCESTOR

public static final int ANCESTOR
The ancestor axis contains the ancestors of the context node; the ancestors of the context node consist of the parent of context node and the parent's parent and so on; thus, the ancestor axis will always include the root node, unless the context node is the root node.
Field Value:
0

ANCESTORORSELF

public static final int ANCESTORORSELF
the ancestor-or-self axis contains the context node and the ancestors of the context node; thus, the ancestor axis will always include the root node.
Field Value:
1

ATTRIBUTE

public static final int ATTRIBUTE
the attribute axis contains the attributes of the context node; the axis will be empty unless the context node is an element.
Field Value:
2

CHILD

public static final int CHILD
The child axis contains the children of the context node.
Field Value:
3

DESCENDANT

public static final int DESCENDANT
The descendant axis contains the descendants of the context node; a descendant is a child or a child of a child and so on; thus the descendant axis never contains attribute or namespace nodes.
Field Value:
4

DESCENDANTORSELF

public static final int DESCENDANTORSELF
The descendant-or-self axis contains the context node and the descendants of the context node.
Field Value:
5

DESCENDANTSFROMROOT

public static final int DESCENDANTSFROMROOT
A non-xpath axis, returns all nodes that aren't namespaces or attributes, from and including the root.
Field Value:
17

DESCENDANTSORSELFFROMROOT

public static final int DESCENDANTSORSELFFROMROOT
A non-xpath axis, returns all nodes that aren't namespaces or attributes, from and including the root.
Field Value:
18

FILTEREDLIST

public static final int FILTEREDLIST
A non-xpath axis, for functions.
Field Value:
20

FOLLOWING

public static final int FOLLOWING
the following axis contains all nodes in the same document as the context node that are after the context node in document order, excluding any descendants and excluding attribute nodes and namespace nodes.
Field Value:
6

FOLLOWINGSIBLING

public static final int FOLLOWINGSIBLING
The following-sibling axis contains all the following siblings of the context node; if the context node is an attribute node or namespace node, the following-sibling axis is empty.
Field Value:
7

NAMESPACE

public static final int NAMESPACE
The namespace axis contains the namespace nodes of the context node; the axis will be empty unless the context node is an element.
Field Value:
9

NAMESPACEDECLS

public static final int NAMESPACEDECLS
The namespace axis contains the namespace nodes of the context node; the axis will be empty unless the context node is an element.
Field Value:
8

PARENT

public static final int PARENT
The parent axis contains the parent of the context node, if there is one.
Field Value:
10

PRECEDING

public static final int PRECEDING
The preceding axis contains all nodes in the same document as the context node that are before the context node in document order, excluding any ancestors and excluding attribute nodes and namespace nodes
Field Value:
11

PRECEDINGANDANCESTOR

public static final int PRECEDINGANDANCESTOR
A non-xpath axis, traversing the the preceding and the ancestor nodes, needed for inverseing select patterns to match patterns.
Field Value:
15

PRECEDINGSIBLING

public static final int PRECEDINGSIBLING
The preceding-sibling axis contains all the preceding siblings of the context node; if the context node is an attribute node or namespace node, the preceding-sibling axis is empty.
Field Value:
12

ROOT

public static final int ROOT
A non-xpath axis, returns root only.
Field Value:
19

SELF

public static final int SELF
The self axis contains just the context node itself.
Field Value:
13

Method Details

getNames

public static String getNames(int index)

getNamesLength

public static int getNamesLength()

isReverse

public static boolean isReverse(int axis)

Copyright B) 2006 Apache XML Project. All Rights Reserved.