mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/simple-api/classXQilla.html
King_DuckZ 625a590fae v1.0.2
2020-02-17 22:10:06 +01:00

413 lines
27 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 Simple API: XQilla Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- 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>XQilla Class Reference</h1><!-- doxytag: class="XQilla" --><!-- doxytag: inherits="xercesc::XMemory" -->Provides factory methods for creating <a class="el" href="classXQQuery.html">XQQuery</a> and <a class="el" href="classDynamicContext.html">DynamicContext</a> objects.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="XQilla_8hpp-source.html">XQilla.hpp</a>&gt;</code>
<p>
Inheritance diagram for XQilla:<p><center><img src="classXQilla__inherit__graph.png" border="0" usemap="#XQilla__inherit__map" alt="Inheritance graph"></center>
<map name="XQilla__inherit__map">
<area href="classxercesc_1_1XMemory.html" shape="rect" coords="5,7,152,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXQilla-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXQilla.html#7fbc185e109c8ce3da425054685e8ba1">Flags</a> { <a class="el" href="classXQilla.html#7fbc185e109c8ce3da425054685e8ba13629b3bfdf036418daad522664441e9d">NO_STATIC_RESOLUTION</a> = 0x1,
<a class="el" href="classXQilla.html#7fbc185e109c8ce3da425054685e8ba199bed3057d85109e34e9f536c30dc514">NO_ADOPT_CONTEXT</a> = 0x2
}</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Flags used by the <a class="el" href="classXQilla.html">XQilla</a> methods. These are used by bitwise OR-ing (|) their values together. <a href="classXQilla.html#7fbc185e109c8ce3da425054685e8ba1">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXQilla.html#841f488b890ff0e4d20b5000f2e1ce4d">Language</a> { <a class="el" href="classXQilla.html#841f488b890ff0e4d20b5000f2e1ce4d1ed528e9b6d99de2caebe09430dd6605">XQUERY</a>,
<a class="el" href="classXQilla.html#841f488b890ff0e4d20b5000f2e1ce4dd3c49240323fbd44cc8b7e7f18a827d2">XPATH2</a>,
<a class="el" href="classXQilla.html#841f488b890ff0e4d20b5000f2e1ce4d669939147235c3acb83b25b4425b9e4a">XQUERY_FULLTEXT</a>,
<a class="el" href="classXQilla.html#841f488b890ff0e4d20b5000f2e1ce4d83707b5b2a4f6a50e73b9f8f3cc0de25">XPATH2_FULLTEXT</a>
}</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enumeration used to select a language to parse. <a href="classXQilla.html#841f488b890ff0e4d20b5000f2e1ce4d">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXQilla.html#e7e28bb48f04c571ea172d3c0ad889f5">XQilla</a> (<a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> *memMgr=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs the object. <a href="#e7e28bb48f04c571ea172d3c0ad889f5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXQilla.html#1584110326e2a3cb34efd61d11c5b066">~XQilla</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructs the object. <a href="#1584110326e2a3cb34efd61d11c5b066"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Parsing Methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classXQQuery.html">XQQuery</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXQilla.html#d979383534f094c553ea07774ee5cd18">parse</a> (const XMLCh *query, <a class="el" href="classXQilla.html#841f488b890ff0e4d20b5000f2e1ce4d">Language</a> language=XQUERY, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context=0, const XMLCh *queryFile=NULL, unsigned int flags=0, <a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> *memMgr=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">xercesc::XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse the expression contained in the given query string. <a href="#d979383534f094c553ea07774ee5cd18"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classXQQuery.html">XQQuery</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXQilla.html#86ff026d3ef066808750f1767e25149e">parse</a> (const <a class="el" href="classxercesc_1_1InputSource.html">xercesc::InputSource</a> &amp;querySrc, <a class="el" href="classXQilla.html#841f488b890ff0e4d20b5000f2e1ce4d">Language</a> language=XQUERY, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context=0, unsigned int flags=0, <a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> *memMgr=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">xercesc::XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse the expression from the given InputSource. <a href="#86ff026d3ef066808750f1767e25149e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classXQQuery.html">XQQuery</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXQilla.html#e9b3f65d39dad6ff99cac8173ab666f9">parseFromURI</a> (const XMLCh *queryFile, <a class="el" href="classXQilla.html#841f488b890ff0e4d20b5000f2e1ce4d">Language</a> language=XQUERY, <a class="el" href="classDynamicContext.html">DynamicContext</a> *context=0, unsigned int flags=0, <a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> *memMgr=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">xercesc::XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Parse the expression residing at the given URL. <a href="#e9b3f65d39dad6ff99cac8173ab666f9"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Factory Methods</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classXQilla.html#7badb86eea503b6316db6c6d554f3d73">createContext</a> (<a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> *memMgr=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">xercesc::XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a context suitable for parsing an expression with. <a href="#7badb86eea503b6316db6c6d554f3d73"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Provides factory methods for creating <a class="el" href="classXQQuery.html">XQQuery</a> and <a class="el" href="classDynamicContext.html">DynamicContext</a> objects.
<p>
This class calls XQillaPlatformUtils::initialize() when it is constructed, and XQillaPlatformUtils::terminate() when it destructs, so there is no need to seperately initialize or terminate either Xerces or <a class="el" href="classXQilla.html">XQilla</a>.
<p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="7fbc185e109c8ce3da425054685e8ba1"></a><!-- doxytag: member="XQilla::Flags" ref="7fbc185e109c8ce3da425054685e8ba1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classXQilla.html#7fbc185e109c8ce3da425054685e8ba1">XQilla::Flags</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Flags used by the <a class="el" href="classXQilla.html">XQilla</a> methods. These are used by bitwise OR-ing (|) their values together.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="7fbc185e109c8ce3da425054685e8ba13629b3bfdf036418daad522664441e9d"></a><!-- doxytag: member="NO_STATIC_RESOLUTION" ref="7fbc185e109c8ce3da425054685e8ba13629b3bfdf036418daad522664441e9d" args="" -->NO_STATIC_RESOLUTION</em>&nbsp;</td><td>
Don't perform static resolution. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="7fbc185e109c8ce3da425054685e8ba199bed3057d85109e34e9f536c30dc514"></a><!-- doxytag: member="NO_ADOPT_CONTEXT" ref="7fbc185e109c8ce3da425054685e8ba199bed3057d85109e34e9f536c30dc514" args="" -->NO_ADOPT_CONTEXT</em>&nbsp;</td><td>
Don't adopt the context and delete it when the <a class="el" href="classXQQuery.html">XQQuery</a> is deleted. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="841f488b890ff0e4d20b5000f2e1ce4d"></a><!-- doxytag: member="XQilla::Language" ref="841f488b890ff0e4d20b5000f2e1ce4d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classXQilla.html#841f488b890ff0e4d20b5000f2e1ce4d">XQilla::Language</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Enumeration used to select a language to parse.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="841f488b890ff0e4d20b5000f2e1ce4d1ed528e9b6d99de2caebe09430dd6605"></a><!-- doxytag: member="XQUERY" ref="841f488b890ff0e4d20b5000f2e1ce4d1ed528e9b6d99de2caebe09430dd6605" args="" -->XQUERY</em>&nbsp;</td><td>
Parse an XQuery expression. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="841f488b890ff0e4d20b5000f2e1ce4dd3c49240323fbd44cc8b7e7f18a827d2"></a><!-- doxytag: member="XPATH2" ref="841f488b890ff0e4d20b5000f2e1ce4dd3c49240323fbd44cc8b7e7f18a827d2" args="" -->XPATH2</em>&nbsp;</td><td>
Parse an XPath 2.0 expression. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="841f488b890ff0e4d20b5000f2e1ce4d669939147235c3acb83b25b4425b9e4a"></a><!-- doxytag: member="XQUERY_FULLTEXT" ref="841f488b890ff0e4d20b5000f2e1ce4d669939147235c3acb83b25b4425b9e4a" args="" -->XQUERY_FULLTEXT</em>&nbsp;</td><td>
Parse an XQuery Full-Text expression. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="841f488b890ff0e4d20b5000f2e1ce4d83707b5b2a4f6a50e73b9f8f3cc0de25"></a><!-- doxytag: member="XPATH2_FULLTEXT" ref="841f488b890ff0e4d20b5000f2e1ce4d83707b5b2a4f6a50e73b9f8f3cc0de25" args="" -->XPATH2_FULLTEXT</em>&nbsp;</td><td>
Parse an XPath 2.0 Full-Text expression. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="e7e28bb48f04c571ea172d3c0ad889f5"></a><!-- doxytag: member="XQilla::XQilla" ref="e7e28bb48f04c571ea172d3c0ad889f5" args="(xercesc::MemoryManager *memMgr=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XQilla::XQilla </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> *&nbsp;</td>
<td class="paramname"> <em>memMgr</em> = <code>0</code> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructs the object.
<p>
In the process, XQillaPlatformUtils::initialize() is called to initialize <a class="el" href="classXQilla.html">XQilla</a> and Xerces.<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>memMgr</em>&nbsp;</td><td>If provided, this is the MemoryManager used to initialize Xerces. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="1584110326e2a3cb34efd61d11c5b066"></a><!-- doxytag: member="XQilla::~XQilla" ref="1584110326e2a3cb34efd61d11c5b066" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XQilla::~XQilla </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructs the object.
<p>
In the process, XQillaPlatformUtils::terminate() is called to terminate <a class="el" href="classXQilla.html">XQilla</a> and Xerces.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d979383534f094c553ea07774ee5cd18"></a><!-- doxytag: member="XQilla::parse" ref="d979383534f094c553ea07774ee5cd18" args="(const XMLCh *query, Language language=XQUERY, DynamicContext *context=0, const XMLCh *queryFile=NULL, unsigned int flags=0, xercesc::MemoryManager *memMgr=xercesc::XMLPlatformUtils::fgMemoryManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classXQQuery.html">XQQuery</a>* XQilla::parse </td>
<td>(</td>
<td class="paramtype">const XMLCh *&nbsp;</td>
<td class="paramname"> <em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXQilla.html#841f488b890ff0e4d20b5000f2e1ce4d">Language</a>&nbsp;</td>
<td class="paramname"> <em>language</em> = <code>XQUERY</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *&nbsp;</td>
<td class="paramname"> <em>queryFile</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>flags</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> *&nbsp;</td>
<td class="paramname"> <em>memMgr</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">xercesc::XMLPlatformUtils::fgMemoryManager</a></code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parse the expression contained in the given query string.
<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>query</em>&nbsp;</td><td>A string containing the expression to parse. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>language</em>&nbsp;</td><td>The language to parse the string as. Defaults to XQUERY. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>If specified, the context to use for parsing this expression. A default context is used if this parameter is 0. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>queryFile</em>&nbsp;</td><td>The name of the file that query originates in. This is passed back to the user in an <a class="el" href="classXQException.html">XQException</a> if an error occurs. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flags</em>&nbsp;</td><td>A bitwise OR of the Flags constants, that control aspects of how the <a class="el" href="classXQQuery.html">XQQuery</a> object is created. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>memMgr</em>&nbsp;</td><td>If specified, the memory manager used to create the <a class="el" href="classXQQuery.html">XQQuery</a> object.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The object that represents the parsed 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><a class="el" href="classXQException.html">XQException</a></em>&nbsp;</td><td>If a parse error occurs. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="86ff026d3ef066808750f1767e25149e"></a><!-- doxytag: member="XQilla::parse" ref="86ff026d3ef066808750f1767e25149e" args="(const xercesc::InputSource &amp;querySrc, Language language=XQUERY, DynamicContext *context=0, unsigned int flags=0, xercesc::MemoryManager *memMgr=xercesc::XMLPlatformUtils::fgMemoryManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classXQQuery.html">XQQuery</a>* XQilla::parse </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classxercesc_1_1InputSource.html">xercesc::InputSource</a> &amp;&nbsp;</td>
<td class="paramname"> <em>querySrc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXQilla.html#841f488b890ff0e4d20b5000f2e1ce4d">Language</a>&nbsp;</td>
<td class="paramname"> <em>language</em> = <code>XQUERY</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>flags</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> *&nbsp;</td>
<td class="paramname"> <em>memMgr</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">xercesc::XMLPlatformUtils::fgMemoryManager</a></code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parse the expression from the given InputSource.
<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>querySrc</em>&nbsp;</td><td>An InputSource which the expression will be parsed from. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>language</em>&nbsp;</td><td>The language to parse the string as. Defaults to XQUERY. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>If specified, the context to use for parsing this expression. A default context is used if this parameter is 0. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flags</em>&nbsp;</td><td>A bitwise OR of the Flags constants, that control aspects of how the <a class="el" href="classXQQuery.html">XQQuery</a> object is created. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>memMgr</em>&nbsp;</td><td>If specified, the memory manager used to create the <a class="el" href="classXQQuery.html">XQQuery</a> object.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The object that represents the parsed 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><a class="el" href="classXQException.html">XQException</a></em>&nbsp;</td><td>If a parse error occurs. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e9b3f65d39dad6ff99cac8173ab666f9"></a><!-- doxytag: member="XQilla::parseFromURI" ref="e9b3f65d39dad6ff99cac8173ab666f9" args="(const XMLCh *queryFile, Language language=XQUERY, DynamicContext *context=0, unsigned int flags=0, xercesc::MemoryManager *memMgr=xercesc::XMLPlatformUtils::fgMemoryManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classXQQuery.html">XQQuery</a>* XQilla::parseFromURI </td>
<td>(</td>
<td class="paramtype">const XMLCh *&nbsp;</td>
<td class="paramname"> <em>queryFile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classXQilla.html#841f488b890ff0e4d20b5000f2e1ce4d">Language</a>&nbsp;</td>
<td class="paramname"> <em>language</em> = <code>XQUERY</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDynamicContext.html">DynamicContext</a> *&nbsp;</td>
<td class="paramname"> <em>context</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int&nbsp;</td>
<td class="paramname"> <em>flags</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> *&nbsp;</td>
<td class="paramname"> <em>memMgr</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">xercesc::XMLPlatformUtils::fgMemoryManager</a></code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parse the expression residing at the given URL.
<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>queryFile</em>&nbsp;</td><td>The URL of the expression to parse. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>language</em>&nbsp;</td><td>The language to parse the string as. Defaults to XQUERY. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>context</em>&nbsp;</td><td>If specified, the context to use for parsing this expression. A default context is used if this parameter is 0. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flags</em>&nbsp;</td><td>A bitwise OR of the Flags constants, that control aspects of how the <a class="el" href="classXQQuery.html">XQQuery</a> object is created. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>memMgr</em>&nbsp;</td><td>If specified, the memory manager used to create the <a class="el" href="classXQQuery.html">XQQuery</a> object.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The object that represents the parsed 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><a class="el" href="classXQException.html">XQException</a></em>&nbsp;</td><td>If a parse error occurs. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="7badb86eea503b6316db6c6d554f3d73"></a><!-- doxytag: member="XQilla::createContext" ref="7badb86eea503b6316db6c6d554f3d73" args="(xercesc::MemoryManager *memMgr=xercesc::XMLPlatformUtils::fgMemoryManager)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classDynamicContext.html">DynamicContext</a>* XQilla::createContext </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> *&nbsp;</td>
<td class="paramname"> <em>memMgr</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#2521473ea52894e9313573d330a264b4">xercesc::XMLPlatformUtils::fgMemoryManager</a></code> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a context suitable for parsing an expression with.
<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>memMgr</em>&nbsp;</td><td>The memory manager used to create the <a class="el" href="classDynamicContext.html">DynamicContext</a>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>An implementation of <a class="el" href="classDynamicContext.html">DynamicContext</a> </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XQilla_8hpp-source.html">XQilla.hpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 12 19:14:03 2007 for XQilla Simple 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