blob: ade07620c550f0e73ee1eeb497b7857fee86d87b [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:45 PDT 2012 -->
<TITLE>
StepPattern
</TITLE>
<META NAME="keywords" CONTENT="org.apache.xpath.patterns.StepPattern class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="StepPattern";
}
</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/StepPattern.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/patterns/NodeTestFilter.html" title="interface in org.apache.xpath.patterns"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/xpath/patterns/StepPattern.PredOwner.html" title="class in org.apache.xpath.patterns"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/xpath/patterns/StepPattern.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="StepPattern.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;<A HREF="#nested_class_summary">NESTED</A>&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.xpath.patterns</FONT>
<BR>
Class StepPattern</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">org.apache.xpath.Expression</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html" title="class in org.apache.xpath.patterns">org.apache.xpath.patterns.NodeTest</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xpath.patterns.StepPattern</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, javax.xml.transform.SourceLocator, <A HREF="../../../../org/apache/xpath/axes/SubContextList.html" title="interface in org.apache.xpath.axes">SubContextList</A>, <A HREF="../../../../org/apache/xpath/ExpressionNode.html" title="interface in org.apache.xpath">ExpressionNode</A>, <A HREF="../../../../org/apache/xpath/ExpressionOwner.html" title="interface in org.apache.xpath">ExpressionOwner</A>, <A HREF="../../../../org/apache/xpath/XPathVisitable.html" title="interface in org.apache.xpath">XPathVisitable</A></DD>
</DL>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/xpath/patterns/ContextMatchStepPattern.html" title="class in org.apache.xpath.patterns">ContextMatchStepPattern</A>, <A HREF="../../../../org/apache/xpath/patterns/FunctionPattern.html" title="class in org.apache.xpath.patterns">FunctionPattern</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.39"><B>StepPattern</B></A><DT>extends <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html" title="class in org.apache.xpath.patterns">NodeTest</A><DT>implements <A HREF="../../../../org/apache/xpath/axes/SubContextList.html" title="interface in org.apache.xpath.axes">SubContextList</A>, <A HREF="../../../../org/apache/xpath/ExpressionOwner.html" title="interface in org.apache.xpath">ExpressionOwner</A></DL>
</PRE>
<P>
This class represents a single pattern match step.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.xpath.patterns.StepPattern">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) &nbsp;class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.PredOwner.html" title="class in org.apache.xpath.patterns">StepPattern.PredOwner</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<!-- =========== 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 static&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#DEBUG_MATCHES">DEBUG_MATCHES</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set to true to send diagnostics about pattern matches to the consol.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#m_axis">m_axis</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The axis for this test.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) &nbsp;<A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#m_predicates">m_predicates</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The list of predicate expressions for this pattern step.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) &nbsp;<A HREF="../../../../org/apache/xpath/patterns/StepPattern.html" title="class in org.apache.xpath.patterns">StepPattern</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#m_relativePathPattern">m_relativePathPattern</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reference to nodetest and predicate for
parent or ancestor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) &nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#m_targetString">m_targetString</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The target local name or psuedo name, for hash table lookup optimization.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>(package private) static&nbsp;long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#serialVersionUID">serialVersionUID</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.apache.xpath.patterns.NodeTest"><!-- --></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.xpath.patterns.<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html" title="class in org.apache.xpath.patterns">NodeTest</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#m_name">m_name</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#m_namespace">m_namespace</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#m_score">m_score</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#m_whatToShow">m_whatToShow</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NODETEST">SCORE_NODETEST</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NONE">SCORE_NONE</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NSWILD">SCORE_NSWILD</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_OTHER">SCORE_OTHER</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_QNAME">SCORE_QNAME</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SHOW_BYFUNCTION">SHOW_BYFUNCTION</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SUPPORTS_PRE_STRIPPING">SUPPORTS_PRE_STRIPPING</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#WILD">WILD</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/xpath/patterns/StepPattern.html#StepPattern(int, int, int)">StepPattern</A></B>(int&nbsp;whatToShow,
int&nbsp;axis,
int&nbsp;axisForPredicate)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a StepPattern that doesn't test for node names.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#StepPattern(int, java.lang.String, java.lang.String, int, int)">StepPattern</A></B>(int&nbsp;whatToShow,
java.lang.String&nbsp;namespace,
java.lang.String&nbsp;name,
int&nbsp;axis,
int&nbsp;axisForPredicate)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a StepPattern that tests for namespaces and node names.</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;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#calcScore()">calcScore</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Static calc of match score.</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/xpath/patterns/StepPattern.html#calcTargetString()">calcTargetString</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Calculate the local name or psuedo name of the node that this pattern will test,
for hash table lookup optimization.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#callSubtreeVisitors(org.apache.xpath.XPathVisitor)">callSubtreeVisitors</A></B>(<A HREF="../../../../org/apache/xpath/XPathVisitor.html" title="class in org.apache.xpath">XPathVisitor</A>&nbsp;visitor)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Call the visitors on the subtree.</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/xpath/patterns/StepPattern.html#callVisitors(org.apache.xpath.ExpressionOwner, org.apache.xpath.XPathVisitor)">callVisitors</A></B>(<A HREF="../../../../org/apache/xpath/ExpressionOwner.html" title="interface in org.apache.xpath">ExpressionOwner</A>&nbsp;owner,
<A HREF="../../../../org/apache/xpath/XPathVisitor.html" title="class in org.apache.xpath">XPathVisitor</A>&nbsp;visitor)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This will traverse the heararchy, calling the visitor for
each member.</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/xpath/patterns/StepPattern.html#canTraverseOutsideSubtree()">canTraverseOutsideSubtree</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tell if this expression or it's subexpressions can traverse outside
the current subtree.</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/xpath/patterns/StepPattern.html#checkProximityPosition(org.apache.xpath.XPathContext, int, org.apache.xml.dtm.DTM, int, int)">checkProximityPosition</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt,
int&nbsp;predPos,
<A HREF="../../../../org/apache/xml/dtm/DTM.html" title="interface in org.apache.xml.dtm">DTM</A>&nbsp;dtm,
int&nbsp;context,
int&nbsp;pos)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;New Method to check whether the current node satisfies a position predicate</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/xpath/patterns/StepPattern.html#deepEquals(org.apache.xpath.Expression)">deepEquals</A></B>(<A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A>&nbsp;expr)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compare this object with another object and see
if they are equal, include the sub heararchy.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#execute(org.apache.xpath.XPathContext)">execute</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;Execute this pattern step, including predicates.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#execute(org.apache.xpath.XPathContext, int)">execute</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt,
int&nbsp;currentNode)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Execute this pattern step, including predicates.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#execute(org.apache.xpath.XPathContext, int, org.apache.xml.dtm.DTM, int)">execute</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt,
int&nbsp;currentNode,
<A HREF="../../../../org/apache/xml/dtm/DTM.html" title="interface in org.apache.xml.dtm">DTM</A>&nbsp;dtm,
int&nbsp;expType)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Execute an expression in the XPath runtime context, and return the
result of the expression.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#executePredicates(org.apache.xpath.XPathContext, org.apache.xml.dtm.DTM, int)">executePredicates</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt,
<A HREF="../../../../org/apache/xml/dtm/DTM.html" title="interface in org.apache.xml.dtm">DTM</A>&nbsp;dtm,
int&nbsp;currentNode)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Execute the predicates on this step to determine if the current node
should be filtered or accepted.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;<A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#executeRelativePathPattern(org.apache.xpath.XPathContext, org.apache.xml.dtm.DTM, int)">executeRelativePathPattern</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt,
<A HREF="../../../../org/apache/xml/dtm/DTM.html" title="interface in org.apache.xml.dtm">DTM</A>&nbsp;dtm,
int&nbsp;currentNode)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Execute the match pattern step relative to another step.</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/xpath/patterns/StepPattern.html#fixupVariables(java.util.Vector, int)">fixupVariables</A></B>(java.util.Vector&nbsp;vars,
int&nbsp;globalsSize)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This function is used to fixup variables from QNames to stack frame
indexes at stylesheet build time.</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/patterns/StepPattern.html#getAxis()">getAxis</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the axis that this step follows.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#getExpression()">getExpression</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the raw Expression object that this class wraps.</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/patterns/StepPattern.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 count of the nodes that match the test, which is the proximity
position of the last node that can pass this test in the sub context
selection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;double</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#getMatchScore(org.apache.xpath.XPathContext, int)">getMatchScore</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt,
int&nbsp;context)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the match score of the given node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#getPredicate(int)">getPredicate</A></B>(int&nbsp;i)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a predicate expression.</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/patterns/StepPattern.html#getPredicateCount()">getPredicateCount</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the number of predicates for this match pattern step.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#getPredicates()">getPredicates</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the list of predicate expressions for this pattern step.</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/patterns/StepPattern.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 proximity position index of the current node based on this
node test.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>private &nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#getProximityPosition(org.apache.xpath.XPathContext, int, boolean)">getProximityPosition</A></B>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt,
int&nbsp;predPos,
boolean&nbsp;findLast)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the proximity position index of the current node based on this
node test.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/xpath/patterns/StepPattern.html" title="class in org.apache.xpath.patterns">StepPattern</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#getRelativePathPattern()">getRelativePathPattern</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the reference to nodetest and predicate for
parent or ancestor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#getTargetString()">getTargetString</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the local name or psuedo name of the node that this pattern will test,
for hash table lookup optimization.</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/xpath/patterns/StepPattern.html#setAxis(int)">setAxis</A></B>(int&nbsp;axis)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the axis that this step should follow.</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/xpath/patterns/StepPattern.html#setExpression(org.apache.xpath.Expression)">setExpression</A></B>(<A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A>&nbsp;exp)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the raw expression object for this object.</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/xpath/patterns/StepPattern.html#setPredicates(org.apache.xpath.Expression[])">setPredicates</A></B>(<A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A>[]&nbsp;predicates)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the predicates for this match pattern step.</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/xpath/patterns/StepPattern.html#setRelativePathPattern(org.apache.xpath.patterns.StepPattern)">setRelativePathPattern</A></B>(<A HREF="../../../../org/apache/xpath/patterns/StepPattern.html" title="class in org.apache.xpath.patterns">StepPattern</A>&nbsp;expr)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the reference to nodetest and predicate for
parent or ancestor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xpath/patterns/StepPattern.html#toString()">toString</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the string represenentation of this step for diagnostic purposes.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.xpath.patterns.NodeTest"><!-- --></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.xpath.patterns.<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html" title="class in org.apache.xpath.patterns">NodeTest</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#debugWhatToShow(int)">debugWhatToShow</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#getDefaultScore()">getDefaultScore</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#getLocalName()">getLocalName</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#getNamespace()">getNamespace</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#getNodeTypeTest(int)">getNodeTypeTest</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#getStaticScore()">getStaticScore</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#getWhatToShow()">getWhatToShow</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#initNodeTest(int)">initNodeTest</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#initNodeTest(int, java.lang.String, java.lang.String)">initNodeTest</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#setLocalName(java.lang.String)">setLocalName</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#setNamespace(java.lang.String)">setNamespace</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#setStaticScore(org.apache.xpath.objects.XNumber)">setStaticScore</A>, <A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#setWhatToShow(int)">setWhatToShow</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.xpath.Expression"><!-- --></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.xpath.<A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/xpath/Expression.html#asIterator(org.apache.xpath.XPathContext, int)">asIterator</A>, <A HREF="../../../../org/apache/xpath/Expression.html#asIteratorRaw(org.apache.xpath.XPathContext, int)">asIteratorRaw</A>, <A HREF="../../../../org/apache/xpath/Expression.html#asNode(org.apache.xpath.XPathContext)">asNode</A>, <A HREF="../../../../org/apache/xpath/Expression.html#assertion(boolean, java.lang.String)">assertion</A>, <A HREF="../../../../org/apache/xpath/Expression.html#bool(org.apache.xpath.XPathContext)">bool</A>, <A HREF="../../../../org/apache/xpath/Expression.html#error(org.apache.xpath.XPathContext, java.lang.String, java.lang.Object[])">error</A>, <A HREF="../../../../org/apache/xpath/Expression.html#execute(org.apache.xpath.XPathContext, boolean)">execute</A>, <A HREF="../../../../org/apache/xpath/Expression.html#executeCharsToContentHandler(org.apache.xpath.XPathContext, org.xml.sax.ContentHandler)">executeCharsToContentHandler</A>, <A HREF="../../../../org/apache/xpath/Expression.html#exprAddChild(org.apache.xpath.ExpressionNode, int)">exprAddChild</A>, <A HREF="../../../../org/apache/xpath/Expression.html#exprGetChild(int)">exprGetChild</A>, <A HREF="../../../../org/apache/xpath/Expression.html#exprGetNumChildren()">exprGetNumChildren</A>, <A HREF="../../../../org/apache/xpath/Expression.html#exprGetParent()">exprGetParent</A>, <A HREF="../../../../org/apache/xpath/Expression.html#exprSetParent(org.apache.xpath.ExpressionNode)">exprSetParent</A>, <A HREF="../../../../org/apache/xpath/Expression.html#getColumnNumber()">getColumnNumber</A>, <A HREF="../../../../org/apache/xpath/Expression.html#getExpressionOwner()">getExpressionOwner</A>, <A HREF="../../../../org/apache/xpath/Expression.html#getLineNumber()">getLineNumber</A>, <A HREF="../../../../org/apache/xpath/Expression.html#getPublicId()">getPublicId</A>, <A HREF="../../../../org/apache/xpath/Expression.html#getSystemId()">getSystemId</A>, <A HREF="../../../../org/apache/xpath/Expression.html#isNodesetExpr()">isNodesetExpr</A>, <A HREF="../../../../org/apache/xpath/Expression.html#isSameClass(org.apache.xpath.Expression)">isSameClass</A>, <A HREF="../../../../org/apache/xpath/Expression.html#isStableNumber()">isStableNumber</A>, <A HREF="../../../../org/apache/xpath/Expression.html#num(org.apache.xpath.XPathContext)">num</A>, <A HREF="../../../../org/apache/xpath/Expression.html#warn(org.apache.xpath.XPathContext, java.lang.String, java.lang.Object[])">warn</A>, <A HREF="../../../../org/apache/xpath/Expression.html#xstr(org.apache.xpath.XPathContext)">xstr</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, 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="serialVersionUID"><!-- --></A><H3>
serialVersionUID</H3>
<PRE>
static final long <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.41"><B>serialVersionUID</B></A></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xpath.patterns.StepPattern.serialVersionUID">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="m_axis"><!-- --></A><H3>
m_axis</H3>
<PRE>
protected int <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.44"><B>m_axis</B></A></PRE>
<DL>
<DD>The axis for this test.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_targetString"><!-- --></A><H3>
m_targetString</H3>
<PRE>
java.lang.String <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.85"><B>m_targetString</B></A></PRE>
<DL>
<DD>The target local name or psuedo name, for hash table lookup optimization.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_relativePathPattern"><!-- --></A><H3>
m_relativePathPattern</H3>
<PRE>
<A HREF="../../../../org/apache/xpath/patterns/StepPattern.html" title="class in org.apache.xpath.patterns">StepPattern</A> <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.145"><B>m_relativePathPattern</B></A></PRE>
<DL>
<DD>Reference to nodetest and predicate for
parent or ancestor.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="m_predicates"><!-- --></A><H3>
m_predicates</H3>
<PRE>
<A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A>[] <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.227"><B>m_predicates</B></A></PRE>
<DL>
<DD>The list of predicate expressions for this pattern step.
<P>
<DL>
</DL>
</DL>
<HR>
<A NAME="DEBUG_MATCHES"><!-- --></A><H3>
DEBUG_MATCHES</H3>
<PRE>
private static final boolean <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.876"><B>DEBUG_MATCHES</B></A></PRE>
<DL>
<DD>Set to true to send diagnostics about pattern matches to the consol.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xpath.patterns.StepPattern.DEBUG_MATCHES">Constant Field Values</A></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="StepPattern(int, java.lang.String, java.lang.String, int, int)"><!-- --></A><H3>
StepPattern</H3>
<PRE>
public <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.56"><B>StepPattern</B></A>(int&nbsp;whatToShow,
java.lang.String&nbsp;namespace,
java.lang.String&nbsp;name,
int&nbsp;axis,
int&nbsp;axisForPredicate)</PRE>
<DL>
<DD>Construct a StepPattern that tests for namespaces and node names.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>whatToShow</CODE> - Bit set defined mainly by <CODE>NodeFilter</CODE>.<DD><CODE>namespace</CODE> - The namespace to be tested.<DD><CODE>name</CODE> - The local name to be tested.<DD><CODE>axis</CODE> - The Axis for this test, one of of Axes.ANCESTORORSELF, etc.<DD><CODE>axisForPredicate</CODE> - No longer used.</DL>
</DL>
<HR>
<A NAME="StepPattern(int, int, int)"><!-- --></A><H3>
StepPattern</H3>
<PRE>
public <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.73"><B>StepPattern</B></A>(int&nbsp;whatToShow,
int&nbsp;axis,
int&nbsp;axisForPredicate)</PRE>
<DL>
<DD>Construct a StepPattern that doesn't test for node names.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>whatToShow</CODE> - Bit set defined mainly by <CODE>NodeFilter</CODE>.<DD><CODE>axis</CODE> - The Axis for this test, one of of Axes.ANCESTORORSELF, etc.<DD><CODE>axisForPredicate</CODE> - No longer used.</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="calcTargetString()"><!-- --></A><H3>
calcTargetString</H3>
<PRE>
public void <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.93"><B>calcTargetString</B></A>()</PRE>
<DL>
<DD>Calculate the local name or psuedo name of the node that this pattern will test,
for hash table lookup optimization.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xpath/compiler/PsuedoNames.html" title="class in org.apache.xpath.compiler"><CODE>PsuedoNames</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getTargetString()"><!-- --></A><H3>
getTargetString</H3>
<PRE>
public java.lang.String <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.135"><B>getTargetString</B></A>()</PRE>
<DL>
<DD>Get the local name or psuedo name of the node that this pattern will test,
for hash table lookup optimization.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>local name or psuedo name of the node.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xpath/compiler/PsuedoNames.html" title="class in org.apache.xpath.compiler"><CODE>PsuedoNames</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="fixupVariables(java.util.Vector, int)"><!-- --></A><H3>
fixupVariables</H3>
<PRE>
public void <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.158"><B>fixupVariables</B></A>(java.util.Vector&nbsp;vars,
int&nbsp;globalsSize)</PRE>
<DL>
<DD>This function is used to fixup variables from QNames to stack frame
indexes at stylesheet build time.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#fixupVariables(java.util.Vector, int)">fixupVariables</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html" title="class in org.apache.xpath.patterns">NodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>vars</CODE> - List of QNames that correspond to variables. This list
should be searched backwards for the first qualified name that
corresponds to the variable reference qname. The position of the
QName in the vector from the start of the vector will be its position
in the stack frame (but variables above the globalsTop value will need
to be offset to the current stack frame).<DD><CODE>globalsSize</CODE> - The number of variables in the global variable area.</DL>
</DD>
</DL>
<HR>
<A NAME="setRelativePathPattern(org.apache.xpath.patterns.StepPattern)"><!-- --></A><H3>
setRelativePathPattern</H3>
<PRE>
public void <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.184"><B>setRelativePathPattern</B></A>(<A HREF="../../../../org/apache/xpath/patterns/StepPattern.html" title="class in org.apache.xpath.patterns">StepPattern</A>&nbsp;expr)</PRE>
<DL>
<DD>Set the reference to nodetest and predicate for
parent or ancestor.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>expr</CODE> - The relative pattern expression.</DL>
</DD>
</DL>
<HR>
<A NAME="getRelativePathPattern()"><!-- --></A><H3>
getRelativePathPattern</H3>
<PRE>
public <A HREF="../../../../org/apache/xpath/patterns/StepPattern.html" title="class in org.apache.xpath.patterns">StepPattern</A> <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.200"><B>getRelativePathPattern</B></A>()</PRE>
<DL>
<DD>Get the reference to nodetest and predicate for
parent or ancestor.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The relative pattern expression.</DL>
</DD>
</DL>
<HR>
<A NAME="getPredicates()"><!-- --></A><H3>
getPredicates</H3>
<PRE>
public <A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A>[] <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.218"><B>getPredicates</B></A>()</PRE>
<DL>
<DD>Set the list of predicate expressions for this pattern step.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>List of expression objects.</DL>
</DD>
</DL>
<HR>
<A NAME="canTraverseOutsideSubtree()"><!-- --></A><H3>
canTraverseOutsideSubtree</H3>
<PRE>
public boolean <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.238"><B>canTraverseOutsideSubtree</B></A>()</PRE>
<DL>
<DD>Tell if this expression or it's subexpressions can traverse outside
the current subtree.
NOTE: Ancestors tests with predicates are problematic, and will require
special treatment.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/Expression.html#canTraverseOutsideSubtree()">canTraverseOutsideSubtree</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>true if traversal outside the context node's subtree can occur.</DL>
</DD>
</DL>
<HR>
<A NAME="getPredicate(int)"><!-- --></A><H3>
getPredicate</H3>
<PRE>
public <A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A> <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.260"><B>getPredicate</B></A>(int&nbsp;i)</PRE>
<DL>
<DD>Get a predicate expression.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>i</CODE> - The index of the predicate.
<DT><B>Returns:</B><DD>A predicate expression.</DL>
</DD>
</DL>
<HR>
<A NAME="getPredicateCount()"><!-- --></A><H3>
getPredicateCount</H3>
<PRE>
public final int <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.271"><B>getPredicateCount</B></A>()</PRE>
<DL>
<DD>Get the number of predicates for this match pattern step.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the number of predicates for this match pattern step.</DL>
</DD>
</DL>
<HR>
<A NAME="setPredicates(org.apache.xpath.Expression[])"><!-- --></A><H3>
setPredicates</H3>
<PRE>
public void <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.283"><B>setPredicates</B></A>(<A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A>[]&nbsp;predicates)</PRE>
<DL>
<DD>Set the predicates for this match pattern step.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>predicates</CODE> - An array of expressions that define predicates
for this step.</DL>
</DD>
</DL>
<HR>
<A NAME="calcScore()"><!-- --></A><H3>
calcScore</H3>
<PRE>
public void <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.301"><B>calcScore</B></A>()</PRE>
<DL>
<DD>Static calc of match score.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#calcScore()">calcScore</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html" title="class in org.apache.xpath.patterns">NodeTest</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="execute(org.apache.xpath.XPathContext, int)"><!-- --></A><H3>
execute</H3>
<PRE>
public <A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A> <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.330"><B>execute</B></A>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt,
int&nbsp;currentNode)
throws javax.xml.transform.TransformerException</PRE>
<DL>
<DD>Execute this pattern step, including predicates.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#execute(org.apache.xpath.XPathContext, int)">execute</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html" title="class in org.apache.xpath.patterns">NodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - XPath runtime context.<DD><CODE>currentNode</CODE> - The current node context.
<DT><B>Returns:</B><DD><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NODETEST"><CODE>NodeTest.SCORE_NODETEST</CODE></A>,
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NONE"><CODE>NodeTest.SCORE_NONE</CODE></A>,
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NSWILD"><CODE>NodeTest.SCORE_NSWILD</CODE></A>,
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_QNAME"><CODE>NodeTest.SCORE_QNAME</CODE></A>, or
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_OTHER"><CODE>NodeTest.SCORE_OTHER</CODE></A>.
<DT><B>Throws:</B>
<DD><CODE>javax.xml.transform.TransformerException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="execute(org.apache.xpath.XPathContext)"><!-- --></A><H3>
execute</H3>
<PRE>
public <A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A> <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.360"><B>execute</B></A>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt)
throws javax.xml.transform.TransformerException</PRE>
<DL>
<DD>Execute this pattern step, including predicates.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#execute(org.apache.xpath.XPathContext)">execute</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html" title="class in org.apache.xpath.patterns">NodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - XPath runtime context.
<DT><B>Returns:</B><DD><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NODETEST"><CODE>NodeTest.SCORE_NODETEST</CODE></A>,
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NONE"><CODE>NodeTest.SCORE_NONE</CODE></A>,
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NSWILD"><CODE>NodeTest.SCORE_NSWILD</CODE></A>,
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_QNAME"><CODE>NodeTest.SCORE_QNAME</CODE></A>, or
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_OTHER"><CODE>NodeTest.SCORE_OTHER</CODE></A>.
<DT><B>Throws:</B>
<DD><CODE>javax.xml.transform.TransformerException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="execute(org.apache.xpath.XPathContext, int, org.apache.xml.dtm.DTM, int)"><!-- --></A><H3>
execute</H3>
<PRE>
public <A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A> <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.381"><B>execute</B></A>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt,
int&nbsp;currentNode,
<A HREF="../../../../org/apache/xml/dtm/DTM.html" title="interface in org.apache.xml.dtm">DTM</A>&nbsp;dtm,
int&nbsp;expType)
throws javax.xml.transform.TransformerException</PRE>
<DL>
<DD>Execute an expression in the XPath runtime context, and return the
result of the expression.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#execute(org.apache.xpath.XPathContext, int, org.apache.xml.dtm.DTM, int)">execute</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html" title="class in org.apache.xpath.patterns">NodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DD><CODE>currentNode</CODE> - The currentNode.<DD><CODE>dtm</CODE> - The DTM of the current node.<DD><CODE>expType</CODE> - The expanded type ID of the current node.
<DT><B>Returns:</B><DD>The result of the expression in the form of a <code>XObject</code>.
<DT><B>Throws:</B>
<DD><CODE>javax.xml.transform.TransformerException</CODE> - if a runtime exception
occurs.</DL>
</DD>
</DL>
<HR>
<A NAME="checkProximityPosition(org.apache.xpath.XPathContext, int, org.apache.xml.dtm.DTM, int, int)"><!-- --></A><H3>
checkProximityPosition</H3>
<PRE>
private final boolean <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.428"><B>checkProximityPosition</B></A>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt,
int&nbsp;predPos,
<A HREF="../../../../org/apache/xml/dtm/DTM.html" title="interface in org.apache.xml.dtm">DTM</A>&nbsp;dtm,
int&nbsp;context,
int&nbsp;pos)</PRE>
<DL>
<DD>New Method to check whether the current node satisfies a position predicate
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DD><CODE>predPos</CODE> - Which predicate we're evaluating of foo[1][2][3].<DD><CODE>dtm</CODE> - The DTM of the current node.<DD><CODE>context</CODE> - The currentNode.<DD><CODE>pos</CODE> - The position being requested, i.e. the value returned by
m_predicates[predPos].execute(xctxt).
<DT><B>Returns:</B><DD>true of the position of the context matches pos, false otherwise.</DL>
</DD>
</DL>
<HR>
<A NAME="getProximityPosition(org.apache.xpath.XPathContext, int, boolean)"><!-- --></A><H3>
getProximityPosition</H3>
<PRE>
private final int <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.523"><B>getProximityPosition</B></A>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt,
int&nbsp;predPos,
boolean&nbsp;findLast)</PRE>
<DL>
<DD>Get the proximity position index of the current node based on this
node test.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - XPath runtime context.<DD><CODE>predPos</CODE> - Which predicate we're evaluating of foo[1][2][3].<DD><CODE>findLast</CODE> - If true, don't terminate when the context node is found.
<DT><B>Returns:</B><DD>the proximity position index of the current node based on the
node test.</DL>
</DD>
</DL>
<HR>
<A NAME="getProximityPosition(org.apache.xpath.XPathContext)"><!-- --></A><H3>
getProximityPosition</H3>
<PRE>
public int <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.627"><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 proximity position index of the current node based on this
node test.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xpath/axes/SubContextList.html#getProximityPosition(org.apache.xpath.XPathContext)">getProximityPosition</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xpath/axes/SubContextList.html" title="interface in org.apache.xpath.axes">SubContextList</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - XPath runtime context.
<DT><B>Returns:</B><DD>the proximity position index of the current node based on the
node test.</DL>
</DD>
</DL>
<HR>
<A NAME="getLastPos(org.apache.xpath.XPathContext)"><!-- --></A><H3>
getLastPos</H3>
<PRE>
public int <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.643"><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 count of the nodes that match the test, which is the proximity
position of the last node that can pass this test in the sub context
selection. In XSLT 1-based indexing, this count is the index of the last
node.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xpath/axes/SubContextList.html#getLastPos(org.apache.xpath.XPathContext)">getLastPos</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xpath/axes/SubContextList.html" title="interface in org.apache.xpath.axes">SubContextList</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - XPath runtime context.
<DT><B>Returns:</B><DD>the count of the nodes that match the test.</DL>
</DD>
</DL>
<HR>
<A NAME="executeRelativePathPattern(org.apache.xpath.XPathContext, org.apache.xml.dtm.DTM, int)"><!-- --></A><H3>
executeRelativePathPattern</H3>
<PRE>
protected final <A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A> <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.664"><B>executeRelativePathPattern</B></A>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt,
<A HREF="../../../../org/apache/xml/dtm/DTM.html" title="interface in org.apache.xml.dtm">DTM</A>&nbsp;dtm,
int&nbsp;currentNode)
throws javax.xml.transform.TransformerException</PRE>
<DL>
<DD>Execute the match pattern step relative to another step.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DD><CODE>dtm</CODE> - The DTM of the current node.<DD><CODE>currentNode</CODE> - The current node context.
<DT><B>Returns:</B><DD><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NODETEST"><CODE>NodeTest.SCORE_NODETEST</CODE></A>,
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NONE"><CODE>NodeTest.SCORE_NONE</CODE></A>,
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NSWILD"><CODE>NodeTest.SCORE_NSWILD</CODE></A>,
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_QNAME"><CODE>NodeTest.SCORE_QNAME</CODE></A>, or
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_OTHER"><CODE>NodeTest.SCORE_OTHER</CODE></A>.
<DT><B>Throws:</B>
<DD><CODE>javax.xml.transform.TransformerException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="executePredicates(org.apache.xpath.XPathContext, org.apache.xml.dtm.DTM, int)"><!-- --></A><H3>
executePredicates</H3>
<PRE>
protected final boolean <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.708"><B>executePredicates</B></A>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt,
<A HREF="../../../../org/apache/xml/dtm/DTM.html" title="interface in org.apache.xml.dtm">DTM</A>&nbsp;dtm,
int&nbsp;currentNode)
throws javax.xml.transform.TransformerException</PRE>
<DL>
<DD>Execute the predicates on this step to determine if the current node
should be filtered or accepted.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DD><CODE>dtm</CODE> - The DTM of the current node.<DD><CODE>currentNode</CODE> - The current node context.
<DT><B>Returns:</B><DD>true if the node should be accepted, false otherwise.
<DT><B>Throws:</B>
<DD><CODE>javax.xml.transform.TransformerException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.787"><B>toString</B></A>()</PRE>
<DL>
<DD>Get the string represenentation of this step for diagnostic purposes.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>A string representation of this step, built by reverse-engineering
the contained info.</DL>
</DD>
</DL>
<HR>
<A NAME="getMatchScore(org.apache.xpath.XPathContext, int)"><!-- --></A><H3>
getMatchScore</H3>
<PRE>
public double <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.892"><B>getMatchScore</B></A>(<A HREF="../../../../org/apache/xpath/XPathContext.html" title="class in org.apache.xpath">XPathContext</A>&nbsp;xctxt,
int&nbsp;context)
throws javax.xml.transform.TransformerException</PRE>
<DL>
<DD>Get the match score of the given node.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DD><CODE>context</CODE> - The node to be tested.
<DT><B>Returns:</B><DD><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NODETEST"><CODE>NodeTest.SCORE_NODETEST</CODE></A>,
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NONE"><CODE>NodeTest.SCORE_NONE</CODE></A>,
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_NSWILD"><CODE>NodeTest.SCORE_NSWILD</CODE></A>,
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_QNAME"><CODE>NodeTest.SCORE_QNAME</CODE></A>, or
<A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#SCORE_OTHER"><CODE>NodeTest.SCORE_OTHER</CODE></A>.
<DT><B>Throws:</B>
<DD><CODE>javax.xml.transform.TransformerException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setAxis(int)"><!-- --></A><H3>
setAxis</H3>
<PRE>
public void <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.920"><B>setAxis</B></A>(int&nbsp;axis)</PRE>
<DL>
<DD>Set the axis that this step should follow.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>axis</CODE> - The Axis for this test, one of of Axes.ANCESTORORSELF, etc.</DL>
</DD>
</DL>
<HR>
<A NAME="getAxis()"><!-- --></A><H3>
getAxis</H3>
<PRE>
public int <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.931"><B>getAxis</B></A>()</PRE>
<DL>
<DD>Get the axis that this step follows.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>The Axis for this test, one of of Axes.ANCESTORORSELF, etc.</DL>
</DD>
</DL>
<HR>
<A NAME="callVisitors(org.apache.xpath.ExpressionOwner, org.apache.xpath.XPathVisitor)"><!-- --></A><H3>
callVisitors</H3>
<PRE>
public void <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.967"><B>callVisitors</B></A>(<A HREF="../../../../org/apache/xpath/ExpressionOwner.html" title="interface in org.apache.xpath">ExpressionOwner</A>&nbsp;owner,
<A HREF="../../../../org/apache/xpath/XPathVisitor.html" title="class in org.apache.xpath">XPathVisitor</A>&nbsp;visitor)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xpath/XPathVisitable.html#callVisitors(org.apache.xpath.ExpressionOwner, org.apache.xpath.XPathVisitor)">XPathVisitable</A></CODE></B></DD>
<DD>This will traverse the heararchy, calling the visitor for
each member. If the called visitor method returns
false, the subtree should not be called.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xpath/XPathVisitable.html#callVisitors(org.apache.xpath.ExpressionOwner, org.apache.xpath.XPathVisitor)">callVisitors</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xpath/XPathVisitable.html" title="interface in org.apache.xpath">XPathVisitable</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#callVisitors(org.apache.xpath.ExpressionOwner, org.apache.xpath.XPathVisitor)">callVisitors</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html" title="class in org.apache.xpath.patterns">NodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>owner</CODE> - The owner of the visitor, where that path may be
rewritten if needed.<DD><CODE>visitor</CODE> - The visitor whose appropriate method will be called.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xpath/XPathVisitable.html#callVisitors(org.apache.xpath.ExpressionOwner, org.apache.xpath.XPathVisitor)"><CODE>XPathVisitable.callVisitors(ExpressionOwner, XPathVisitor)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="callSubtreeVisitors(org.apache.xpath.XPathVisitor)"><!-- --></A><H3>
callSubtreeVisitors</H3>
<PRE>
protected void <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.979"><B>callSubtreeVisitors</B></A>(<A HREF="../../../../org/apache/xpath/XPathVisitor.html" title="class in org.apache.xpath">XPathVisitor</A>&nbsp;visitor)</PRE>
<DL>
<DD>Call the visitors on the subtree. Factored out from callVisitors
so it may be called by derived classes.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getExpression()"><!-- --></A><H3>
getExpression</H3>
<PRE>
public <A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A> <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.1003"><B>getExpression</B></A>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xpath/ExpressionOwner.html#getExpression()">ExpressionOwner</A></CODE></B></DD>
<DD>Get the raw Expression object that this class wraps.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xpath/ExpressionOwner.html#getExpression()">getExpression</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xpath/ExpressionOwner.html" title="interface in org.apache.xpath">ExpressionOwner</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the raw Expression object, which should not normally be null.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xpath/ExpressionOwner.html#getExpression()"><CODE>ExpressionOwner.getExpression()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setExpression(org.apache.xpath.Expression)"><!-- --></A><H3>
setExpression</H3>
<PRE>
public void <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.1011"><B>setExpression</B></A>(<A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A>&nbsp;exp)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/apache/xpath/ExpressionOwner.html#setExpression(org.apache.xpath.Expression)">ExpressionOwner</A></CODE></B></DD>
<DD>Set the raw expression object for this object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xpath/ExpressionOwner.html#setExpression(org.apache.xpath.Expression)">setExpression</A></CODE> in interface <CODE><A HREF="../../../../org/apache/xpath/ExpressionOwner.html" title="interface in org.apache.xpath">ExpressionOwner</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>exp</CODE> - the raw Expression object, which should not normally be null.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xpath/ExpressionOwner.html#setExpression(org.apache.xpath.Expression)"><CODE>ExpressionOwner.setExpression(Expression)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="deepEquals(org.apache.xpath.Expression)"><!-- --></A><H3>
deepEquals</H3>
<PRE>
public boolean <A HREF="../../../../src-html/org/apache/xpath/patterns/StepPattern.html#line.1020"><B>deepEquals</B></A>(<A HREF="../../../../org/apache/xpath/Expression.html" title="class in org.apache.xpath">Expression</A>&nbsp;expr)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/xpath/Expression.html#deepEquals(org.apache.xpath.Expression)">Expression</A></CODE></B></DD>
<DD>Compare this object with another object and see
if they are equal, include the sub heararchy.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html#deepEquals(org.apache.xpath.Expression)">deepEquals</A></CODE> in class <CODE><A HREF="../../../../org/apache/xpath/patterns/NodeTest.html" title="class in org.apache.xpath.patterns">NodeTest</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>expr</CODE> - Another expression object.
<DT><B>Returns:</B><DD>true if this objects class and the expr
object's class are the same, and the data contained
within both objects are considered equal.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xpath/Expression.html#deepEquals(org.apache.xpath.Expression)"><CODE>Expression.deepEquals(Expression)</CODE></A></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/StepPattern.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/patterns/NodeTestFilter.html" title="interface in org.apache.xpath.patterns"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/xpath/patterns/StepPattern.PredOwner.html" title="class in org.apache.xpath.patterns"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/xpath/patterns/StepPattern.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="StepPattern.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;<A HREF="#nested_class_summary">NESTED</A>&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>