<!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:52 GMT 2011 -->
<TITLE>
net.sf.saxon.tree.iter
</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="net.sf.saxon.tree.iter";
}
}
</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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</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/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../../net/sf/saxon/tree/linked/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?net/sf/saxon/tree/iter/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.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>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<H2>
Package net.sf.saxon.tree.iter
</H2>
This package defines implementations and subinterfaces of the interface SequenceIterator, which is
used to iterate over an XDM sequence.
<P>
<B>See:</B>
<BR>
<A HREF="#package_description"><B>Description</B></A>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Interface Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/AxisIterator.html" title="interface in net.sf.saxon.tree.iter">AxisIterator<T extends NodeInfo></A></B></TD>
<TD>A SequenceIterator is used to iterate over a sequence.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/GroundedIterator.html" title="interface in net.sf.saxon.tree.iter">GroundedIterator<T extends Item></A></B></TD>
<TD>This interface is an extension to the SequenceIterator interface; it represents
a SequenceIterator that is based on an in-memory representation of a sequence,
and that is therefore capable of returned a SequenceValue containing all the items
in the sequence.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/LookaheadIterator.html" title="interface in net.sf.saxon.tree.iter">LookaheadIterator<T extends Item></A></B></TD>
<TD>A SequenceIterator is used to iterate over a sequence.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/NodeWrappingFunction.html" title="interface in net.sf.saxon.tree.iter">NodeWrappingFunction<B,T extends NodeInfo></A></B></TD>
<TD>Interface to a function that wraps nodes from an external object model in a Saxon NodeInfo
representation</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/ReversibleIterator.html" title="interface in net.sf.saxon.tree.iter">ReversibleIterator<T extends Item></A></B></TD>
<TD>A ReversibleIterator is an interface implemented by any SequenceIterator that is
able to deliver items in reverse order (or to supply another iterator that can
do so).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/UnfailingIterator.html" title="interface in net.sf.saxon.tree.iter">UnfailingIterator<T extends Item></A></B></TD>
<TD>A SequenceIterator is used to iterate over a sequence.</TD>
</TR>
</TABLE>
<P>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/AdjacentTextNodeMergingIterator.html" title="class in net.sf.saxon.tree.iter">AdjacentTextNodeMergingIterator</A></B></TD>
<TD>AdjacentTextNodeMergingIterator is an iterator that eliminates zero-length text nodes
and merges adjacent text nodes from the underlying iterator</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/ArrayIterator.html" title="class in net.sf.saxon.tree.iter">ArrayIterator<T extends Item></A></B></TD>
<TD>ArrayIterator is used to enumerate items held in an array.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/AtomizingIterator.html" title="class in net.sf.saxon.tree.iter">AtomizingIterator</A></B></TD>
<TD>AtomizingIterator returns the atomization of an underlying sequence supplied
as an iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/AxisIteratorImpl.html" title="class in net.sf.saxon.tree.iter">AxisIteratorImpl</A></B></TD>
<TD>A SequenceIterator is used to iterate over a sequence.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/AxisIteratorOverSequence.html" title="class in net.sf.saxon.tree.iter">AxisIteratorOverSequence<T extends NodeInfo></A></B></TD>
<TD>This class wraps any SequenceIterator as an AxisIterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/EmptyAxisIterator.html" title="class in net.sf.saxon.tree.iter">EmptyAxisIterator<T extends NodeInfo></A></B></TD>
<TD>An AxisIterator over an empty sequence</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/EmptyIterator.html" title="class in net.sf.saxon.tree.iter">EmptyIterator<T extends Item></A></B></TD>
<TD>EmptyIterator: an iterator over an empty sequence.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/HomogeneityCheckerIterator.html" title="class in net.sf.saxon.tree.iter">HomogeneityCheckerIterator</A></B></TD>
<TD>An iterator that returns the same items as its base iterator, checking to see that they are either
all nodes, or all non-nodes; if they are all nodes, it delivers them in document order.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/IteratorIterator.html" title="class in net.sf.saxon.tree.iter">IteratorIterator<T extends Item></A></B></TD>
<TD>A SequenceIterator that wraps a Java Iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/ListIterator.html" title="class in net.sf.saxon.tree.iter">ListIterator<T extends Item></A></B></TD>
<TD>Class ListIterator, iterates over a sequence of items held in a Java List</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/LookaheadIteratorImpl.html" title="class in net.sf.saxon.tree.iter">LookaheadIteratorImpl</A></B></TD>
<TD>This class wraps any sequence iterator, turning it into a lookahead iterator,
by looking ahead one item</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/NodeWrappingAxisIterator.html" title="class in net.sf.saxon.tree.iter">NodeWrappingAxisIterator<T extends NodeInfo,B></A></B></TD>
<TD>An AxisIterator that wraps a Java Iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/PrependIterator.html" title="class in net.sf.saxon.tree.iter">PrependIterator</A></B></TD>
<TD>An iterator over nodes, that prepends a given node to the nodes
returned by another iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/ReverseArrayIterator.html" title="class in net.sf.saxon.tree.iter">ReverseArrayIterator<T extends Item></A></B></TD>
<TD>ReverseArrayIterator is used to enumerate items held in an array in reverse order.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/SingleNodeIterator.html" title="class in net.sf.saxon.tree.iter">SingleNodeIterator</A></B></TD>
<TD>SingletonIterator: an iterator over a sequence of zero or one values</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/SingletonIterator.html" title="class in net.sf.saxon.tree.iter">SingletonIterator<T extends Item></A></B></TD>
<TD>SingletonIterator: an iterator over a sequence of zero or one values</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/UnparsedTextIterator.html" title="class in net.sf.saxon.tree.iter">UnparsedTextIterator</A></B></TD>
<TD>Class UnparsedTextIterator, iterates over a file line by line</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../net/sf/saxon/tree/iter/UntypedAtomizingIterator.html" title="class in net.sf.saxon.tree.iter">UntypedAtomizingIterator<B extends Item></A></B></TD>
<TD>AtomizingIterator returns the atomization of an underlying sequence supplied
as an iterator.</TD>
</TR>
</TABLE>
<P>
<A NAME="package_description"><!-- --></A><H2>
Package net.sf.saxon.tree.iter Description
</H2>
<P>
<p>This package defines implementations and subinterfaces of the interface SequenceIterator, which is
used to iterate over an XDM sequence.</p>
<p>The subinterfaces mostly represent iterators with additional capability: for example a LastPositionFinder
can determine the number of items in the sequence without reading to the end; a GroundedIterator can deliver
the original sequence as a list in memory; a LookaheadIterator is capable of one-item look-ahead. Note
that just because a class implements such an interface does not mean it necessarily has this capability;
it is necessary to check the properties of the specific iterator before assuming this.</p>
<p align="center"><i>Michael H. Kay<br/>
Saxonica Limited<br/>
28 November 2011</i></p>
<P>
<P>
<DL>
</DL>
<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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</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/package-summary.html"><B>PREV PACKAGE</B></A>
<A HREF="../../../../../net/sf/saxon/tree/linked/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?net/sf/saxon/tree/iter/package-summary.html" target="_top"><B>FRAMES</B></A>
<A HREF="package-summary.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>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
