blob: 1b5feb289948b3172501bd060a2f68742f5a5e7d [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Thu Nov 22 17:12:56 EST 2007 -->
<TITLE>
Xalan-Java 2.7.1: Class MultiValuedNodeHeapIterator.HeapNode
</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>&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/MultiValuedNodeHeapIterator.HeapNode.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/MultiValuedNodeHeapIterator.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/xalan/xsltc/dom/NodeCounter.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> &nbsp;
&nbsp;<A HREF="MultiValuedNodeHeapIterator.HeapNode.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&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;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.xalan.xsltc.dom</FONT>
<BR>
Class MultiValuedNodeHeapIterator.HeapNode</H2>
<PRE>
java.lang.Object
|
+--<B>org.apache.xalan.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode</B>
</PRE>
<HR>
<DL>
<DT>public abstract class <B>MultiValuedNodeHeapIterator.HeapNode</B><DT>extends java.lang.Object<DT>implements java.lang.Cloneable</DL>
<P>
An abstract representation of a set of nodes that will be retrieved in
document order.
<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="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html#MultiValuedNodeHeapIterator.HeapNode(org.apache.xalan.xsltc.dom.MultiValuedNodeHeapIterator)">MultiValuedNodeHeapIterator.HeapNode</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" 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>&nbsp;<A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html">MultiValuedNodeHeapIterator.HeapNode</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html#cloneHeapNode()">cloneHeapNode</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a deep copy of this <CODE>HeapNode</CODE>.</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/MultiValuedNodeHeapIterator.HeapNode.html#gotoMark()">gotoMark</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Restores the current node remembered by <A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html#setMark()"><CODE>setMark()</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html#isLessThan(org.apache.xalan.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode)">isLessThan</A></B>(<A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html">MultiValuedNodeHeapIterator.HeapNode</A>&nbsp;heapNode)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs a comparison of the two heap nodes</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract &nbsp;<A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html">MultiValuedNodeHeapIterator.HeapNode</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html#reset()">reset</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reset the heap node back to its beginning.</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/MultiValuedNodeHeapIterator.HeapNode.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 <A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html#gotoMark()"><CODE>gotoMark()</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract &nbsp;<A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html">MultiValuedNodeHeapIterator.HeapNode</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html#setStartNode(int)">setStartNode</A></B>(int&nbsp;node)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets context with respect to which this heap node is evaluated.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>abstract &nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html#step()">step</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Advance to the next node represented by this <CODE>HeapNode</CODE></TD>
</TR>
</TABLE>
&nbsp;<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>equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<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="MultiValuedNodeHeapIterator.HeapNode(org.apache.xalan.xsltc.dom.MultiValuedNodeHeapIterator)"><!-- --></A><H3>
MultiValuedNodeHeapIterator.HeapNode</H3>
<PRE>
public <B>MultiValuedNodeHeapIterator.HeapNode</B>()</PRE>
<DL>
</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="step()"><!-- --></A><H3>
step</H3>
<PRE>
public abstract int <B>step</B>()</PRE>
<DL>
<DD>Advance to the next node represented by this <CODE>HeapNode</CODE><DD><DL>
<DT><B>Returns:</B><DD>the next DTM node.</DL>
</DD>
</DL>
<HR>
<A NAME="cloneHeapNode()"><!-- --></A><H3>
cloneHeapNode</H3>
<PRE>
public <A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html">MultiValuedNodeHeapIterator.HeapNode</A> <B>cloneHeapNode</B>()</PRE>
<DL>
<DD>Creates a deep copy of this <CODE>HeapNode</CODE>. The clone is not
reset from the current position of the original.<DD><DL>
<DT><B>Returns:</B><DD>the cloned heap node</DL>
</DD>
</DL>
<HR>
<A NAME="setMark()"><!-- --></A><H3>
setMark</H3>
<PRE>
public void <B>setMark</B>()</PRE>
<DL>
<DD>Remembers the current node for the next call to <A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html#gotoMark()"><CODE>gotoMark()</CODE></A>.<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="gotoMark()"><!-- --></A><H3>
gotoMark</H3>
<PRE>
public void <B>gotoMark</B>()</PRE>
<DL>
<DD>Restores the current node remembered by <A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html#setMark()"><CODE>setMark()</CODE></A>.<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isLessThan(org.apache.xalan.xsltc.dom.MultiValuedNodeHeapIterator.HeapNode)"><!-- --></A><H3>
isLessThan</H3>
<PRE>
public abstract boolean <B>isLessThan</B>(<A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html">MultiValuedNodeHeapIterator.HeapNode</A>&nbsp;heapNode)</PRE>
<DL>
<DD>Performs a comparison of the two heap nodes<DD><DL>
<DT><B>Parameters:</B><DD><CODE>heapNode</CODE> - the heap node against which to compare<DT><B>Returns:</B><DD><code>true</code> if and only if the current node for this
heap node is before the current node of the argument heap
node in document order.</DL>
</DD>
</DL>
<HR>
<A NAME="setStartNode(int)"><!-- --></A><H3>
setStartNode</H3>
<PRE>
public abstract <A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html">MultiValuedNodeHeapIterator.HeapNode</A> <B>setStartNode</B>(int&nbsp;node)</PRE>
<DL>
<DD>Sets context with respect to which this heap node is evaluated.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - The new context node<DT><B>Returns:</B><DD>a <CODE>HeapNode</CODE> which may or may not be the same as
this <code>HeapNode</code>.</DL>
</DD>
</DL>
<HR>
<A NAME="reset()"><!-- --></A><H3>
reset</H3>
<PRE>
public abstract <A HREF="../../../../../org/apache/xalan/xsltc/dom/MultiValuedNodeHeapIterator.HeapNode.html">MultiValuedNodeHeapIterator.HeapNode</A> <B>reset</B>()</PRE>
<DL>
<DD>Reset the heap node back to its beginning.<DD><DL>
<DT><B>Returns:</B><DD>a <CODE>HeapNode</CODE> which may or may not be the same as
this <code>HeapNode</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>&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/MultiValuedNodeHeapIterator.HeapNode.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/MultiValuedNodeHeapIterator.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/xalan/xsltc/dom/NodeCounter.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> &nbsp;
&nbsp;<A HREF="MultiValuedNodeHeapIterator.HeapNode.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&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;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
Copyright © 2006 Apache XML Project. All Rights Reserved.
</BODY>
</HTML>