blob: dbfdbf600979f09fa957e157165e68be5310ad95 [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:27 PDT 2012 -->
<TITLE>
FilterIterator
</TITLE>
<META NAME="keywords" CONTENT="org.apache.xalan.xsltc.dom.FilterIterator class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="FilterIterator";
}
</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/FilterIterator.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;<A HREF="../../../../../org/apache/xalan/xsltc/dom/FilteredStepIterator.html" title="class in org.apache.xalan.xsltc.dom"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/xalan/xsltc/dom/ForwardPositionIterator.html" title="class in org.apache.xalan.xsltc.dom"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/xalan/xsltc/dom/FilterIterator.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="FilterIterator.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.xalan.xsltc.dom</FONT>
<BR>
Class FilterIterator</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html" title="class in org.apache.xml.dtm.ref">org.apache.xml.dtm.ref.DTMAxisIteratorBase</A>
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xalan.xsltc.dom.FilterIterator</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable, <A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public final class <A HREF="../../../../../src-html/org/apache/xalan/xsltc/dom/FilterIterator.html#line.38"><B>FilterIterator</B></A><DT>extends <A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html" title="class in org.apache.xml.dtm.ref">DTMAxisIteratorBase</A></DL>
</PRE>
<P>
Similar to a CurrentNodeListIterator except that the filter has a
simpler interface (only needs the node, no position, last, etc.)
It takes a source iterator and a Filter object and returns nodes
from the source after filtering them by calling filter.test(node).
<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>private &nbsp;<A HREF="../../../../../org/apache/xml/dtm/DTMFilter.html" title="interface in org.apache.xml.dtm">DTMFilter</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xalan/xsltc/dom/FilterIterator.html#_filter">_filter</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reference to a filter object that to be applied to each node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xalan/xsltc/dom/FilterIterator.html#_isReverse">_isReverse</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A flag indicating if position is reversed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;<A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xalan/xsltc/dom/FilterIterator.html#_source">_source</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reference to source iterator.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.apache.xml.dtm.ref.DTMAxisIteratorBase"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class org.apache.xml.dtm.ref.<A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html" title="class in org.apache.xml.dtm.ref">DTMAxisIteratorBase</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#_includeSelf">_includeSelf</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#_isRestartable">_isRestartable</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#_last">_last</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#_markedNode">_markedNode</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#_position">_position</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#_startNode">_startNode</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.apache.xml.dtm.DTMAxisIterator"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from interface org.apache.xml.dtm.<A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#END">END</A></CODE></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/xalan/xsltc/dom/FilterIterator.html#FilterIterator(org.apache.xml.dtm.DTMAxisIterator, org.apache.xml.dtm.DTMFilter)">FilterIterator</A></B>(<A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A>&nbsp;source,
<A HREF="../../../../../org/apache/xml/dtm/DTMFilter.html" title="interface in org.apache.xml.dtm">DTMFilter</A>&nbsp;filter)</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>&nbsp;<A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xalan/xsltc/dom/FilterIterator.html#cloneIterator()">cloneIterator</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a deep copy of this iterator.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xalan/xsltc/dom/FilterIterator.html#gotoMark()">gotoMark</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Restores the current node remembered by setMark().</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xalan/xsltc/dom/FilterIterator.html#isReverse()">isReverse</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>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xalan/xsltc/dom/FilterIterator.html#next()">next</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the next node in the iteration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xalan/xsltc/dom/FilterIterator.html#reset()">reset</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Resets the iterator to the last start node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xalan/xsltc/dom/FilterIterator.html#setMark()">setMark</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remembers the current node for the next call to gotoMark().</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xalan/xsltc/dom/FilterIterator.html#setRestartable(boolean)">setRestartable</A></B>(boolean&nbsp;isRestartable)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set if restartable.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xalan/xsltc/dom/FilterIterator.html#setStartNode(int)">setStartNode</A></B>(int&nbsp;node)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set start to END should 'close' the iterator,
i.e.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.xml.dtm.ref.DTMAxisIteratorBase"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.apache.xml.dtm.ref.<A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html" title="class in org.apache.xml.dtm.ref">DTMAxisIteratorBase</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#getAxis()">getAxis</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#getLast()">getLast</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#getNodeByPosition(int)">getNodeByPosition</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#getPosition()">getPosition</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#getStartNode()">getStartNode</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#includeSelf()">includeSelf</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#isDocOrdered()">isDocOrdered</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#resetPosition()">resetPosition</A>, <A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#returnNode(int)">returnNode</A></CODE></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="_source"><!-- --></A><H3>
_source</H3>
<PRE>
private <A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A> <A HREF="../../../../../src-html/org/apache/xalan/xsltc/dom/FilterIterator.html#line.43"><B>_source</B></A></PRE>
<DL>
<DD>Reference to source iterator.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="_filter"><!-- --></A><H3>
_filter</H3>
<PRE>
private final <A HREF="../../../../../org/apache/xml/dtm/DTMFilter.html" title="interface in org.apache.xml.dtm">DTMFilter</A> <A HREF="../../../../../src-html/org/apache/xalan/xsltc/dom/FilterIterator.html#line.48"><B>_filter</B></A></PRE>
<DL>
<DD>Reference to a filter object that to be applied to each node.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="_isReverse"><!-- --></A><H3>
_isReverse</H3>
<PRE>
private final boolean <A HREF="../../../../../src-html/org/apache/xalan/xsltc/dom/FilterIterator.html#line.53"><B>_isReverse</B></A></PRE>
<DL>
<DD>A flag indicating if position is reversed.
<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="FilterIterator(org.apache.xml.dtm.DTMAxisIterator, org.apache.xml.dtm.DTMFilter)"><!-- --></A><H3>
FilterIterator</H3>
<PRE>
public <A HREF="../../../../../src-html/org/apache/xalan/xsltc/dom/FilterIterator.html#line.55"><B>FilterIterator</B></A>(<A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A>&nbsp;source,
<A HREF="../../../../../org/apache/xml/dtm/DTMFilter.html" title="interface in org.apache.xml.dtm">DTMFilter</A>&nbsp;filter)</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()"><!-- --></A><H3>
isReverse</H3>
<PRE>
public boolean <A HREF="../../../../../src-html/org/apache/xalan/xsltc/dom/FilterIterator.html#line.62"><B>isReverse</B></A>()</PRE>
<DL>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#isReverse()">isReverse</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#isReverse()">isReverse</A></CODE> in class <CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html" title="class in org.apache.xml.dtm.ref">DTMAxisIteratorBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if this iterator has a reversed axis, else false</DL>
</DD>
</DL>
<HR>
<A NAME="setRestartable(boolean)"><!-- --></A><H3>
setRestartable</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xalan/xsltc/dom/FilterIterator.html#line.67"><B>setRestartable</B></A>(boolean&nbsp;isRestartable)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#setRestartable(boolean)">DTMAxisIterator</A></CODE></B></DD>
<DD>Set if restartable.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#setRestartable(boolean)">setRestartable</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#setRestartable(boolean)">setRestartable</A></CODE> in class <CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html" title="class in org.apache.xml.dtm.ref">DTMAxisIteratorBase</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="cloneIterator()"><!-- --></A><H3>
cloneIterator</H3>
<PRE>
public <A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A> <A HREF="../../../../../src-html/org/apache/xalan/xsltc/dom/FilterIterator.html#line.72"><B>cloneIterator</B></A>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#cloneIterator()">DTMAxisIteratorBase</A></CODE></B></DD>
<DD>Returns a deep copy of this iterator. Cloned iterators may not be
restartable. The iterator being cloned may or may not become
non-restartable as a side effect of this operation.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#cloneIterator()">cloneIterator</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#cloneIterator()">cloneIterator</A></CODE> in class <CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html" title="class in org.apache.xml.dtm.ref">DTMAxisIteratorBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a deep copy of this iterator.</DL>
</DD>
</DL>
<HR>
<A NAME="reset()"><!-- --></A><H3>
reset</H3>
<PRE>
public <A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A> <A HREF="../../../../../src-html/org/apache/xalan/xsltc/dom/FilterIterator.html#line.87"><B>reset</B></A>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#reset()">DTMAxisIterator</A></CODE></B></DD>
<DD>Resets the iterator to the last start node.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#reset()">reset</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html#reset()">reset</A></CODE> in class <CODE><A HREF="../../../../../org/apache/xml/dtm/ref/DTMAxisIteratorBase.html" title="class in org.apache.xml.dtm.ref">DTMAxisIteratorBase</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A DTMAxisIterator which has been reset to the start node,
which may or may not be the same as this iterator.</DL>
</DD>
</DL>
<HR>
<A NAME="next()"><!-- --></A><H3>
next</H3>
<PRE>
public int <A HREF="../../../../../src-html/org/apache/xalan/xsltc/dom/FilterIterator.html#line.92"><B>next</B></A>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#next()">DTMAxisIterator</A></CODE></B></DD>
<DD>Get the next node in the iteration.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The next node handle in the iteration, or END.</DL>
</DD>
</DL>
<HR>
<A NAME="setStartNode(int)"><!-- --></A><H3>
setStartNode</H3>
<PRE>
public <A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html" title="interface in org.apache.xml.dtm">DTMAxisIterator</A> <A HREF="../../../../../src-html/org/apache/xalan/xsltc/dom/FilterIterator.html#line.102"><B>setStartNode</B></A>(int&nbsp;node)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#setStartNode(int)">DTMAxisIterator</A></CODE></B></DD>
<DD>Set start to END should 'close' the iterator,
i.e. subsequent call to next() should return END.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - Sets the root of the iteration.
<DT><B>Returns:</B><DD>A DTMAxisIterator set to the start of the iteration.</DL>
</DD>
</DL>
<HR>
<A NAME="setMark()"><!-- --></A><H3>
setMark</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xalan/xsltc/dom/FilterIterator.html#line.110"><B>setMark</B></A>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#setMark()">DTMAxisIterator</A></CODE></B></DD>
<DD>Remembers the current node for the next call to gotoMark().
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="gotoMark()"><!-- --></A><H3>
gotoMark</H3>
<PRE>
public void <A HREF="../../../../../src-html/org/apache/xalan/xsltc/dom/FilterIterator.html#line.114"><B>gotoMark</B></A>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/xml/dtm/DTMAxisIterator.html#gotoMark()">DTMAxisIterator</A></CODE></B></DD>
<DD>Restores the current node remembered by setMark().
<P>
<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/FilterIterator.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;<A HREF="../../../../../org/apache/xalan/xsltc/dom/FilteredStepIterator.html" title="class in org.apache.xalan.xsltc.dom"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/xalan/xsltc/dom/ForwardPositionIterator.html" title="class in org.apache.xalan.xsltc.dom"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/apache/xalan/xsltc/dom/FilterIterator.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="FilterIterator.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>