<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Tue Sep 18 10:25:37 GMT+01:00 2001 -->
<TITLE>
: Class FilterEnumerator
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<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="../../../../com/icl/saxon/expr/ExpressionParser.html"><B>PREV CLASS</B></A>
<A HREF="../../../../com/icl/saxon/expr/FragmentValue.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="FilterEnumerator.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.icl.saxon.expr</FONT>
<BR>
Class FilterEnumerator</H2>
<PRE>
java.lang.Object
|
+--<B>com.icl.saxon.expr.FilterEnumerator</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html">NodeEnumeration</A></DD>
</DL>
<HR>
<DL>
<DT>public class <B>FilterEnumerator</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html">NodeEnumeration</A></DL>
<P>
A FilterEnumerator filters an input NodeEnumeration using a filter expression.
The complication is that on request, it must determine the value of the last() position,
which requires a lookahead.
<P>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/FilterEnumerator.html#FilterEnumerator(com.icl.saxon.om.NodeEnumeration, com.icl.saxon.expr.Expression, com.icl.saxon.Context, boolean)">FilterEnumerator</A></B>(<A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html">NodeEnumeration</A> base,
<A HREF="../../../../com/icl/saxon/expr/Expression.html">Expression</A> filter,
<A HREF="../../../../com/icl/saxon/Context.html">Context</A> context,
boolean finishAfterReject)</CODE>
<BR>
Constructor</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></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="../../../../com/icl/saxon/expr/FilterEnumerator.html#hasMoreElements()">hasMoreElements</A></B>()</CODE>
<BR>
Test whether there are any more nodes available in the enumeration</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="../../../../com/icl/saxon/expr/FilterEnumerator.html#isPeer()">isPeer</A></B>()</CODE>
<BR>
Determine whether the nodes are guaranteed to be peers</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="../../../../com/icl/saxon/expr/FilterEnumerator.html#isReverseSorted()">isReverseSorted</A></B>()</CODE>
<BR>
Determine whether the nodes returned by this enumeration are known to be in
reverse document order.</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="../../../../com/icl/saxon/expr/FilterEnumerator.html#isSorted()">isSorted</A></B>()</CODE>
<BR>
Determine whether the nodes are guaranteed to be in document order</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../com/icl/saxon/om/NodeInfo.html">NodeInfo</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/icl/saxon/expr/FilterEnumerator.html#nextElement()">nextElement</A></B>()</CODE>
<BR>
Get the next node if there is one</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="FilterEnumerator(com.icl.saxon.om.NodeEnumeration, com.icl.saxon.expr.Expression, com.icl.saxon.Context, boolean)"><!-- --></A><H3>
FilterEnumerator</H3>
<PRE>
public <B>FilterEnumerator</B>(<A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html">NodeEnumeration</A> base,
<A HREF="../../../../com/icl/saxon/expr/Expression.html">Expression</A> filter,
<A HREF="../../../../com/icl/saxon/Context.html">Context</A> context,
boolean finishAfterReject)
throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE>
<DL>
<DD>Constructor<DD><DL>
<DT><B>Parameters:</B><DD><CODE>base</CODE> - A node-set expression denoting the absolute or relative set of nodes from which the
navigation path should start.<DD><CODE>filter</CODE> - The expression defining the filter predicate<DD><CODE>context</CODE> - The context in which the expression is being evaluated<DD><CODE>finishAfterReject:</CODE> - terminate enumeration on first failure</DL>
</DD>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="hasMoreElements()"><!-- --></A><H3>
hasMoreElements</H3>
<PRE>
public boolean <B>hasMoreElements</B>()</PRE>
<DL>
<DD>Test whether there are any more nodes available in the enumeration<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html#hasMoreElements()">hasMoreElements</A></CODE> in interface <CODE><A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html">NodeEnumeration</A></CODE></DL>
</DD>
<DD>Following copied from interface: <CODE>com.icl.saxon.om.NodeEnumeration</CODE></DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if there are more nodes</DL>
</DD>
</DL>
<HR>
<A NAME="nextElement()"><!-- --></A><H3>
nextElement</H3>
<PRE>
public <A HREF="../../../../com/icl/saxon/om/NodeInfo.html">NodeInfo</A> <B>nextElement</B>()
throws <A HREF="../../../../com/icl/saxon/expr/XPathException.html">XPathException</A></PRE>
<DL>
<DD>Get the next node if there is one<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html#nextElement()">nextElement</A></CODE> in interface <CODE><A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html">NodeEnumeration</A></CODE></DL>
</DD>
<DD>Following copied from interface: <CODE>com.icl.saxon.om.NodeEnumeration</CODE></DD>
<DD><DL>
<DT><B>Returns:</B><DD>the next NodeInfo</DL>
</DD>
</DL>
<HR>
<A NAME="isSorted()"><!-- --></A><H3>
isSorted</H3>
<PRE>
public boolean <B>isSorted</B>()</PRE>
<DL>
<DD>Determine whether the nodes are guaranteed to be in document order<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html#isSorted()">isSorted</A></CODE> in interface <CODE><A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html">NodeEnumeration</A></CODE></DL>
</DD>
<DD>Following copied from interface: <CODE>com.icl.saxon.om.NodeEnumeration</CODE></DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if the nodes are guaranteed to be in document order.</DL>
</DD>
</DL>
<HR>
<A NAME="isReverseSorted()"><!-- --></A><H3>
isReverseSorted</H3>
<PRE>
public boolean <B>isReverseSorted</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html">NodeEnumeration</A></CODE></B></DD>
<DD>Determine whether the nodes returned by this enumeration are known to be in
reverse document order.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html#isReverseSorted()">isReverseSorted</A></CODE> in interface <CODE><A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html">NodeEnumeration</A></CODE></DL>
</DD>
<DD>Following copied from interface: <CODE>com.icl.saxon.om.NodeEnumeration</CODE></DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if the nodes are guaranteed to be in document order.</DL>
</DD>
</DL>
<HR>
<A NAME="isPeer()"><!-- --></A><H3>
isPeer</H3>
<PRE>
public boolean <B>isPeer</B>()</PRE>
<DL>
<DD>Determine whether the nodes are guaranteed to be peers<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html#isPeer()">isPeer</A></CODE> in interface <CODE><A HREF="../../../../com/icl/saxon/om/NodeEnumeration.html">NodeEnumeration</A></CODE></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<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="../../../../com/icl/saxon/expr/ExpressionParser.html"><B>PREV CLASS</B></A>
<A HREF="../../../../com/icl/saxon/expr/FragmentValue.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="FilterEnumerator.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>
