org.apache.xml.dtm

Class Axis

public final class Axis extends 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 intALL
A non-xpath axis, returns all nodes in the tree from and including the root.
static intALLFROMNODE
A non-xpath axis, traversing the subtree including the subtree root, descendants, attributes, and namespace node decls.
static intANCESTOR
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 intANCESTORORSELF
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 intATTRIBUTE
the attribute axis contains the attributes of the context node; the axis will be empty unless the context node is an element.
static intCHILD
The child axis contains the children of the context node.
static intDESCENDANT
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 intDESCENDANTORSELF
The descendant-or-self axis contains the context node and the descendants of the context node.
static intDESCENDANTSFROMROOT
A non-xpath axis, returns all nodes that aren't namespaces or attributes, from and including the root.
static intDESCENDANTSORSELFFROMROOT
A non-xpath axis, returns all nodes that aren't namespaces or attributes, from and including the root.
static intFILTEREDLIST
A non-xpath axis, for functions.
static intFOLLOWING
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 intFOLLOWINGSIBLING
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 intNAMESPACE
The namespace axis contains the namespace nodes of the context node; the axis will be empty unless the context node is an element.
static intNAMESPACEDECLS
The namespace axis contains the namespace nodes of the context node; the axis will be empty unless the context node is an element.
static intPARENT
The parent axis contains the parent of the context node, if there is one.
static intPRECEDING
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 intPRECEDINGANDANCESTOR
A non-xpath axis, traversing the the preceding and the ancestor nodes, needed for inverseing select patterns to match patterns.
static intPRECEDINGSIBLING
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 intROOT
A non-xpath axis, returns root only.
static intSELF
The self axis contains just the context node itself.
Method Summary
static StringgetNames(int index)
static intgetNamesLength()
static booleanisReverse(int axis)

Field Detail

ALL

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

ALLFROMNODE

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

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.

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.

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.

CHILD

public static final int CHILD
The child axis contains the children of the context node.

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.

DESCENDANTORSELF

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

DESCENDANTSFROMROOT

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

DESCENDANTSORSELFFROMROOT

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

FILTEREDLIST

public static final int FILTEREDLIST
A non-xpath axis, for functions.

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.

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.

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.

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.

PARENT

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

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

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.

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.

ROOT

public static final int ROOT
A non-xpath axis, returns root only.

SELF

public static final int SELF
The self axis contains just the context node itself.

Method Detail

getNames

public static String getNames(int index)

getNamesLength

public static int getNamesLength()

isReverse

public static boolean isReverse(int axis)
Copyright © 2005 Apache XML Project. All Rights Reserved.