<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:21 GMT 2011 -->
<TITLE>
Axis
</TITLE>
<META NAME="date" CONTENT="2011-12-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Axis";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/sf/saxon/om/AttributeCollection.html" title="interface in net.sf.saxon.om"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/om/CodedName.html" title="class in net.sf.saxon.om"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/om/Axis.html" target="_top"><B>FRAMES</B></A>
<A HREF="Axis.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
net.sf.saxon.om</FONT>
<BR>
Class Axis</H2>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.saxon.om.Axis</B>
</PRE>
<HR>
<DL>
<DT><PRE>public final class <B>Axis</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
</PRE>
<P>
An axis, that is a direction of navigation in the document structure.
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#ANCESTOR">ANCESTOR</A></B></CODE>
<BR>
Constant representing the ancestor axis</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#ANCESTOR_OR_SELF">ANCESTOR_OR_SELF</A></B></CODE>
<BR>
Constant representing the ancestor-or-self axis</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#ATTRIBUTE">ATTRIBUTE</A></B></CODE>
<BR>
Constant representing the attribute axis</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#axisJavaName">axisJavaName</A></B></CODE>
<BR>
Table giving the name of each axis as used in a generated Java program, for example "ANCESTOR_OR_SELF"</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#axisName">axisName</A></B></CODE>
<BR>
Table giving the name of each axis as used in XPath, for example "ancestor-or-self"</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#CHILD">CHILD</A></B></CODE>
<BR>
Constant representing the child axis</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#DESCENDANT">DESCENDANT</A></B></CODE>
<BR>
Constant representing the descendant axis</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#DESCENDANT_OR_SELF">DESCENDANT_OR_SELF</A></B></CODE>
<BR>
Constant representing the descendant-or-self axis</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#FOLLOWING">FOLLOWING</A></B></CODE>
<BR>
Constant representing the following axis</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#FOLLOWING_SIBLING">FOLLOWING_SIBLING</A></B></CODE>
<BR>
Constant representing the following-sibling axis</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#inverseAxis">inverseAxis</A></B></CODE>
<BR>
For each axis, determine the inverse axis, in the sense that if A is on axis X starting at B,
the B is on the axis inverseAxis[X] starting at A.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static boolean[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#isForwards">isForwards</A></B></CODE>
<BR>
Table indicating for each axis whether it is in forwards document order</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static boolean[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#isPeerAxis">isPeerAxis</A></B></CODE>
<BR>
Table indicating for each axis whether it is a peer axis.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static boolean[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#isSubtreeAxis">isSubtreeAxis</A></B></CODE>
<BR>
Table indicating for each axis whether it is contained within the subtree
rooted at the origin node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#NAMESPACE">NAMESPACE</A></B></CODE>
<BR>
Constant representing the namespace axis</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#PARENT">PARENT</A></B></CODE>
<BR>
Constant representing the parent axis</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#PRECEDING">PRECEDING</A></B></CODE>
<BR>
Constant representing the preceding axis</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#PRECEDING_OR_ANCESTOR">PRECEDING_OR_ANCESTOR</A></B></CODE>
<BR>
Constant representing the preceding-or-ancestor axis.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#PRECEDING_SIBLING">PRECEDING_SIBLING</A></B></CODE>
<BR>
Constant representing the preceding-sibling axis</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static short[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#principalNodeType">principalNodeType</A></B></CODE>
<BR>
Table indicating the principal node type of each axis</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#SELF">SELF</A></B></CODE>
<BR>
Constant representing the self axis</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#containsNodeKind(int, int)">containsNodeKind</A></B>(int axis,
int nodeKind)</CODE>
<BR>
Determine whether a given kind of node can be found on a given axis.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static byte</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#getAxisNumber(java.lang.String)">getAxisNumber</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
Resolve an axis name into a symbolic constant representing the axis</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/Axis.html#isAlwaysEmpty(int, int)">isAlwaysEmpty</A></B>(int axis,
int nodeKind)</CODE>
<BR>
Ask whether a given axis can contain any nodes when starting at the specified node kind.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ANCESTOR"><!-- --></A><H3>
ANCESTOR</H3>
<PRE>
public static final byte <B>ANCESTOR</B></PRE>
<DL>
<DD>Constant representing the ancestor axis
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.Axis.ANCESTOR">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ANCESTOR_OR_SELF"><!-- --></A><H3>
ANCESTOR_OR_SELF</H3>
<PRE>
public static final byte <B>ANCESTOR_OR_SELF</B></PRE>
<DL>
<DD>Constant representing the ancestor-or-self axis
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.Axis.ANCESTOR_OR_SELF">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ATTRIBUTE"><!-- --></A><H3>
ATTRIBUTE</H3>
<PRE>
public static final byte <B>ATTRIBUTE</B></PRE>
<DL>
<DD>Constant representing the attribute axis
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.Axis.ATTRIBUTE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CHILD"><!-- --></A><H3>
CHILD</H3>
<PRE>
public static final byte <B>CHILD</B></PRE>
<DL>
<DD>Constant representing the child axis
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.Axis.CHILD">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DESCENDANT"><!-- --></A><H3>
DESCENDANT</H3>
<PRE>
public static final byte <B>DESCENDANT</B></PRE>
<DL>
<DD>Constant representing the descendant axis
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.Axis.DESCENDANT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DESCENDANT_OR_SELF"><!-- --></A><H3>
DESCENDANT_OR_SELF</H3>
<PRE>
public static final byte <B>DESCENDANT_OR_SELF</B></PRE>
<DL>
<DD>Constant representing the descendant-or-self axis
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.Axis.DESCENDANT_OR_SELF">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="FOLLOWING"><!-- --></A><H3>
FOLLOWING</H3>
<PRE>
public static final byte <B>FOLLOWING</B></PRE>
<DL>
<DD>Constant representing the following axis
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.Axis.FOLLOWING">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="FOLLOWING_SIBLING"><!-- --></A><H3>
FOLLOWING_SIBLING</H3>
<PRE>
public static final byte <B>FOLLOWING_SIBLING</B></PRE>
<DL>
<DD>Constant representing the following-sibling axis
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.Axis.FOLLOWING_SIBLING">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="NAMESPACE"><!-- --></A><H3>
NAMESPACE</H3>
<PRE>
public static final byte <B>NAMESPACE</B></PRE>
<DL>
<DD>Constant representing the namespace axis
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.Axis.NAMESPACE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PARENT"><!-- --></A><H3>
PARENT</H3>
<PRE>
public static final byte <B>PARENT</B></PRE>
<DL>
<DD>Constant representing the parent axis
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.Axis.PARENT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PRECEDING"><!-- --></A><H3>
PRECEDING</H3>
<PRE>
public static final byte <B>PRECEDING</B></PRE>
<DL>
<DD>Constant representing the preceding axis
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.Axis.PRECEDING">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PRECEDING_SIBLING"><!-- --></A><H3>
PRECEDING_SIBLING</H3>
<PRE>
public static final byte <B>PRECEDING_SIBLING</B></PRE>
<DL>
<DD>Constant representing the preceding-sibling axis
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.Axis.PRECEDING_SIBLING">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SELF"><!-- --></A><H3>
SELF</H3>
<PRE>
public static final byte <B>SELF</B></PRE>
<DL>
<DD>Constant representing the self axis
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.Axis.SELF">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PRECEDING_OR_ANCESTOR"><!-- --></A><H3>
PRECEDING_OR_ANCESTOR</H3>
<PRE>
public static final byte <B>PRECEDING_OR_ANCESTOR</B></PRE>
<DL>
<DD>Constant 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.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#net.sf.saxon.om.Axis.PRECEDING_OR_ANCESTOR">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="principalNodeType"><!-- --></A><H3>
principalNodeType</H3>
<PRE>
public static final short[] <B>principalNodeType</B></PRE>
<DL>
<DD>Table indicating the principal node type of each axis
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="isForwards"><!-- --></A><H3>
isForwards</H3>
<PRE>
public static final boolean[] <B>isForwards</B></PRE>
<DL>
<DD>Table indicating for each axis whether it is in forwards document order
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="isPeerAxis"><!-- --></A><H3>
isPeerAxis</H3>
<PRE>
public static final boolean[] <B>isPeerAxis</B></PRE>
<DL>
<DD>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.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="isSubtreeAxis"><!-- --></A><H3>
isSubtreeAxis</H3>
<PRE>
public static final boolean[] <B>isSubtreeAxis</B></PRE>
<DL>
<DD>Table indicating for each axis whether it is contained within the subtree
rooted at the origin node.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="axisName"><!-- --></A><H3>
axisName</H3>
<PRE>
public static final <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] <B>axisName</B></PRE>
<DL>
<DD>Table giving the name of each axis as used in XPath, for example "ancestor-or-self"
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="axisJavaName"><!-- --></A><H3>
axisJavaName</H3>
<PRE>
public static final <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[] <B>axisJavaName</B></PRE>
<DL>
<DD>Table giving the name of each axis as used in a generated Java program, for example "ANCESTOR_OR_SELF"
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="inverseAxis"><!-- --></A><H3>
inverseAxis</H3>
<PRE>
public static byte[] <B>inverseAxis</B></PRE>
<DL>
<DD>For each axis, determine the inverse axis, in the sense that if A is on axis X starting at B,
the B is on the axis inverseAxis[X] starting at A. This doesn't quite work for the PARENT axis,
which has no simple inverse: this table gives the inverse as CHILD
<P>
<DL>
</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getAxisNumber(java.lang.String)"><!-- --></A><H3>
getAxisNumber</H3>
<PRE>
public static byte <B>getAxisNumber</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)
throws <A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE>
<DL>
<DD>Resolve an axis name into a symbolic constant representing the axis
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> -
<DT><B>Returns:</B><DD>integer value representing the named axis
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="isAlwaysEmpty(int, int)"><!-- --></A><H3>
isAlwaysEmpty</H3>
<PRE>
public static boolean <B>isAlwaysEmpty</B>(int axis,
int nodeKind)</PRE>
<DL>
<DD>Ask whether a given axis can contain any nodes when starting at the specified node kind.
For example, the attribute axis when starting at an attribute node will always be empty
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>axis</CODE> - the axis, for example <A HREF="../../../../net/sf/saxon/om/Axis.html#ATTRIBUTE"><CODE>ATTRIBUTE</CODE></A><DD><CODE>nodeKind</CODE> - the node kind of the origin node, for example <A HREF="../../../../net/sf/saxon/type/Type.html#ATTRIBUTE"><CODE>Type.ATTRIBUTE</CODE></A>
<DT><B>Returns:</B><DD>true if no nodes will ever appear on the specified axis when starting at the specified
node kind.</DL>
</DD>
</DL>
<HR>
<A NAME="containsNodeKind(int, int)"><!-- --></A><H3>
containsNodeKind</H3>
<PRE>
public static boolean <B>containsNodeKind</B>(int axis,
int nodeKind)</PRE>
<DL>
<DD>Determine whether a given kind of node can be found on a given axis. For example,
the attribute axis will never contain any element nodes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>axis</CODE> - the axis, for example <A HREF="../../../../net/sf/saxon/om/Axis.html#ATTRIBUTE"><CODE>ATTRIBUTE</CODE></A><DD><CODE>nodeKind</CODE> - the node kind of the origin node, for example <A HREF="../../../../net/sf/saxon/type/Type.html#ELEMENT"><CODE>Type.ELEMENT</CODE></A>
<DT><B>Returns:</B><DD>true if the given kind of node can appear on the specified axis</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/sf/saxon/om/AttributeCollection.html" title="interface in net.sf.saxon.om"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/om/CodedName.html" title="class in net.sf.saxon.om"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/om/Axis.html" target="_top"><B>FRAMES</B></A>
<A HREF="Axis.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
