mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/dom3-api/classXQillaExpression.html
King_DuckZ c04629cb7b v2.1.2
2020-02-17 22:14:54 +01:00

211 lines
12 KiB
HTML
Raw Blame History

<!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&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul></div>
<h1>XQillaExpression Class Reference</h1><!-- doxytag: class="XQillaExpression" --><!-- doxytag: inherits="xercesc::DOMXPathExpression" -->The <code><a class="el" href="classXQillaExpression.html">XQillaExpression</a></code> interface extends the <code>DOMXPathExpression</code> interface, providing the ability to release the object.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="XQillaExpression_8hpp-source.html">XQillaExpression.hpp</a>&gt;</code>
<p>
Inheritance diagram for XQillaExpression:<p><center><img src="classXQillaExpression__inherit__graph.png" border="0" usemap="#XQillaExpression__inherit__map" alt="Inheritance graph"></center>
<map name="XQillaExpression__inherit__map">
<area href="classxercesc_1_1DOMXPathExpression.html" shape="rect" coords="5,7,232,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXQillaExpression-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 class="memItemLeft" nowrap align="right" valign="top">virtual void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXQillaExpression.html#b8a28b7fd9bde9a70354b15730286b8f">evaluate</a> (<a class="el" href="classxercesc_1_1DOMNode.html">xercesc::DOMNode</a> *contextNode, unsigned short type, void *reuseableResult) const=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Evaluates this XPath expression and returns a result. <a href="#b8a28b7fd9bde9a70354b15730286b8f"></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&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXQillaExpression.html#6efef84a7d450b4d1d5fd7747a13ef13">release</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called to indicate that this object (and its associated children) is no longer in use and that the implementation may relinquish any resources associated with it and its associated children. <a href="#6efef84a7d450b4d1d5fd7747a13ef13"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <code><a class="el" href="classXQillaExpression.html">XQillaExpression</a></code> interface extends the <code>DOMXPathExpression</code> interface, providing the ability to release the object.
<p>
The evaluate method will always return an object of type <code><a class="el" href="classXPath2Result.html">XPath2Result</a></code> <dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 3 </dd></dl>
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="0236e8977b6247e91dd4001a6979e8fb"></a><!-- doxytag: member="XQillaExpression::~XQillaExpression" ref="0236e8977b6247e91dd4001a6979e8fb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual XQillaExpression::~XQillaExpression </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<a class="anchor" name="3c2ab78336f3e26f35472236d7f403f6"></a><!-- doxytag: member="XQillaExpression::XQillaExpression" ref="3c2ab78336f3e26f35472236d7f403f6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XQillaExpression::XQillaExpression </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="0236e8977b6247e91dd4001a6979e8fb"></a><!-- doxytag: member="XQillaExpression::~XQillaExpression" ref="0236e8977b6247e91dd4001a6979e8fb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual XQillaExpression::~XQillaExpression </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<a class="anchor" name="3c2ab78336f3e26f35472236d7f403f6"></a><!-- doxytag: member="XQillaExpression::XQillaExpression" ref="3c2ab78336f3e26f35472236d7f403f6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XQillaExpression::XQillaExpression </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b8a28b7fd9bde9a70354b15730286b8f"></a><!-- doxytag: member="XQillaExpression::evaluate" ref="b8a28b7fd9bde9a70354b15730286b8f" args="(xercesc::DOMNode *contextNode, unsigned short type, void *reuseableResult) const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void* XQillaExpression::evaluate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classxercesc_1_1DOMNode.html">xercesc::DOMNode</a> *&nbsp;</td>
<td class="paramname"> <em>contextNode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned short&nbsp;</td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>reuseableResult</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>&nbsp;</td><td>of type <code>DOMNode</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>DOMDocument</code>, <code>DOMElement</code>, <code>DOMAttribute</code>, <code>DOMText</code>, <code>DOMCDATASection</code>, <code>DOMComment</code>, <code>DOMProcessingInstruction</code>, or <code>XPathNamespace</code>. If the context node is a <code>DOMText</code> or a <code>DOMCDATASection</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>&nbsp;</td><td>of type unsigned short 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>XPathResult</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>result</em>&nbsp;</td><td>of type void* 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. For XPath 1.0 results, this object will be of type <code>XPathResult</code>. For XPath 2.0 results, this object will be of type <code><a class="el" href="classXPath2Result.html">XPath2Result</a></code>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>void* The result of the evaluation of the XPath expression. For XPath 1.0 results, this object will be of type <code>XPathResult</code>. For XPath 2.0 results, this object will be of type <code><a class="el" href="classXPath2Result.html">XPath2Result</a></code>. </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>XPathException</em>&nbsp;</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>DOMException</em>&nbsp;</td><td>WRONG_DOCUMENT_ERR: The <code>DOMNode</code> is from a document that is not supported by the <code>XPathEvaluator</code> that created this <code>DOMXPathExpression</code>. NOT_SUPPORTED_ERR: The Node is not a type permitted as an XPath context node or the request type is not permitted by this <code>DOMXPathExpression</code>. </td></tr>
</table>
</dl>
<p>
Implements <a class="el" href="classxercesc_1_1DOMXPathExpression.html#7eec9df5d8183f00d0bb969ab156f1c9">xercesc::DOMXPathExpression</a>.
</div>
</div><p>
<a class="anchor" name="6efef84a7d450b4d1d5fd7747a13ef13"></a><!-- doxytag: member="XQillaExpression::release" ref="6efef84a7d450b4d1d5fd7747a13ef13" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void XQillaExpression::release </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Called to indicate that this object (and its associated children) is no longer in use and that the implementation may relinquish any resources associated with it and its associated children.
<p>
Access to a released object will lead to unexpected result.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XQillaExpression_8hpp-source.html">XQillaExpression.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Apr 28 16:41:25 2008 for XQilla DOM Level 3 API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink