| <!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:41 PDT 2012 --> | |
| <TITLE> | |
| XPathExpressionImpl | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.xpath.domapi.XPathExpressionImpl class"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="XPathExpressionImpl"; | |
| } | |
| </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="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XPathExpressionImpl.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/domapi/XPathEvaluatorImpl.DummyPrefixResolver.html" title="class in org.apache.xpath.domapi"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/xpath/domapi/XPathNamespaceImpl.html" title="class in org.apache.xpath.domapi"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/xpath/domapi/XPathExpressionImpl.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="XPathExpressionImpl.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> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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.domapi</FONT> | |
| <BR> | |
| Class XPathExpressionImpl</H2> | |
| <PRE> | |
| java.lang.Object | |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xpath.domapi.XPathExpressionImpl</B> | |
| </PRE> | |
| <HR> | |
| <DL> | |
| <DT><PRE> class <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathExpressionImpl.html#line.53"><B>XPathExpressionImpl</B></A><DT>extends java.lang.Object</DL> | |
| </PRE> | |
| <P> | |
| The class provides an implementation of XPathExpression according | |
| to the DOM L3 XPath Specification, Working Group Note 26 February 2004. | |
| <p>See also the <a href='http://www.w3.org/TR/2004/NOTE-DOM-Level-3-XPath-20040226'>Document Object Model (DOM) Level 3 XPath Specification</a>.</p> | |
| <p>The <code>XPathExpression</code> interface represents a parsed and resolved | |
| XPath expression.</p> | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><CODE>org.w3c.dom.xpath.XPathExpression</CODE></DL> | |
| <HR> | |
| <P> | |
| <!-- =========== FIELD SUMMARY =========== --> | |
| <A NAME="field_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Field Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private org.w3c.dom.Document</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathExpressionImpl.html#m_doc">m_doc</A></B></CODE> | |
| <BR> | |
| The document to be searched to parallel the case where the XPathEvaluator | |
| is obtained by casting a Document.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private <A HREF="../../../../org/apache/xpath/XPath.html" title="class in org.apache.xpath">XPath</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathExpressionImpl.html#m_xpath">m_xpath</A></B></CODE> | |
| <BR> | |
| The xpath object that this expression wraps</TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <!-- ======== 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/domapi/XPathExpressionImpl.html#XPathExpressionImpl(org.apache.xpath.XPath, org.w3c.dom.Document)">XPathExpressionImpl</A></B>(<A HREF="../../../../org/apache/xpath/XPath.html" title="class in org.apache.xpath">XPath</A> xpath, | |
| org.w3c.dom.Document doc)</CODE> | |
| <BR> | |
| Constructor for XPathExpressionImpl.</TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <!-- ========== 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> java.lang.Object</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathExpressionImpl.html#evaluate(org.w3c.dom.Node, short, java.lang.Object)">evaluate</A></B>(org.w3c.dom.Node contextNode, | |
| short type, | |
| java.lang.Object result)</CODE> | |
| <BR> | |
| This method provides an implementation XPathResult.evaluate according | |
| to the DOM L3 XPath Specification, Working Group Note 26 February 2004.</TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <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="m_xpath"><!-- --></A><H3> | |
| m_xpath</H3> | |
| <PRE> | |
| private final <A HREF="../../../../org/apache/xpath/XPath.html" title="class in org.apache.xpath">XPath</A> <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathExpressionImpl.html#line.58"><B>m_xpath</B></A></PRE> | |
| <DL> | |
| <DD>The xpath object that this expression wraps | |
| <P> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="m_doc"><!-- --></A><H3> | |
| m_doc</H3> | |
| <PRE> | |
| private final org.w3c.dom.Document <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathExpressionImpl.html#line.64"><B>m_doc</B></A></PRE> | |
| <DL> | |
| <DD>The document to be searched to parallel the case where the XPathEvaluator | |
| is obtained by casting a Document. | |
| <P> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> | |
| <A NAME="constructor_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Constructor Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="XPathExpressionImpl(org.apache.xpath.XPath, org.w3c.dom.Document)"><!-- --></A><H3> | |
| XPathExpressionImpl</H3> | |
| <PRE> | |
| <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathExpressionImpl.html#line.73"><B>XPathExpressionImpl</B></A>(<A HREF="../../../../org/apache/xpath/XPath.html" title="class in org.apache.xpath">XPath</A> xpath, | |
| org.w3c.dom.Document doc)</PRE> | |
| <DL> | |
| <DD>Constructor for XPathExpressionImpl. | |
| <P> | |
| <DL> | |
| <DT><B>Parameters:</B><DD><CODE>xpath</CODE> - The wrapped XPath object.<DD><CODE>doc</CODE> - The document to be searched, to parallel the case where'' | |
| the XPathEvaluator is obtained by casting the document.</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="evaluate(org.w3c.dom.Node, short, java.lang.Object)"><!-- --></A><H3> | |
| evaluate</H3> | |
| <PRE> | |
| public java.lang.Object <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathExpressionImpl.html#line.122"><B>evaluate</B></A>(org.w3c.dom.Node contextNode, | |
| short type, | |
| java.lang.Object result) | |
| throws XPathException, | |
| org.w3c.dom.DOMException</PRE> | |
| <DL> | |
| <DD>This method provides an implementation XPathResult.evaluate according | |
| to the DOM L3 XPath Specification, Working Group Note 26 February 2004. | |
| <p>See also the <a href='http://www.w3.org/TR/2004/NOTE-DOM-Level-3-XPath-20040226'>Document Object Model (DOM) Level 3 XPath Specification</a>.</p> | |
| <p>Evaluates this XPath expression and returns a result.</p> | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>contextNode</CODE> - The <code>context</code> is context node for the | |
| evaluation of this XPath expression.If the XPathEvaluator was | |
| obtained by casting the <code>Document</code> then this must be | |
| owned by the same document and must be a <code>Document</code>, | |
| <code>Element</code>, <code>Attribute</code>, <code>Text</code>, | |
| <code>CDATASection</code>, <code>Comment</code>, | |
| <code>ProcessingInstruction</code>, or <code>XPathNamespace</code> | |
| node.If the context node is a <code>Text</code> or a | |
| <code>CDATASection</code>, then the context is interpreted as the | |
| whole logical text node as seen by XPath, unless the node is empty | |
| in which case it may not serve as the XPath context.<DD><CODE>type</CODE> - If a specific <code>type</code> is specified, then the | |
| result will be coerced to return the specified type relying on | |
| XPath conversions and fail if the desired coercion is not possible. | |
| This must be one of the type codes of <code>XPathResult</code>.<DD><CODE>result</CODE> - The <code>result</code> specifies a specific result | |
| object which may be reused and returned by this method. If this is | |
| specified as <code>null</code>or the implementation does not reuse | |
| the specified result, a new result object will be constructed and | |
| returned.For XPath 1.0 results, this object will be of type | |
| <code>XPathResult</code>. | |
| <DT><B>Returns:</B><DD>The result of the evaluation of the XPath expression.For XPath | |
| 1.0 results, this object will be of type <code>XPathResult</code>. | |
| <DT><B>Throws:</B> | |
| <DD><CODE>XPathException</CODE> - TYPE_ERR: Raised if the result cannot be converted to return the | |
| specified type. | |
| <DD><CODE>org.w3c.dom.DOMException</CODE> - WRONG_DOCUMENT_ERR: The Node is from a document that is not supported | |
| by the XPathEvaluator that created this | |
| <code>XPathExpression</code>. | |
| <br>NOT_SUPPORTED_ERR: The Node is not a type permitted as an XPath | |
| context node.<DT><B>See Also:</B><DD><CODE>org.w3c.dom.xpath.XPathExpression#evaluate(Node, short, XPathResult)</CODE></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> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XPathExpressionImpl.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/domapi/XPathEvaluatorImpl.DummyPrefixResolver.html" title="class in org.apache.xpath.domapi"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/xpath/domapi/XPathNamespaceImpl.html" title="class in org.apache.xpath.domapi"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../index.html?org/apache/xpath/domapi/XPathExpressionImpl.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="XPathExpressionImpl.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> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_bottom"></A> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <HR> | |
| </BODY> | |
| </HTML> |