199 lines
13 KiB
HTML
199 lines
13 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>XQilla DOM3 API Documentation</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&type=2" border="0" alt="SourceForge.net Logo" /></a>
|
|
<!-- Generated by Doxygen 1.3.9.1 -->
|
|
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
|
|
<h1>xercesc::DOMXPathExpression Class Reference</h1>The <code><a class="el" href="classxercesc_1_1DOMXPathExpression.html">DOMXPathExpression</a></code> interface represents a parsed and resolved XPath expression.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#include <<a class="el" href="DOMXPathExpression_8hpp-source.html">DOMXPathExpression.hpp</a>></code>
|
|
<p>
|
|
Inheritance diagram for xercesc::DOMXPathExpression:<p><center><img src="classxercesc_1_1DOMXPathExpression__inherit__graph.png" border="0" usemap="#xercesc_1_1DOMXPathExpression__inherit__map" alt="Inheritance graph"></center>
|
|
<map name="xercesc_1_1DOMXPathExpression__inherit__map">
|
|
<area href="classXQillaExpression.html" shape="rect" coords="47,81,169,105" alt="">
|
|
</map>
|
|
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classxercesc_1_1DOMXPathExpression-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td></td></tr>
|
|
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMXPathExpression.html#z486_0">~DOMXPathExpression</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#z486_0"></a><br></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 3</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMXPathResult.html">DOMXPathResult</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMXPathExpression.html#z488_0">evaluate</a> (const <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> *contextNode, <a class="el" href="classxercesc_1_1DOMXPathResult.html#z516_0">DOMXPathResult::ResultType</a> type, <a class="el" href="classxercesc_1_1DOMXPathResult.html">DOMXPathResult</a> *result) const =0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Evaluates this XPath expression and returns a result. <a href="#z488_0"></a><br></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Non-standard Extension</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMXPathExpression.html#z490_0">release</a> ()=0</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called to indicate that this <a class="el" href="classxercesc_1_1DOMXPathExpression.html">DOMXPathExpression</a> is no longer in use and that the implementation may relinquish any resources associated with it. <a href="#z490_0"></a><br></td></tr>
|
|
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMXPathExpression.html#z482_0">DOMXPathExpression</a> ()</td></tr>
|
|
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
The <code><a class="el" href="classxercesc_1_1DOMXPathExpression.html">DOMXPathExpression</a></code> interface represents a parsed and resolved XPath expression.
|
|
<p>
|
|
<dl compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
|
|
|
|
<p>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="z482_0" doxytag="xercesc::DOMXPathExpression::DOMXPathExpression"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">xercesc::DOMXPathExpression::DOMXPathExpression </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [inline, protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z486_0" doxytag="xercesc::DOMXPathExpression::~DOMXPathExpression"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">virtual xercesc::DOMXPathExpression::~<a class="el" href="classxercesc_1_1DOMXPathExpression.html">DOMXPathExpression</a> </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Destructor.
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="z488_0" doxytag="xercesc::DOMXPathExpression::evaluate"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">virtual <a class="el" href="classxercesc_1_1DOMXPathResult.html">DOMXPathResult</a>* xercesc::DOMXPathExpression::evaluate </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> * </td>
|
|
<td class="mdname" nowrap> <em>contextNode</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1DOMXPathResult.html#z516_0">DOMXPathResult::ResultType</a> </td>
|
|
<td class="mdname" nowrap> <em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1DOMXPathResult.html">DOMXPathResult</a> * </td>
|
|
<td class="mdname" nowrap> <em>result</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"> const<code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Evaluates this XPath expression and returns a result.
|
|
<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>contextNode</em> </td><td>of type <code><a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a></code> The context is context node for the evaluation of this XPath expression. If the XPathEvaluator was obtained by casting the Document then this must be owned by the same document and must be a <code><a class="el" href="classxercesc_1_1DOMDocument.html">DOMDocument</a></code>, <code><a class="el" href="classxercesc_1_1DOMElement.html">DOMElement</a></code>, <code>DOMAttribute</code>, <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code>, <code><a class="el" href="classxercesc_1_1DOMCDATASection.html">DOMCDATASection</a></code>, <code><a class="el" href="classxercesc_1_1DOMComment.html">DOMComment</a></code>, <code><a class="el" href="classxercesc_1_1DOMProcessingInstruction.html">DOMProcessingInstruction</a></code>, or <code>XPathNamespace</code>. If the context node is a <code><a class="el" href="classxercesc_1_1DOMText.html">DOMText</a></code> or a <code><a class="el" href="classxercesc_1_1DOMCDATASection.html">DOMCDATASection</a></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. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>If a specific type 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><a class="el" href="classxercesc_1_1DOMXPathResult.html">DOMXPathResult</a></code>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>result</em> </td><td>of type DOMXPathResult* The result specifies a specific result object which may be reused and returned by this method. If this is specified as nullor the implementation does not reuse the specified result, a new result object will be constructed and returned. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>DOMXPathResult* The result of the evaluation of the XPath expression. </dd></dl>
|
|
<dl compact><dt><b>Exceptions:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em><code>DOMXPathException</code></em> </td><td>TYPE_ERR: Raised if the result cannot be converted to return the specified type. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em><code>DOMException</code></em> </td><td>WRONG_DOCUMENT_ERR: The <code><a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a></code> is from a document that is not supported by the <code>XPathEvaluator</code> that created this <code><a class="el" href="classxercesc_1_1DOMXPathExpression.html">DOMXPathExpression</a></code>. NOT_SUPPORTED_ERR: The <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> is not a type permitted as an XPath context node or the request type is not permitted by this <code><a class="el" href="classxercesc_1_1DOMXPathExpression.html">DOMXPathExpression</a></code>. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z490_0" doxytag="xercesc::DOMXPathExpression::release"></a><p>
|
|
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">virtual void xercesc::DOMXPathExpression::release </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Called to indicate that this <a class="el" href="classxercesc_1_1DOMXPathExpression.html">DOMXPathExpression</a> is no longer in use and that the implementation may relinquish any resources associated with it.
|
|
<p>
|
|
Access to a released object will lead to unexpected result.
|
|
<p>
|
|
Implemented in <a class="el" href="classXQillaExpression.html#z13_0">XQillaExpression</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="DOMXPathExpression_8hpp-source.html">DOMXPathExpression.hpp</a></ul>
|
|
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 25 06:55:56 2009 for XQilla DOM Level 3 API by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address>
|
|
</body>
|
|
</html>
|