| <!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> | |
| XPathResultImpl | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.xpath.domapi.XPathResultImpl class"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="XPathResultImpl"; | |
| } | |
| </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/XPathResultImpl.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/XPathNSResolverImpl.html" title="class in org.apache.xpath.domapi"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/xpath/domapi/XPathStylesheetDOM3Exception.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/XPathResultImpl.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="XPathResultImpl.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 XPathResultImpl</H2> | |
| <PRE> | |
| java.lang.Object | |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xpath.domapi.XPathResultImpl</B> | |
| </PRE> | |
| <DL> | |
| <DT><B>All Implemented Interfaces:</B> <DD>org.w3c.dom.events.EventListener</DD> | |
| </DL> | |
| <HR> | |
| <DL> | |
| <DT><PRE> class <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.61"><B>XPathResultImpl</B></A><DT>extends java.lang.Object<DT>implements org.w3c.dom.events.EventListener</DL> | |
| </PRE> | |
| <P> | |
| The class provides an implementation XPathResult 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>XPathResult</code> interface represents the result of the | |
| evaluation of an XPath expression within the context of a particular | |
| node. Since evaluation of an XPath expression can result in various | |
| result types, this object makes it possible to discover and manipulate | |
| the type and value of the result.</p> | |
| <p>This implementation wraps an <code>XObject</code>. | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects"><CODE>XObject</CODE></A>, | |
| <CODE>org.w3c.dom.xpath.XPathResult</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.Node</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#m_contextNode">m_contextNode</A></B></CODE> | |
| <BR> | |
| Only used to attach a mutation event handler when specified | |
| type is an iterator type.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#m_isInvalidIteratorState">m_isInvalidIteratorState</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private org.w3c.dom.traversal.NodeIterator</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#m_iterator">m_iterator</A></B></CODE> | |
| <BR> | |
| The iterator, if this is an iterator type.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private org.w3c.dom.NodeList</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#m_list">m_list</A></B></CODE> | |
| <BR> | |
| The list, if this is a snapshot type.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private <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/domapi/XPathResultImpl.html#m_resultObj">m_resultObj</A></B></CODE> | |
| <BR> | |
| The wrapped XObject</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#m_resultType">m_resultType</A></B></CODE> | |
| <BR> | |
| This the type specified by the user during construction.</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/XPathResultImpl.html#m_xpath">m_xpath</A></B></CODE> | |
| <BR> | |
| The xpath object that wraps the expression used for this result.</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/XPathResultImpl.html#XPathResultImpl(short, org.apache.xpath.objects.XObject, org.w3c.dom.Node, org.apache.xpath.XPath)">XPathResultImpl</A></B>(short type, | |
| <A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A> result, | |
| org.w3c.dom.Node contextNode, | |
| <A HREF="../../../../org/apache/xpath/XPath.html" title="class in org.apache.xpath">XPath</A> xpath)</CODE> | |
| <BR> | |
| Constructor for XPathResultImpl.</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>private void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#addEventListener()">addEventListener</A></B>()</CODE> | |
| <BR> | |
| Add m_contextNode to Event Listner to listen for Mutations Events</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#getBooleanValue()">getBooleanValue</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#getInvalidIteratorState()">getInvalidIteratorState</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> double</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#getNumberValue()">getNumberValue</A></B>()</CODE> | |
| <BR> | |
| The value of this number result.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#getResultType()">getResultType</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> org.w3c.dom.Node</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#getSingleNodeValue()">getSingleNodeValue</A></B>()</CODE> | |
| <BR> | |
| The value of this single node result, which may be <code>null</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> int</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#getSnapshotLength()">getSnapshotLength</A></B>()</CODE> | |
| <BR> | |
| The number of nodes in the result snapshot.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#getStringValue()">getStringValue</A></B>()</CODE> | |
| <BR> | |
| The value of this string result.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private short</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#getTypeFromXObject(org.apache.xpath.objects.XObject)">getTypeFromXObject</A></B>(<A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A> object)</CODE> | |
| <BR> | |
| Given an XObject, determine the corresponding DOM XPath type</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#getTypeString(int)">getTypeString</A></B>(int type)</CODE> | |
| <BR> | |
| Given a request type, return the equivalent string.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#handleEvent(org.w3c.dom.events.Event)">handleEvent</A></B>(org.w3c.dom.events.Event event)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#isNamespaceNode(org.w3c.dom.Node)">isNamespaceNode</A></B>(org.w3c.dom.Node node)</CODE> | |
| <BR> | |
| Given a node, determine if it is a namespace node.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>(package private) static boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#isValidType(short)">isValidType</A></B>(short type)</CODE> | |
| <BR> | |
| Check if the specified type is one of the supported types.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> org.w3c.dom.Node</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#iterateNext()">iterateNext</A></B>()</CODE> | |
| <BR> | |
| Iterates and returns the next node from the node set or | |
| <code>null</code>if there are no more nodes.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#removeEventListener()">removeEventListener</A></B>()</CODE> | |
| <BR> | |
| Remove m_contextNode to Event Listner to listen for Mutations Events</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> org.w3c.dom.Node</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../org/apache/xpath/domapi/XPathResultImpl.html#snapshotItem(int)">snapshotItem</A></B>(int index)</CODE> | |
| <BR> | |
| Returns the <code>index</code>th item in the snapshot collection.</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_resultObj"><!-- --></A><H3> | |
| m_resultObj</H3> | |
| <PRE> | |
| private 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/domapi/XPathResultImpl.html#line.66"><B>m_resultObj</B></A></PRE> | |
| <DL> | |
| <DD>The wrapped XObject | |
| <P> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <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/XPathResultImpl.html#line.71"><B>m_xpath</B></A></PRE> | |
| <DL> | |
| <DD>The xpath object that wraps the expression used for this result. | |
| <P> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="m_resultType"><!-- --></A><H3> | |
| m_resultType</H3> | |
| <PRE> | |
| private final short <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.77"><B>m_resultType</B></A></PRE> | |
| <DL> | |
| <DD>This the type specified by the user during construction. Typically | |
| the constructor will be called by org.apache.xpath.XPath.evaluate(). | |
| <P> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="m_isInvalidIteratorState"><!-- --></A><H3> | |
| m_isInvalidIteratorState</H3> | |
| <PRE> | |
| private boolean <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.79"><B>m_isInvalidIteratorState</B></A></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="m_contextNode"><!-- --></A><H3> | |
| m_contextNode</H3> | |
| <PRE> | |
| private final org.w3c.dom.Node <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.85"><B>m_contextNode</B></A></PRE> | |
| <DL> | |
| <DD>Only used to attach a mutation event handler when specified | |
| type is an iterator type. | |
| <P> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="m_iterator"><!-- --></A><H3> | |
| m_iterator</H3> | |
| <PRE> | |
| private org.w3c.dom.traversal.NodeIterator <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.90"><B>m_iterator</B></A></PRE> | |
| <DL> | |
| <DD>The iterator, if this is an iterator type. | |
| <P> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="m_list"><!-- --></A><H3> | |
| m_list</H3> | |
| <PRE> | |
| private org.w3c.dom.NodeList <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.95"><B>m_list</B></A></PRE> | |
| <DL> | |
| <DD>The list, if this is a snapshot type. | |
| <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="XPathResultImpl(short, org.apache.xpath.objects.XObject, org.w3c.dom.Node, org.apache.xpath.XPath)"><!-- --></A><H3> | |
| XPathResultImpl</H3> | |
| <PRE> | |
| <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.103"><B>XPathResultImpl</B></A>(short type, | |
| <A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A> result, | |
| org.w3c.dom.Node contextNode, | |
| <A HREF="../../../../org/apache/xpath/XPath.html" title="class in org.apache.xpath">XPath</A> xpath)</PRE> | |
| <DL> | |
| <DD>Constructor for XPathResultImpl. | |
| For internal use only. | |
| <P> | |
| </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="getResultType()"><!-- --></A><H3> | |
| getResultType</H3> | |
| <PRE> | |
| public short <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.172"><B>getResultType</B></A>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><CODE>org.w3c.dom.xpath.XPathResult#getResultType()</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getNumberValue()"><!-- --></A><H3> | |
| getNumberValue</H3> | |
| <PRE> | |
| public double <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.183"><B>getNumberValue</B></A>() | |
| throws XPathException</PRE> | |
| <DL> | |
| <DD>The value of this number result. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>XPathException</CODE> - TYPE_ERR: raised if <code>resultType</code> is not | |
| <code>NUMBER_TYPE</code>.<DT><B>See Also:</B><DD><CODE>org.w3c.dom.xpath.XPathResult#getNumberValue()</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getStringValue()"><!-- --></A><H3> | |
| getStringValue</H3> | |
| <PRE> | |
| public java.lang.String <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.206"><B>getStringValue</B></A>() | |
| throws XPathException</PRE> | |
| <DL> | |
| <DD>The value of this string result. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>XPathException</CODE> - TYPE_ERR: raised if <code>resultType</code> is not | |
| <code>STRING_TYPE</code>.<DT><B>See Also:</B><DD><CODE>org.w3c.dom.xpath.XPathResult#getStringValue()</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getBooleanValue()"><!-- --></A><H3> | |
| getBooleanValue</H3> | |
| <PRE> | |
| public boolean <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.224"><B>getBooleanValue</B></A>() | |
| throws XPathException</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>XPathException</CODE><DT><B>See Also:</B><DD><CODE>org.w3c.dom.xpath.XPathResult#getBooleanValue()</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getSingleNodeValue()"><!-- --></A><H3> | |
| getSingleNodeValue</H3> | |
| <PRE> | |
| public org.w3c.dom.Node <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.248"><B>getSingleNodeValue</B></A>() | |
| throws XPathException</PRE> | |
| <DL> | |
| <DD>The value of this single node result, which may be <code>null</code>. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>XPathException</CODE> - TYPE_ERR: raised if <code>resultType</code> is not | |
| <code>ANY_UNORDERED_NODE_TYPE</code> or | |
| <code>FIRST_ORDERED_NODE_TYPE</code>.<DT><B>See Also:</B><DD><CODE>org.w3c.dom.xpath.XPathResult#getSingleNodeValue()</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getInvalidIteratorState()"><!-- --></A><H3> | |
| getInvalidIteratorState</H3> | |
| <PRE> | |
| public boolean <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.280"><B>getInvalidIteratorState</B></A>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><CODE>org.w3c.dom.xpath.XPathResult#getInvalidIteratorState()</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getSnapshotLength()"><!-- --></A><H3> | |
| getSnapshotLength</H3> | |
| <PRE> | |
| public int <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.295"><B>getSnapshotLength</B></A>() | |
| throws XPathException</PRE> | |
| <DL> | |
| <DD>The number of nodes in the result snapshot. Valid values for | |
| snapshotItem indices are <code>0</code> to | |
| <code>snapshotLength-1</code> inclusive. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>XPathException</CODE> - TYPE_ERR: raised if <code>resultType</code> is not | |
| <code>UNORDERED_NODE_SNAPSHOT_TYPE</code> or | |
| <code>ORDERED_NODE_SNAPSHOT_TYPE</code>.<DT><B>See Also:</B><DD><CODE>org.w3c.dom.xpath.XPathResult#getSnapshotLength()</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="iterateNext()"><!-- --></A><H3> | |
| iterateNext</H3> | |
| <PRE> | |
| public org.w3c.dom.Node <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.320"><B>iterateNext</B></A>() | |
| throws XPathException, | |
| org.w3c.dom.DOMException</PRE> | |
| <DL> | |
| <DD>Iterates and returns the next node from the node set or | |
| <code>null</code>if there are no more nodes. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>Returns the next node. | |
| <DT><B>Throws:</B> | |
| <DD><CODE>XPathException</CODE> - TYPE_ERR: raised if <code>resultType</code> is not | |
| <code>UNORDERED_NODE_ITERATOR_TYPE</code> or | |
| <code>ORDERED_NODE_ITERATOR_TYPE</code>. | |
| <DD><CODE>org.w3c.dom.DOMException</CODE> - INVALID_STATE_ERR: The document has been mutated since the result was | |
| returned.<DT><B>See Also:</B><DD><CODE>org.w3c.dom.xpath.XPathResult#iterateNext()</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="snapshotItem(int)"><!-- --></A><H3> | |
| snapshotItem</H3> | |
| <PRE> | |
| public org.w3c.dom.Node <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.362"><B>snapshotItem</B></A>(int index) | |
| throws XPathException</PRE> | |
| <DL> | |
| <DD>Returns the <code>index</code>th item in the snapshot collection. If | |
| <code>index</code> is greater than or equal to the number of nodes in | |
| the list, this method returns <code>null</code>. Unlike the iterator | |
| result, the snapshot does not become invalid, but may not correspond | |
| to the current document if it is mutated. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>index</CODE> - Index into the snapshot collection. | |
| <DT><B>Returns:</B><DD>The node at the <code>index</code>th position in the | |
| <code>NodeList</code>, or <code>null</code> if that is not a valid | |
| index. | |
| <DT><B>Throws:</B> | |
| <DD><CODE>XPathException</CODE> - TYPE_ERR: raised if <code>resultType</code> is not | |
| <code>UNORDERED_NODE_SNAPSHOT_TYPE</code> or | |
| <code>ORDERED_NODE_SNAPSHOT_TYPE</code>.<DT><B>See Also:</B><DD><CODE>org.w3c.dom.xpath.XPathResult#snapshotItem(int)</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isValidType(short)"><!-- --></A><H3> | |
| isValidType</H3> | |
| <PRE> | |
| static boolean <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.389"><B>isValidType</B></A>(short type)</PRE> | |
| <DL> | |
| <DD>Check if the specified type is one of the supported types. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>type</CODE> - The specified type | |
| <DT><B>Returns:</B><DD>true If the specified type is supported; otherwise, returns false.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="handleEvent(org.w3c.dom.events.Event)"><!-- --></A><H3> | |
| handleEvent</H3> | |
| <PRE> | |
| public void <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.408"><B>handleEvent</B></A>(org.w3c.dom.events.Event event)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE>handleEvent</CODE> in interface <CODE>org.w3c.dom.events.EventListener</CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><CODE>EventListener.handleEvent(Event)</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getTypeString(int)"><!-- --></A><H3> | |
| getTypeString</H3> | |
| <PRE> | |
| private java.lang.String <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.425"><B>getTypeString</B></A>(int type)</PRE> | |
| <DL> | |
| <DD>Given a request type, return the equivalent string. | |
| For diagnostic purposes. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>type string</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getTypeFromXObject(org.apache.xpath.objects.XObject)"><!-- --></A><H3> | |
| getTypeFromXObject</H3> | |
| <PRE> | |
| private short <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.447"><B>getTypeFromXObject</B></A>(<A HREF="../../../../org/apache/xpath/objects/XObject.html" title="class in org.apache.xpath.objects">XObject</A> object)</PRE> | |
| <DL> | |
| <DD>Given an XObject, determine the corresponding DOM XPath type | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>type string</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isNamespaceNode(org.w3c.dom.Node)"><!-- --></A><H3> | |
| isNamespaceNode</H3> | |
| <PRE> | |
| private boolean <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.479"><B>isNamespaceNode</B></A>(org.w3c.dom.Node node)</PRE> | |
| <DL> | |
| <DD>Given a node, determine if it is a namespace node. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>node</CODE> - | |
| <DT><B>Returns:</B><DD>boolean Returns true if this is a namespace node; otherwise, returns false.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addEventListener()"><!-- --></A><H3> | |
| addEventListener</H3> | |
| <PRE> | |
| private void <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.494"><B>addEventListener</B></A>()</PRE> | |
| <DL> | |
| <DD>Add m_contextNode to Event Listner to listen for Mutations Events | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="removeEventListener()"><!-- --></A><H3> | |
| removeEventListener</H3> | |
| <PRE> | |
| private void <A HREF="../../../../src-html/org/apache/xpath/domapi/XPathResultImpl.html#line.505"><B>removeEventListener</B></A>()</PRE> | |
| <DL> | |
| <DD>Remove m_contextNode to Event Listner to listen for Mutations Events | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| </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/XPathResultImpl.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/XPathNSResolverImpl.html" title="class in org.apache.xpath.domapi"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../org/apache/xpath/domapi/XPathStylesheetDOM3Exception.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/XPathResultImpl.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="XPathResultImpl.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> |