blob: 65663892960ecc148a76271c7ec5fde8b016d934 [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:40 PDT 2012 -->
<TITLE>
SubContextList
</TITLE>
<META NAME="keywords" CONTENT="org.apache.xpath.axes.SubContextList interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="SubContextList";
}
</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/SubContextList.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/xpath/axes/SelfIteratorNoPredicate.html" title="class in org.apache.xpath.axes"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/xpath/axes/UnionChildIterator.html" title="class in org.apache.xpath.axes"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/xpath/axes/SubContextList.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="SubContextList.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;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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.xpath.axes</FONT>
<BR>
Interface SubContextList</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/xpath/axes/AttributeIterator.html" title="class in org.apache.xpath.axes">AttributeIterator</A>, <A HREF="../../../../org/apache/xpath/axes/AxesWalker.html" title="class in org.apache.xpath.axes">AxesWalker</A>, <A HREF="../../../../org/apache/xpath/axes/BasicTestIterator.html" title="class in org.apache.xpath.axes">BasicTestIterator</A>, <A HREF="../../../../org/apache/xpath/axes/ChildIterator.html" title="class in org.apache.xpath.axes">ChildIterator</A>, <A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html" title="class in org.apache.xpath.axes">ChildTestIterator</A>, <A HREF="../../../../org/apache/xpath/patterns/ContextMatchStepPattern.html" title="class in org.apache.xpath.patterns">ContextMatchStepPattern</A>, <A HREF="../../../../org/apache/xpath/axes/DescendantIterator.html" title="class in org.apache.xpath.axes">DescendantIterator</A>, <A HREF="../../../../org/apache/xpath/axes/FilterExprIterator.html" title="class in org.apache.xpath.axes">FilterExprIterator</A>, <A HREF="../../../../org/apache/xpath/axes/FilterExprIteratorSimple.html" title="class in org.apache.xpath.axes">FilterExprIteratorSimple</A>, <A HREF="../../../../org/apache/xpath/axes/FilterExprWalker.html" title="class in org.apache.xpath.axes">FilterExprWalker</A>, <A HREF="../../../../org/apache/xpath/patterns/FunctionPattern.html" title="class in org.apache.xpath.patterns">FunctionPattern</A>, <A HREF="../../../../org/apache/xalan/transformer/KeyIterator.html" title="class in org.apache.xalan.transformer">KeyIterator</A>, <A HREF="../../../../org/apache/xalan/transformer/KeyRefIterator.html" title="class in org.apache.xalan.transformer">KeyRefIterator</A>, <A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html" title="class in org.apache.xpath.axes">LocPathIterator</A>, <A HREF="../../../../org/apache/xpath/axes/MatchPatternIterator.html" title="class in org.apache.xpath.axes">MatchPatternIterator</A>, <A HREF="../../../../org/apache/xpath/axes/OneStepIterator.html" title="class in org.apache.xpath.axes">OneStepIterator</A>, <A HREF="../../../../org/apache/xpath/axes/OneStepIteratorForward.html" title="class in org.apache.xpath.axes">OneStepIteratorForward</A>, <A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html" title="class in org.apache.xpath.axes">PredicatedNodeTest</A>, <A HREF="../../../../org/apache/xpath/axes/ReverseAxesWalker.html" title="class in org.apache.xpath.axes">ReverseAxesWalker</A>, <A HREF="../../../../org/apache/xpath/axes/SelfIteratorNoPredicate.html" title="class in org.apache.xpath.axes">SelfIteratorNoPredicate</A>, <A HREF="../../../../org/apache/xpath/patterns/StepPattern.html" title="class in org.apache.xpath.patterns">StepPattern</A>, <A HREF="../../../../org/apache/xpath/axes/UnionChildIterator.html" title="class in org.apache.xpath.axes">UnionChildIterator</A>, <A HREF="../../../../org/apache/xpath/axes/UnionPathIterator.html" title="class in org.apache.xpath.axes">UnionPathIterator</A>, <A HREF="../../../../org/apache/xpath/axes/WalkingIterator.html" title="class in org.apache.xpath.axes">WalkingIterator</A>, <A HREF="../../../../org/apache/xpath/axes/WalkingIteratorSorted.html" title="class in org.apache.xpath.axes">WalkingIteratorSorted</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <A HREF="../../../../src-html/org/apache/xpath/axes/SubContextList.html#line.30"><B>SubContextList</B></A></DL>
</PRE>
<P>
A class that implements this interface is a sub context node list, meaning it
is a node list for a location path step for a predicate.
<P>
<P>
<HR>
<P>
<!-- ========== 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;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/axes/SubContextList.html#getLastPos(org.apache.xpath.XPathContext)">getLastPos</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the number of nodes in the node list, which, in the XSLT 1 based
counting system, is the last index position.</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/xpath/axes/SubContextList.html#getProximityPosition(org.apache.xpath.XPathContext)">getProximityPosition</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the current sub-context position.</TD>
</TR>
</TABLE>
&nbsp;
<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="getLastPos(org.apache.xpath.XPathContext)"><!-- --></A><H3>
getLastPos</H3>
<PRE>
int <A HREF="../../../../src-html/org/apache/xpath/axes/SubContextList.html#line.42"><B>getLastPos</B></A>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt)</PRE>
<DL>
<DD>Get the number of nodes in the node list, which, in the XSLT 1 based
counting system, is the last index position.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.
<DT><B>Returns:</B><DD>the number of nodes in the node list.</DL>
</DD>
</DL>
<HR>
<A NAME="getProximityPosition(org.apache.xpath.XPathContext)"><!-- --></A><H3>
getProximityPosition</H3>
<PRE>
int <A HREF="../../../../src-html/org/apache/xpath/axes/SubContextList.html#line.51"><B>getProximityPosition</B></A>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt)</PRE>
<DL>
<DD>Get the current sub-context position.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.
<DT><B>Returns:</B><DD>The position of the current node in the list.</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/SubContextList.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/xpath/axes/SelfIteratorNoPredicate.html" title="class in org.apache.xpath.axes"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/xpath/axes/UnionChildIterator.html" title="class in org.apache.xpath.axes"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/xpath/axes/SubContextList.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="SubContextList.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;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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>