Package net.sf.saxon.om
Class Axis
java.lang.Object
net.sf.saxon.om.Axis
An axis, that is a direction of navigation in the document structure.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final byte
Constant representing the ancestor axisstatic final byte
Constant representing the ancestor-or-self axisstatic final byte
Constant representing the attribute axisstatic final String[]
Table giving the name each axisstatic final byte
Constant representing the child axisstatic final byte
Constant representing the descendant axisstatic final byte
Constant representing the descendant-or-self axisstatic final byte
Constant representing the following axisstatic final byte
Constant representing the following-sibling axisstatic final boolean[]
Table indicating for each axis whether it is in forwards document orderstatic final boolean[]
Table indicating for each axis whether it is a peer axis.static final boolean[]
Table indicating for each axis whether it is in reverse document orderstatic final boolean[]
Table indicating for each axis whether it is contained within the subtree rooted at the origin node.static final byte
Constant representing the namespace axisstatic final byte
Constant representing the parent axisstatic final byte
Constant representing the preceding axisstatic final byte
Constant representing the preceding-or-ancestor axis.static final byte
Constant representing the preceding-sibling axisstatic final short[]
Table indicating the principal node type of each axisstatic final byte
Constant representing the self axis -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
containsNodeKind
(int axis, int nodeKind) Determine whether a given kind of node can be found on a given axisstatic byte
getAxisNumber
(String name) Resolve an axis name into a symbolic constant representing the axisstatic boolean
isAlwaysEmpty
(int axis, int nodeKind)
-
Field Details
-
ANCESTOR
public static final byte ANCESTORConstant representing the ancestor axis- See Also:
-
ANCESTOR_OR_SELF
public static final byte ANCESTOR_OR_SELFConstant representing the ancestor-or-self axis- See Also:
-
ATTRIBUTE
public static final byte ATTRIBUTEConstant representing the attribute axis- See Also:
-
CHILD
public static final byte CHILDConstant representing the child axis- See Also:
-
DESCENDANT
public static final byte DESCENDANTConstant representing the descendant axis- See Also:
-
DESCENDANT_OR_SELF
public static final byte DESCENDANT_OR_SELFConstant representing the descendant-or-self axis- See Also:
-
FOLLOWING
public static final byte FOLLOWINGConstant representing the following axis- See Also:
-
FOLLOWING_SIBLING
public static final byte FOLLOWING_SIBLINGConstant representing the following-sibling axis- See Also:
-
NAMESPACE
public static final byte NAMESPACEConstant representing the namespace axis- See Also:
-
PARENT
public static final byte PARENTConstant representing the parent axis- See Also:
-
PRECEDING
public static final byte PRECEDINGConstant representing the preceding axis- See Also:
-
PRECEDING_SIBLING
public static final byte PRECEDING_SIBLINGConstant representing the preceding-sibling axis- See Also:
-
SELF
public static final byte SELFConstant representing the self axis- See Also:
-
PRECEDING_OR_ANCESTOR
public static final byte PRECEDING_OR_ANCESTORConstant representing the preceding-or-ancestor axis. This axis is used internally by the xsl:number implementation, it returns the union of the preceding axis and the ancestor axis.- See Also:
-
principalNodeType
public static final short[] principalNodeTypeTable indicating the principal node type of each axis -
isForwards
public static final boolean[] isForwardsTable indicating for each axis whether it is in forwards document order -
isReverse
public static final boolean[] isReverseTable indicating for each axis whether it is in reverse document order -
isPeerAxis
public static final boolean[] isPeerAxisTable 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[] isSubtreeAxisTable indicating for each axis whether it is contained within the subtree rooted at the origin node. -
axisName
Table giving the name each axis
-
-
Method Details
-
getAxisNumber
Resolve an axis name into a symbolic constant representing the axis- Parameters:
name
-- Returns:
- integer value representing the named axis
- Throws:
StaticError
-
isAlwaysEmpty
public static boolean isAlwaysEmpty(int axis, int nodeKind) -
containsNodeKind
public static boolean containsNodeKind(int axis, int nodeKind) Determine whether a given kind of node can be found on a given axis
-