<!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:48 PDT 2012 --> | |
<TITLE> | |
org.apache.xpath.axes | |
</TITLE> | |
<META NAME="keywords" CONTENT="org.apache.xpath.axes package"> | |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
<SCRIPT type="text/javascript"> | |
function windowTitle() | |
{ | |
parent.document.title="org.apache.xpath.axes"; | |
} | |
</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> </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-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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="../../../../org/apache/xpath/package-summary.html"><B>PREV PACKAGE</B></A> | |
<A HREF="../../../../org/apache/xpath/compiler/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../index.html?org/apache/xpath/axes/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 org.apache.xpath.axes | |
</H2> | |
Implementation of XPath LocationPath support -- primary classes are | |
LocPathIterator and UnionPathIterator. | |
<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="../../../../org/apache/xpath/axes/ContextNodeList.html" title="interface in org.apache.xpath.axes">ContextNodeList</A></B></TD> | |
<TD>Classes who implement this interface can be a | |
<a href="http://www.w3.org/TR/xslt#dt-current-node-list">current node list</a>, | |
also refered to here as a <term>context node list</term>.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/PathComponent.html" title="interface in org.apache.xpath.axes">PathComponent</A></B></TD> | |
<TD>Classes who implement this information provide information needed for | |
static analysis of a path component.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/SubContextList.html" title="interface in org.apache.xpath.axes">SubContextList</A></B></TD> | |
<TD>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.</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="../../../../org/apache/xpath/axes/AttributeIterator.html" title="class in org.apache.xpath.axes">AttributeIterator</A></B></TD> | |
<TD>This class implements an optimized iterator for | |
attribute axes patterns.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/AxesWalker.html" title="class in org.apache.xpath.axes">AxesWalker</A></B></TD> | |
<TD>Serves as common interface for axes Walkers, and stores common | |
state variables.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/BasicTestIterator.html" title="class in org.apache.xpath.axes">BasicTestIterator</A></B></TD> | |
<TD>Base for iterators that handle predicates.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/ChildIterator.html" title="class in org.apache.xpath.axes">ChildIterator</A></B></TD> | |
<TD>This class implements an optimized iterator for | |
"node()" patterns, that is, any children of the | |
context node.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/ChildTestIterator.html" title="class in org.apache.xpath.axes">ChildTestIterator</A></B></TD> | |
<TD>This class implements an optimized iterator for | |
children patterns that have a node test, and possibly a predicate.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/DescendantIterator.html" title="class in org.apache.xpath.axes">DescendantIterator</A></B></TD> | |
<TD>This class implements an optimized iterator for | |
descendant, descendant-or-self, or "//foo" patterns.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/FilterExprIterator.html" title="class in org.apache.xpath.axes">FilterExprIterator</A></B></TD> | |
<TD> </TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/FilterExprIteratorSimple.html" title="class in org.apache.xpath.axes">FilterExprIteratorSimple</A></B></TD> | |
<TD>Class to use for one-step iteration that doesn't have a predicate, and | |
doesn't need to set the context.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/FilterExprWalker.html" title="class in org.apache.xpath.axes">FilterExprWalker</A></B></TD> | |
<TD>Walker for the OP_VARIABLE, or OP_EXTFUNCTION, or OP_FUNCTION, or OP_GROUP, | |
op codes.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/HasPositionalPredChecker.html" title="class in org.apache.xpath.axes">HasPositionalPredChecker</A></B></TD> | |
<TD> </TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/IteratorPool.html" title="class in org.apache.xpath.axes">IteratorPool</A></B></TD> | |
<TD>Pool of object of a given type to pick from to help memory usage</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/LocPathIterator.html" title="class in org.apache.xpath.axes">LocPathIterator</A></B></TD> | |
<TD>This class extends NodeSetDTM, which implements NodeIterator, | |
and fetches nodes one at a time in document order based on a XPath | |
<a href="http://www.w3.org/TR/xpath#NT-LocationPath>LocationPath</a>.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/MatchPatternIterator.html" title="class in org.apache.xpath.axes">MatchPatternIterator</A></B></TD> | |
<TD>This class treats a | |
<a href="http://www.w3.org/TR/xpath#location-paths">LocationPath</a> as a | |
filtered iteration over the tree, evaluating each node in a super axis | |
traversal against the LocationPath interpreted as a match pattern.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.html" title="class in org.apache.xpath.axes">NodeSequence</A></B></TD> | |
<TD>This class is the dynamic wrapper for a Xalan DTMIterator instance, and | |
provides random access capabilities.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/NodeSequence.IteratorCache.html" title="class in org.apache.xpath.axes">NodeSequence.IteratorCache</A></B></TD> | |
<TD>Each NodeSequence object has an iterator which is "walked".</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/OneStepIterator.html" title="class in org.apache.xpath.axes">OneStepIterator</A></B></TD> | |
<TD>This class implements a general iterator for | |
those LocationSteps with only one step, and perhaps a predicate.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/OneStepIteratorForward.html" title="class in org.apache.xpath.axes">OneStepIteratorForward</A></B></TD> | |
<TD>This class implements a general iterator for | |
those LocationSteps with only one step, and perhaps a predicate, | |
that only go forward (i.e.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/PredicatedNodeTest.html" title="class in org.apache.xpath.axes">PredicatedNodeTest</A></B></TD> | |
<TD> </TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/ReverseAxesWalker.html" title="class in org.apache.xpath.axes">ReverseAxesWalker</A></B></TD> | |
<TD>Walker for a reverse axes.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/RTFIterator.html" title="class in org.apache.xpath.axes">RTFIterator</A></B></TD> | |
<TD> </TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/SelfIteratorNoPredicate.html" title="class in org.apache.xpath.axes">SelfIteratorNoPredicate</A></B></TD> | |
<TD>This class implements an optimized iterator for | |
"." patterns, that is, the self axes without any predicates.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/UnionChildIterator.html" title="class in org.apache.xpath.axes">UnionChildIterator</A></B></TD> | |
<TD>This class defines a simplified type of union iterator that only | |
tests along the child axes.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/UnionPathIterator.html" title="class in org.apache.xpath.axes">UnionPathIterator</A></B></TD> | |
<TD>This class extends NodeSetDTM, which implements DTMIterator, | |
and fetches nodes one at a time in document order based on a XPath | |
<a href="http://www.w3.org/TR/xpath#NT-UnionExpr">UnionExpr</a>.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/WalkerFactory.html" title="class in org.apache.xpath.axes">WalkerFactory</A></B></TD> | |
<TD>This class is both a factory for XPath location path expressions, | |
which are built from the opcode map output, and an analysis engine | |
for the location path expressions in order to provide optimization hints.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/WalkingIterator.html" title="class in org.apache.xpath.axes">WalkingIterator</A></B></TD> | |
<TD>Location path iterator that uses Walkers.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/xpath/axes/WalkingIteratorSorted.html" title="class in org.apache.xpath.axes">WalkingIteratorSorted</A></B></TD> | |
<TD>This class iterates over set of nodes that needs to be sorted.</TD> | |
</TR> | |
</TABLE> | |
| |
<P> | |
<A NAME="package_description"><!-- --></A><H2> | |
Package org.apache.xpath.axes Description | |
</H2> | |
<P> | |
<p>Implementation of XPath LocationPath support -- primary classes are | |
LocPathIterator and UnionPathIterator.<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-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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="../../../../org/apache/xpath/package-summary.html"><B>PREV PACKAGE</B></A> | |
<A HREF="../../../../org/apache/xpath/compiler/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../index.html?org/apache/xpath/axes/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> | |
</BODY> | |
</HTML> |