494 lines
27 KiB
HTML
494 lines
27 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 Simple 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>XQilla Class Reference</h1>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 <<a class="el" href="XQilla_8hpp-source.html">XQilla.hpp</a>></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,136,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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classXQilla.html#w15">Flags</a> { <a class="el" href="classXQilla.html#w15w0">NO_STATIC_RESOLUTION</a> = 0x1,
|
|
<a class="el" href="classXQilla.html#w15w1">NO_ADOPT_CONTEXT</a> = 0x2,
|
|
<a class="el" href="classXQilla.html#w15w2">DEBUG_QUERY</a> = 0x4,
|
|
<a class="el" href="classXQilla.html#w15w3">NO_OPTIMIZATION</a> = 0x8
|
|
}</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flags used by the XQilla methods. These are used by bitwise OR-ing (|) their values together. <a href="#w15">More...</a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classXQilla.html#w16">Language</a> { <br>
|
|
<a class="el" href="classXQilla.html#w16w4">XQUERY</a> = 0x00,
|
|
<a class="el" href="classXQilla.html#w16w5">XPATH2</a> = 0x01,
|
|
<a class="el" href="classXQilla.html#w16w6">FULLTEXT</a> = 0x02,
|
|
<a class="el" href="classXQilla.html#w16w7">UPDATE</a> = 0x04,
|
|
<br>
|
|
<a class="el" href="classXQilla.html#w16w8">EXTENSIONS</a> = 0x08,
|
|
<a class="el" href="classXQilla.html#w16w9">XSLT2</a> = 0x10,
|
|
<a class="el" href="classXQilla.html#w16w10">XQUERY_FULLTEXT</a> = (XQUERY | FULLTEXT),
|
|
<a class="el" href="classXQilla.html#w16w11">XPATH2_FULLTEXT</a> = (XPATH2 | FULLTEXT),
|
|
<br>
|
|
<a class="el" href="classXQilla.html#w16w12">XQUERY_UPDATE</a> = (XQUERY | UPDATE),
|
|
<a class="el" href="classXQilla.html#w16w13">XQUERY_FULLTEXT_UPDATE</a> = (XQUERY | FULLTEXT | UPDATE),
|
|
<a class="el" href="classXQilla.html#w16w14">XSLT2_FULLTEXT</a> = (XSLT2 | FULLTEXT)
|
|
<br>
|
|
}</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enumeration used to select a language to parse. <a href="#w16">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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXQilla.html#a0">XQilla</a> (<a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> *memMgr=0)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs the object. <a href="#a0"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classXQilla.html#a1">~XQilla</a> ()</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructs the object. <a href="#a1"></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"><a class="el" href="classXQQuery.html">XQQuery</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXQilla.html#z1_0">parse</a> (const XMLCh *query, <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#z73_4">xercesc::XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse the expression contained in the given query string. <a href="#z1_0"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXQQuery.html">XQQuery</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXQilla.html#z1_1">parse</a> (const <a class="el" href="classxercesc_1_1InputSource.html">xercesc::InputSource</a> &querySrc, <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#z73_4">xercesc::XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse the expression from the given InputSource. <a href="#z1_1"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXQQuery.html">XQQuery</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXQilla.html#z1_2">parseFromURI</a> (const XMLCh *queryFile, <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#z73_4">xercesc::XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse the expression residing at the given URL. <a href="#z1_2"></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"><a class="el" href="classDynamicContext.html">DynamicContext</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classXQilla.html#z3_0">createContext</a> (<a class="el" href="classXQilla.html#w16">Language</a> language=XQUERY, <a class="el" href="classXQillaConfiguration.html">XQillaConfiguration</a> *conf=0, <a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> *memMgr=<a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z73_4">xercesc::XMLPlatformUtils::fgMemoryManager</a>)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a context suitable for parsing an expression with. <a href="#z3_0"></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 XQilla. <dl compact><dt><b>Examples: </b></dt><dd>
|
|
|
|
<p>
|
|
<a class="el" href="simple-basic_8cpp-example.html#_a0">simple-basic.cpp</a>, and <a class="el" href="simple-context-item_8cpp-example.html#_a5">simple-context-item.cpp</a>.</dl>
|
|
<p>
|
|
<hr><h2>Member Enumeration Documentation</h2>
|
|
<a class="anchor" name="w15" doxytag="XQilla::Flags"></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">enum <a class="el" href="classXQilla.html#w15">XQilla::Flags</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Flags used by the XQilla methods. These are used by bitwise OR-ing (|) their values together.
|
|
<p>
|
|
<dl compact><dt><b>Enumeration values: </b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"><em><a class="anchor" name="w15w0" doxytag="NO_STATIC_RESOLUTION"></a>NO_STATIC_RESOLUTION</em> </td><td>
|
|
Don't perform static resolution or any optimization. </td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="w15w1" doxytag="NO_ADOPT_CONTEXT"></a>NO_ADOPT_CONTEXT</em> </td><td>
|
|
Don't adopt the context and delete it when the <a class="el" href="classXQQuery.html">XQQuery</a> is deleted. </td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="w15w2" doxytag="DEBUG_QUERY"></a>DEBUG_QUERY</em> </td><td>
|
|
Build debugging hooks into the query to enable the use of <a class="el" href="classDebugListener.html">DebugListener</a>. </td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="w15w3" doxytag="NO_OPTIMIZATION"></a>NO_OPTIMIZATION</em> </td><td>
|
|
Don't perform optimization. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="w16" doxytag="XQilla::Language"></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">enum <a class="el" href="classXQilla.html#w16">XQilla::Language</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Enumeration used to select a language to parse.
|
|
<p>
|
|
<dl compact><dt><b>Enumeration values: </b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"><em><a class="anchor" name="w16w4" doxytag="XQUERY"></a>XQUERY</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="w16w5" doxytag="XPATH2"></a>XPATH2</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="w16w6" doxytag="FULLTEXT"></a>FULLTEXT</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="w16w7" doxytag="UPDATE"></a>UPDATE</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="w16w8" doxytag="EXTENSIONS"></a>EXTENSIONS</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="w16w9" doxytag="XSLT2"></a>XSLT2</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="w16w10" doxytag="XQUERY_FULLTEXT"></a>XQUERY_FULLTEXT</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="w16w11" doxytag="XPATH2_FULLTEXT"></a>XPATH2_FULLTEXT</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="w16w12" doxytag="XQUERY_UPDATE"></a>XQUERY_UPDATE</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="w16w13" doxytag="XQUERY_FULLTEXT_UPDATE"></a>XQUERY_FULLTEXT_UPDATE</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="w16w14" doxytag="XSLT2_FULLTEXT"></a>XSLT2_FULLTEXT</em> </td><td>
|
|
</td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="a0" doxytag="XQilla::XQilla"></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">XQilla::XQilla </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>memMgr</em> = <code>0</code> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Constructs the object.
|
|
<p>
|
|
In the process, XQillaPlatformUtils::initialize() is called to initialize XQilla 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> </td><td>If provided, this is the MemoryManager used to initialize Xerces. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a1" doxytag="XQilla::~XQilla"></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">XQilla::~<a class="el" href="classXQilla.html">XQilla</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></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Destructs the object.
|
|
<p>
|
|
In the process, XQillaPlatformUtils::terminate() is called to terminate XQilla and Xerces. </td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="z3_0" doxytag="XQilla::createContext"></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"><a class="el" href="classDynamicContext.html">DynamicContext</a>* XQilla::createContext </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="classXQilla.html#w16">Language</a> </td>
|
|
<td class="mdname" nowrap> <em>language</em> = <code>XQUERY</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classXQillaConfiguration.html">XQillaConfiguration</a> * </td>
|
|
<td class="mdname" nowrap> <em>conf</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> * </td>
|
|
<td class="mdname" nowrap> <em>memMgr</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z73_4">xercesc::XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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> </td><td>The memory manager used to create the <a class="el" href="classDynamicContext.html">DynamicContext</a>. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>An implementation of <a class="el" href="classDynamicContext.html">DynamicContext</a> </dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z1_1" doxytag="XQilla::parse"></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"><a class="el" href="classXQQuery.html">XQQuery</a>* XQilla::parse </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const <a class="el" href="classxercesc_1_1InputSource.html">xercesc::InputSource</a> & </td>
|
|
<td class="mdname" nowrap> <em>querySrc</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classDynamicContext.html">DynamicContext</a> * </td>
|
|
<td class="mdname" nowrap> <em>context</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>unsigned int </td>
|
|
<td class="mdname" nowrap> <em>flags</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> * </td>
|
|
<td class="mdname" nowrap> <em>memMgr</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z73_4">xercesc::XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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> </td><td>An InputSource which the expression will be parsed from. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>context</em> </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> </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> </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 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>XQException</em> </td><td>If a parse error occurs. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z1_0" doxytag="XQilla::parse"></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"><a class="el" href="classXQQuery.html">XQQuery</a>* XQilla::parse </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const XMLCh * </td>
|
|
<td class="mdname" nowrap> <em>query</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classDynamicContext.html">DynamicContext</a> * </td>
|
|
<td class="mdname" nowrap> <em>context</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>const XMLCh * </td>
|
|
<td class="mdname" nowrap> <em>queryFile</em> = <code>NULL</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>unsigned int </td>
|
|
<td class="mdname" nowrap> <em>flags</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> * </td>
|
|
<td class="mdname" nowrap> <em>memMgr</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z73_4">xercesc::XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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> </td><td>A string containing the expression to parse. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>context</em> </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> </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> </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> </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 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>XQException</em> </td><td>If a parse error occurs. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Examples: </b></dt><dd>
|
|
<a class="el" href="simple-basic_8cpp-example.html#a2">simple-basic.cpp</a>, and <a class="el" href="simple-context-item_8cpp-example.html#a7">simple-context-item.cpp</a>.</dl> </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="z1_2" doxytag="XQilla::parseFromURI"></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"><a class="el" href="classXQQuery.html">XQQuery</a>* XQilla::parseFromURI </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const XMLCh * </td>
|
|
<td class="mdname" nowrap> <em>queryFile</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classDynamicContext.html">DynamicContext</a> * </td>
|
|
<td class="mdname" nowrap> <em>context</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>unsigned int </td>
|
|
<td class="mdname" nowrap> <em>flags</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap><a class="el" href="classxercesc_1_1MemoryManager.html">xercesc::MemoryManager</a> * </td>
|
|
<td class="mdname" nowrap> <em>memMgr</em> = <code><a class="el" href="classxercesc_1_1XMLPlatformUtils.html#z73_4">xercesc::XMLPlatformUtils::fgMemoryManager</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"><code> [static]</code></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<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> </td><td>The URL of the expression to parse. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>context</em> </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> </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> </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 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>XQException</em> </td><td>If a parse error occurs. </td></tr>
|
|
</table>
|
|
</dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<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 Fri Sep 25 06:55:42 2009 for XQilla Simple 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>
|