<!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:38 GMT 2011 --> <TITLE> AxisIterator </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="AxisIterator"; } } </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/tree/iter/AtomizingIterator.html" title="class in net.sf.saxon.tree.iter"><B>PREV CLASS</B></A> <A HREF="../../../../../net/sf/saxon/tree/iter/AxisIteratorImpl.html" title="class in net.sf.saxon.tree.iter"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?net/sf/saxon/tree/iter/AxisIterator.html" target="_top"><B>FRAMES</B></A> <A HREF="AxisIterator.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | 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.tree.iter</FONT> <BR> Interface AxisIterator<T extends <A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A>></H2> <DL> <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../../net/sf/saxon/om/SequenceIterator.html" title="interface in net.sf.saxon.om">SequenceIterator</A><T>, <A HREF="../../../../../net/sf/saxon/tree/iter/UnfailingIterator.html" title="interface in net.sf.saxon.tree.iter">UnfailingIterator</A><T></DD> </DL> <DL> <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../net/sf/saxon/tree/iter/AxisIteratorImpl.html" title="class in net.sf.saxon.tree.iter">AxisIteratorImpl</A>, <A HREF="../../../../../net/sf/saxon/tree/iter/AxisIteratorOverSequence.html" title="class in net.sf.saxon.tree.iter">AxisIteratorOverSequence</A>, <A HREF="../../../../../net/sf/saxon/tree/iter/EmptyAxisIterator.html" title="class in net.sf.saxon.tree.iter">EmptyAxisIterator</A>, <A HREF="../../../../../net/sf/saxon/tree/util/Navigator.AncestorEnumeration.html" title="class in net.sf.saxon.tree.util">Navigator.AncestorEnumeration</A>, <A HREF="../../../../../net/sf/saxon/tree/util/Navigator.AxisFilter.html" title="class in net.sf.saxon.tree.util">Navigator.AxisFilter</A>, <A HREF="../../../../../net/sf/saxon/tree/util/Navigator.BaseEnumeration.html" title="class in net.sf.saxon.tree.util">Navigator.BaseEnumeration</A>, <A HREF="../../../../../net/sf/saxon/tree/util/Navigator.DescendantEnumeration.html" title="class in net.sf.saxon.tree.util">Navigator.DescendantEnumeration</A>, <A HREF="../../../../../net/sf/saxon/tree/util/Navigator.EmptyTextFilter.html" title="class in net.sf.saxon.tree.util">Navigator.EmptyTextFilter</A>, <A HREF="../../../../../net/sf/saxon/tree/util/Navigator.FollowingEnumeration.html" title="class in net.sf.saxon.tree.util">Navigator.FollowingEnumeration</A>, <A HREF="../../../../../net/sf/saxon/tree/util/Navigator.PrecedingEnumeration.html" title="class in net.sf.saxon.tree.util">Navigator.PrecedingEnumeration</A>, <A HREF="../../../../../net/sf/saxon/tree/iter/NodeWrappingAxisIterator.html" title="class in net.sf.saxon.tree.iter">NodeWrappingAxisIterator</A>, <A HREF="../../../../../net/sf/saxon/tree/iter/PrependIterator.html" title="class in net.sf.saxon.tree.iter">PrependIterator</A>, <A HREF="../../../../../net/sf/saxon/tree/iter/SingleNodeIterator.html" title="class in net.sf.saxon.tree.iter">SingleNodeIterator</A>, <A HREF="../../../../../net/sf/saxon/tree/wrapper/VirtualCopy.VirtualCopier.html" title="class in net.sf.saxon.tree.wrapper">VirtualCopy.VirtualCopier</A>, <A HREF="../../../../../net/sf/saxon/tree/wrapper/VirtualUntypedCopy.VirtualUntypedCopier.html" title="class in net.sf.saxon.tree.wrapper">VirtualUntypedCopy.VirtualUntypedCopier</A>, <A HREF="../../../../../net/sf/saxon/tree/wrapper/WrappingIterator.html" title="class in net.sf.saxon.tree.wrapper">WrappingIterator</A></DD> </DL> <HR> <DL> <DT><PRE>public interface <B>AxisIterator<T extends <A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A>></B><DT>extends <A HREF="../../../../../net/sf/saxon/tree/iter/UnfailingIterator.html" title="interface in net.sf.saxon.tree.iter">UnfailingIterator</A><T></DL> </PRE> <P> A SequenceIterator is used to iterate over a sequence. An AxisIterator is a SequenceIterator that throws no exceptions, and that always returns nodes. The nodes should all be in the same document (though there are some cases, such as PrependIterator, where this is the responsibility of the user of the class and is not enforced.) <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> </TABLE> <A NAME="fields_inherited_from_class_net.sf.saxon.om.SequenceIterator"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Fields inherited from interface net.sf.saxon.om.<A HREF="../../../../../net/sf/saxon/om/SequenceIterator.html" title="interface in net.sf.saxon.om">SequenceIterator</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../net/sf/saxon/om/SequenceIterator.html#GROUNDED">GROUNDED</A>, <A HREF="../../../../../net/sf/saxon/om/SequenceIterator.html#LAST_POSITION_FINDER">LAST_POSITION_FINDER</A>, <A HREF="../../../../../net/sf/saxon/om/SequenceIterator.html#LOOKAHEAD">LOOKAHEAD</A></CODE></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> <A HREF="../../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html#atomize()">atomize</A></B>()</CODE> <BR> Return the atomized value of the current node.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="type parameter in AxisIterator">T</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html#current()">current</A></B>()</CODE> <BR> Get the current item in the sequence.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="interface in net.sf.saxon.tree.iter">AxisIterator</A><<A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="type parameter in AxisIterator">T</A>></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html#getAnother()">getAnother</A></B>()</CODE> <BR> Get another iterator over the same sequence of items, positioned at the start of the sequence.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html#getStringValue()">getStringValue</A></B>()</CODE> <BR> Return the string value of the current node.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="interface in net.sf.saxon.tree.iter">AxisIterator</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html#iterateAxis(byte, net.sf.saxon.pattern.NodeTest)">iterateAxis</A></B>(byte axis, <A HREF="../../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A> test)</CODE> <BR> Return an iterator over an axis, starting at the current node.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> boolean</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html#moveNext()">moveNext</A></B>()</CODE> <BR> Move to the next node, without returning it.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="type parameter in AxisIterator">T</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html#next()">next</A></B>()</CODE> <BR> Get the next item in the sequence.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_net.sf.saxon.tree.iter.UnfailingIterator"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from interface net.sf.saxon.tree.iter.<A HREF="../../../../../net/sf/saxon/tree/iter/UnfailingIterator.html" title="interface in net.sf.saxon.tree.iter">UnfailingIterator</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../net/sf/saxon/tree/iter/UnfailingIterator.html#position()">position</A></CODE></TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_net.sf.saxon.om.SequenceIterator"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from interface net.sf.saxon.om.<A HREF="../../../../../net/sf/saxon/om/SequenceIterator.html" title="interface in net.sf.saxon.om">SequenceIterator</A></B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../../net/sf/saxon/om/SequenceIterator.html#close()">close</A>, <A HREF="../../../../../net/sf/saxon/om/SequenceIterator.html#getProperties()">getProperties</A></CODE></TD> </TR> </TABLE> <P> <!-- ============ 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="moveNext()"><!-- --></A><H3> moveNext</H3> <PRE> boolean <B>moveNext</B>()</PRE> <DL> <DD>Move to the next node, without returning it. Returns true if there is a next node, false if the end of the sequence has been reached. After calling this method, the current node may be retrieved using the current() function. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>true if there is a next node, false if the end of the sequence has been reached</DL> </DD> </DL> <HR> <A NAME="next()"><!-- --></A><H3> next</H3> <PRE> <A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="type parameter in AxisIterator">T</A> <B>next</B>()</PRE> <DL> <DD><B>Description copied from interface: <CODE><A HREF="../../../../../net/sf/saxon/tree/iter/UnfailingIterator.html#next()">UnfailingIterator</A></CODE></B></DD> <DD>Get the next item in the sequence. <BR> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/om/SequenceIterator.html#next()">next</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/om/SequenceIterator.html" title="interface in net.sf.saxon.om">SequenceIterator</A><<A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="type parameter in AxisIterator">T</A> extends <A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A>></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/tree/iter/UnfailingIterator.html#next()">next</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/tree/iter/UnfailingIterator.html" title="interface in net.sf.saxon.tree.iter">UnfailingIterator</A><<A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="type parameter in AxisIterator">T</A> extends <A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A>></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the next Item. If there are no more nodes, return null.</DL> </DD> </DL> <HR> <A NAME="current()"><!-- --></A><H3> current</H3> <PRE> <A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="type parameter in AxisIterator">T</A> <B>current</B>()</PRE> <DL> <DD><B>Description copied from interface: <CODE><A HREF="../../../../../net/sf/saxon/tree/iter/UnfailingIterator.html#current()">UnfailingIterator</A></CODE></B></DD> <DD>Get the current item in the sequence. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/om/SequenceIterator.html#current()">current</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/om/SequenceIterator.html" title="interface in net.sf.saxon.om">SequenceIterator</A><<A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="type parameter in AxisIterator">T</A> extends <A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A>></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/tree/iter/UnfailingIterator.html#current()">current</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/tree/iter/UnfailingIterator.html" title="interface in net.sf.saxon.tree.iter">UnfailingIterator</A><<A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="type parameter in AxisIterator">T</A> extends <A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A>></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the current item, that is, the item most recently returned by next()</DL> </DD> </DL> <HR> <A NAME="getAnother()"><!-- --></A><H3> getAnother</H3> <PRE> <A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="interface in net.sf.saxon.tree.iter">AxisIterator</A><<A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="type parameter in AxisIterator">T</A>> <B>getAnother</B>()</PRE> <DL> <DD><B>Description copied from interface: <CODE><A HREF="../../../../../net/sf/saxon/tree/iter/UnfailingIterator.html#getAnother()">UnfailingIterator</A></CODE></B></DD> <DD>Get another iterator over the same sequence of items, positioned at the start of the sequence. It must be possible to call this method at any time, whether none, some, or all of the items in the original iterator have been read. The method is non-destructive: it does not change the state of the original iterator. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/om/SequenceIterator.html#getAnother()">getAnother</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/om/SequenceIterator.html" title="interface in net.sf.saxon.om">SequenceIterator</A><<A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="type parameter in AxisIterator">T</A> extends <A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A>></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../net/sf/saxon/tree/iter/UnfailingIterator.html#getAnother()">getAnother</A></CODE> in interface <CODE><A HREF="../../../../../net/sf/saxon/tree/iter/UnfailingIterator.html" title="interface in net.sf.saxon.tree.iter">UnfailingIterator</A><<A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="type parameter in AxisIterator">T</A> extends <A HREF="../../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om">NodeInfo</A>></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>a new iterator over the same sequence</DL> </DD> </DL> <HR> <A NAME="iterateAxis(byte, net.sf.saxon.pattern.NodeTest)"><!-- --></A><H3> iterateAxis</H3> <PRE> <A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="interface in net.sf.saxon.tree.iter">AxisIterator</A> <B>iterateAxis</B>(byte axis, <A HREF="../../../../../net/sf/saxon/pattern/NodeTest.html" title="class in net.sf.saxon.pattern">NodeTest</A> test)</PRE> <DL> <DD>Return an iterator over an axis, starting at the current node. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>axis</CODE> - the axis to iterate over, using a constant such as <A HREF="../../../../../net/sf/saxon/om/Axis.html#CHILD"><CODE>Axis.CHILD</CODE></A><DD><CODE>test</CODE> - a predicate to apply to the nodes before returning them. <DT><B>Returns:</B><DD>an iterator over an axis, starting at the current node <DT><B>Throws:</B> <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if there is no current node</DL> </DD> </DL> <HR> <A NAME="atomize()"><!-- --></A><H3> atomize</H3> <PRE> <A HREF="../../../../../net/sf/saxon/value/Value.html" title="class in net.sf.saxon.value">Value</A> <B>atomize</B>() throws <A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></PRE> <DL> <DD>Return the atomized value of the current node. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the atomized value. <DT><B>Throws:</B> <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if there is no current node <DD><CODE><A HREF="../../../../../net/sf/saxon/trans/XPathException.html" title="class in net.sf.saxon.trans">XPathException</A></CODE> - if the current node cannot be atomized, for example because it is an element node with element-only content.</DL> </DD> </DL> <HR> <A NAME="getStringValue()"><!-- --></A><H3> getStringValue</H3> <PRE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A> <B>getStringValue</B>()</PRE> <DL> <DD>Return the string value of the current node. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the string value, as an instance of CharSequence. <DT><B>Throws:</B> <DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if there is no current node</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/tree/iter/AtomizingIterator.html" title="class in net.sf.saxon.tree.iter"><B>PREV CLASS</B></A> <A HREF="../../../../../net/sf/saxon/tree/iter/AxisIteratorImpl.html" title="class in net.sf.saxon.tree.iter"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html?net/sf/saxon/tree/iter/AxisIterator.html" target="_top"><B>FRAMES</B></A> <A HREF="AxisIterator.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | 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>