blob: 2439e920f55679f6794459efc9b5af06a4a67755 [file] [log] [blame]
<!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.5.0_18) on Sun Apr 01 21:18:30 PDT 2012 -->
<TITLE>
Axis
</TITLE>
<META NAME="keywords" CONTENT="org.apache.xml.dtm.Axis class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Axis";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= 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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Axis.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../org/apache/xml/dtm/DTM.html" title="interface in org.apache.xml.dtm"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/xml/dtm/Axis.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Axis.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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">
org.apache.xml.dtm</FONT>
<BR>
Class Axis</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xml.dtm.Axis</B>
</PRE>
<HR>
<DL>
<DT><PRE>public final class <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.30"><B>Axis</B></A><DT>extends java.lang.Object</DL>
</PRE>
<P>
Specifies values related to XPath Axes.
<p>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.</p>
<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&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#ALL">ALL</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A non-xpath axis, returns all nodes in the tree from and including the
root.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#ALLFROMNODE">ALLFROMNODE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A non-xpath axis, traversing the subtree including the subtree
root, descendants, attributes, and namespace node decls.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#ANCESTOR">ANCESTOR</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#ANCESTORORSELF">ANCESTORORSELF</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#ATTRIBUTE">ATTRIBUTE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the attribute axis contains the attributes of the context node; the axis
will be empty unless the context node is an element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#CHILD">CHILD</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The child axis contains the children of the context node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#DESCENDANT">DESCENDANT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#DESCENDANTORSELF">DESCENDANTORSELF</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The descendant-or-self axis contains the context node and the
descendants of the context node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#DESCENDANTSFROMROOT">DESCENDANTSFROMROOT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A non-xpath axis, returns all nodes that aren't namespaces or attributes,
from and including the root.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#DESCENDANTSORSELFFROMROOT">DESCENDANTSORSELFFROMROOT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A non-xpath axis, returns all nodes that aren't namespaces or attributes,
from and including the root.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#FILTEREDLIST">FILTEREDLIST</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A non-xpath axis, for functions.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#FOLLOWING">FOLLOWING</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#FOLLOWINGSIBLING">FOLLOWINGSIBLING</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static&nbsp;boolean[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#isReverse">isReverse</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A table to identify whether an axis is a reverse axis;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private static&nbsp;java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#names">names</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The names of the axes for diagnostic purposes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#NAMESPACE">NAMESPACE</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The namespace axis contains the namespace nodes of the context node; the
axis will be empty unless the context node is an element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#NAMESPACEDECLS">NAMESPACEDECLS</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The namespace axis contains the namespace nodes of the context node; the
axis will be empty unless the context node is an element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#PARENT">PARENT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The parent axis contains the parent of the context node,
if there is one.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#PRECEDING">PRECEDING</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#PRECEDINGANDANCESTOR">PRECEDINGANDANCESTOR</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A non-xpath axis, traversing the the preceding and the ancestor nodes,
needed for inverseing select patterns to match patterns.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#PRECEDINGSIBLING">PRECEDINGSIBLING</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#ROOT">ROOT</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A non-xpath axis, returns root only.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#SELF">SELF</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The self axis contains just the context node itself.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#Axis()">Axis</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#getNames(int)">getNames</A></B>(int&nbsp;index)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#getNamesLength()">getNamesLength</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/dtm/Axis.html#isReverse(int)">isReverse</A></B>(int&nbsp;axis)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<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.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<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 int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.39"><B>ANCESTOR</B></A></PRE>
<DL>
<DD>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.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.ANCESTOR">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ANCESTORORSELF"><!-- --></A><H3>
ANCESTORORSELF</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.46"><B>ANCESTORORSELF</B></A></PRE>
<DL>
<DD>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.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.ANCESTORORSELF">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ATTRIBUTE"><!-- --></A><H3>
ATTRIBUTE</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.52"><B>ATTRIBUTE</B></A></PRE>
<DL>
<DD>the attribute axis contains the attributes of the context node; the axis
will be empty unless the context node is an element.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.ATTRIBUTE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CHILD"><!-- --></A><H3>
CHILD</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.55"><B>CHILD</B></A></PRE>
<DL>
<DD>The child axis contains the children of the context node.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.CHILD">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DESCENDANT"><!-- --></A><H3>
DESCENDANT</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.62"><B>DESCENDANT</B></A></PRE>
<DL>
<DD>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.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.DESCENDANT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DESCENDANTORSELF"><!-- --></A><H3>
DESCENDANTORSELF</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.68"><B>DESCENDANTORSELF</B></A></PRE>
<DL>
<DD>The descendant-or-self axis contains the context node and the
descendants of the context node.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.DESCENDANTORSELF">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="FOLLOWING"><!-- --></A><H3>
FOLLOWING</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.75"><B>FOLLOWING</B></A></PRE>
<DL>
<DD>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.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.FOLLOWING">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="FOLLOWINGSIBLING"><!-- --></A><H3>
FOLLOWINGSIBLING</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.82"><B>FOLLOWINGSIBLING</B></A></PRE>
<DL>
<DD>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.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.FOLLOWINGSIBLING">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="NAMESPACEDECLS"><!-- --></A><H3>
NAMESPACEDECLS</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.88"><B>NAMESPACEDECLS</B></A></PRE>
<DL>
<DD>The namespace axis contains the namespace nodes of the context node; the
axis will be empty unless the context node is an element.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.NAMESPACEDECLS">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="NAMESPACE"><!-- --></A><H3>
NAMESPACE</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.94"><B>NAMESPACE</B></A></PRE>
<DL>
<DD>The namespace axis contains the namespace nodes of the context node; the
axis will be empty unless the context node is an element.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.NAMESPACE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PARENT"><!-- --></A><H3>
PARENT</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.100"><B>PARENT</B></A></PRE>
<DL>
<DD>The parent axis contains the parent of the context node,
if there is one.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.PARENT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PRECEDING"><!-- --></A><H3>
PRECEDING</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.107"><B>PRECEDING</B></A></PRE>
<DL>
<DD>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
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.PRECEDING">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PRECEDINGSIBLING"><!-- --></A><H3>
PRECEDINGSIBLING</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.114"><B>PRECEDINGSIBLING</B></A></PRE>
<DL>
<DD>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.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.PRECEDINGSIBLING">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SELF"><!-- --></A><H3>
SELF</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.117"><B>SELF</B></A></PRE>
<DL>
<DD>The self axis contains just the context node itself.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.SELF">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ALLFROMNODE"><!-- --></A><H3>
ALLFROMNODE</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.123"><B>ALLFROMNODE</B></A></PRE>
<DL>
<DD>A non-xpath axis, traversing the subtree including the subtree
root, descendants, attributes, and namespace node decls.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.ALLFROMNODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PRECEDINGANDANCESTOR"><!-- --></A><H3>
PRECEDINGANDANCESTOR</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.129"><B>PRECEDINGANDANCESTOR</B></A></PRE>
<DL>
<DD>A non-xpath axis, traversing the the preceding and the ancestor nodes,
needed for inverseing select patterns to match patterns.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.PRECEDINGANDANCESTOR">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ALL"><!-- --></A><H3>
ALL</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.138"><B>ALL</B></A></PRE>
<DL>
<DD>A non-xpath axis, returns all nodes in the tree from and including the
root.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.ALL">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DESCENDANTSFROMROOT"><!-- --></A><H3>
DESCENDANTSFROMROOT</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.144"><B>DESCENDANTSFROMROOT</B></A></PRE>
<DL>
<DD>A non-xpath axis, returns all nodes that aren't namespaces or attributes,
from and including the root.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.DESCENDANTSFROMROOT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DESCENDANTSORSELFFROMROOT"><!-- --></A><H3>
DESCENDANTSORSELFFROMROOT</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.150"><B>DESCENDANTSORSELFFROMROOT</B></A></PRE>
<DL>
<DD>A non-xpath axis, returns all nodes that aren't namespaces or attributes,
from and including the root.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.DESCENDANTSORSELFFROMROOT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ROOT"><!-- --></A><H3>
ROOT</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.155"><B>ROOT</B></A></PRE>
<DL>
<DD>A non-xpath axis, returns root only.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.ROOT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="FILTEREDLIST"><!-- --></A><H3>
FILTEREDLIST</H3>
<PRE>
public static final int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.160"><B>FILTEREDLIST</B></A></PRE>
<DL>
<DD>A non-xpath axis, for functions.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xml.dtm.Axis.FILTEREDLIST">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="isReverse"><!-- --></A><H3>
isReverse</H3>
<PRE>
private static final boolean[] <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.165"><B>isReverse</B></A></PRE>
<DL>
<DD>A table to identify whether an axis is a reverse axis;
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="names"><!-- --></A><H3>
names</H3>
<PRE>
private static final java.lang.String[] <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.183"><B>names</B></A></PRE>
<DL>
<DD>The names of the axes for diagnostic purposes.
<P>
<DL>
</DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="Axis()"><!-- --></A><H3>
Axis</H3>
<PRE>
public <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.30"><B>Axis</B></A>()</PRE>
<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="isReverse(int)"><!-- --></A><H3>
isReverse</H3>
<PRE>
public static boolean <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.208"><B>isReverse</B></A>(int&nbsp;axis)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getNames(int)"><!-- --></A><H3>
getNames</H3>
<PRE>
public static java.lang.String <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.212"><B>getNames</B></A>(int&nbsp;index)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getNamesLength()"><!-- --></A><H3>
getNamesLength</H3>
<PRE>
public static int <A HREF="../../../../src-html/org/apache/xml/dtm/Axis.html#line.216"><B>getNamesLength</B></A>()</PRE>
<DL>
<DD><DL>
</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Axis.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../org/apache/xml/dtm/DTM.html" title="interface in org.apache.xml.dtm"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/xml/dtm/Axis.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Axis.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>