89 lines
9.1 KiB
HTML
89 lines
9.1 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.5.5 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="classes.html"><span>Classes</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<h1>ExternalFunction.hpp</h1><a href="ExternalFunction_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
|
|
<a name="l00002"></a>00002 <span class="comment"> * Copyright (c) 2001-2008</span>
|
|
<a name="l00003"></a>00003 <span class="comment"> * DecisionSoft Limited. All rights reserved.</span>
|
|
<a name="l00004"></a>00004 <span class="comment"> * Copyright (c) 2004-2008</span>
|
|
<a name="l00005"></a>00005 <span class="comment"> * Oracle. All rights reserved.</span>
|
|
<a name="l00006"></a>00006 <span class="comment"> *</span>
|
|
<a name="l00007"></a>00007 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span>
|
|
<a name="l00008"></a>00008 <span class="comment"> * you may not use this file except in compliance with the License.</span>
|
|
<a name="l00009"></a>00009 <span class="comment"> * You may obtain a copy of the License at</span>
|
|
<a name="l00010"></a>00010 <span class="comment"> *</span>
|
|
<a name="l00011"></a>00011 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
|
|
<a name="l00012"></a>00012 <span class="comment"> *</span>
|
|
<a name="l00013"></a>00013 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
|
|
<a name="l00014"></a>00014 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
|
|
<a name="l00015"></a>00015 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
|
|
<a name="l00016"></a>00016 <span class="comment"> * See the License for the specific language governing permissions and</span>
|
|
<a name="l00017"></a>00017 <span class="comment"> * limitations under the License.</span>
|
|
<a name="l00018"></a>00018 <span class="comment"> *</span>
|
|
<a name="l00019"></a>00019 <span class="comment"> * $Id: ExternalFunction.hpp 475 2008-01-08 18:47:44Z jpcs $</span>
|
|
<a name="l00020"></a>00020 <span class="comment"> */</span>
|
|
<a name="l00021"></a>00021
|
|
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef _EXTERNALFUNCTION_HPP</span>
|
|
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define _EXTERNALFUNCTION_HPP</span>
|
|
<a name="l00024"></a>00024 <span class="preprocessor"></span>
|
|
<a name="l00025"></a>00025 <span class="preprocessor">#include <xqilla/framework/XQillaExport.hpp></span>
|
|
<a name="l00026"></a>00026
|
|
<a name="l00027"></a>00027 <span class="preprocessor">#include <xercesc/util/XMLUniDefs.hpp></span>
|
|
<a name="l00028"></a>00028
|
|
<a name="l00029"></a>00029 <span class="keyword">class </span><a class="code" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a>;
|
|
<a name="l00030"></a>00030 <span class="keyword">class </span>PendingUpdateList;
|
|
<a name="l00031"></a>00031 <span class="keyword">class </span><a class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a>;
|
|
<a name="l00032"></a>00032 <span class="keyword">class </span><a class="code" href="classXPath2MemoryManager.html">XPath2MemoryManager</a>;
|
|
<a name="l00033"></a>00033
|
|
<a name="l00034"></a><a class="code" href="classExternalFunction.html">00034</a> <span class="keyword">class </span>XQILLA_API <a class="code" href="classExternalFunction.html">ExternalFunction</a>
|
|
<a name="l00035"></a>00035 {
|
|
<a name="l00036"></a>00036 <span class="keyword">public</span>:
|
|
<a name="l00037"></a><a class="code" href="classExternalFunction_1_1Arguments.html">00037</a> <span class="keyword">class </span>XQILLA_API <a class="code" href="classExternalFunction_1_1Arguments.html">Arguments</a>
|
|
<a name="l00038"></a>00038 {
|
|
<a name="l00039"></a>00039 <span class="keyword">public</span>:
|
|
<a name="l00040"></a><a class="code" href="classExternalFunction_1_1Arguments.html#e0273037d36c31b5b49c526a1e156d22">00040</a> <span class="keyword">virtual</span> ~<a class="code" href="classExternalFunction_1_1Arguments.html">Arguments</a>() {}
|
|
<a name="l00041"></a>00041
|
|
<a name="l00043"></a>00043 <span class="keyword">virtual</span> <a class="code" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a> getArgument(<span class="keywordtype">size_t</span> index, <a class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a> *context) <span class="keyword">const</span> = 0;
|
|
<a name="l00044"></a>00044 };
|
|
<a name="l00045"></a>00045
|
|
<a name="l00046"></a><a class="code" href="classExternalFunction.html#15c836af39ef9a5d79a3edbb87e22176">00046</a> <span class="keyword">virtual</span> ~<a class="code" href="classExternalFunction.html">ExternalFunction</a>() {}
|
|
<a name="l00047"></a>00047
|
|
<a name="l00048"></a><a class="code" href="classExternalFunction.html#68d2eb21c7bd8072fdfd01cd3c794fd9">00048</a> <span class="keyword">const</span> XMLCh *getURI()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> uri_; }
|
|
<a name="l00049"></a><a class="code" href="classExternalFunction.html#8bf0aa847fbcc2defbe287e277223e58">00049</a> <span class="keyword">const</span> XMLCh *getName()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> name_; }
|
|
<a name="l00050"></a><a class="code" href="classExternalFunction.html#45708d6c78ab5cbbc8e39483defeea76">00050</a> <span class="keyword">const</span> XMLCh *getURINameHash()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> uriName_; }
|
|
<a name="l00051"></a><a class="code" href="classExternalFunction.html#6edce344cc26cbee3007846c922c2973">00051</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getNumberOfArguments()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> numArgs_; }
|
|
<a name="l00052"></a>00052
|
|
<a name="l00054"></a>00054 <span class="keyword">virtual</span> <a class="code" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a> execute(<span class="keyword">const</span> Arguments *args, <a class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a> *context) <span class="keyword">const</span>;
|
|
<a name="l00056"></a>00056 <span class="keyword">virtual</span> PendingUpdateList executeUpdate(<span class="keyword">const</span> Arguments *args, <a class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a> *context) <span class="keyword">const</span>;
|
|
<a name="l00057"></a>00057
|
|
<a name="l00058"></a>00058 <span class="keyword">protected</span>:
|
|
<a name="l00059"></a>00059 <a class="code" href="classExternalFunction.html">ExternalFunction</a>(<span class="keyword">const</span> XMLCh *uri, <span class="keyword">const</span> XMLCh *name, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> numberOfArgs, <a class="code" href="classXPath2MemoryManager.html">XPath2MemoryManager</a> *mm);
|
|
<a name="l00060"></a>00060
|
|
<a name="l00061"></a><a class="code" href="classExternalFunction.html#7707c9ebb2cbc37e915b849ffce4371f">00061</a> <span class="keyword">const</span> XMLCh *uri_;
|
|
<a name="l00062"></a><a class="code" href="classExternalFunction.html#9e666ea401b178e10ab3c0799b3270bd">00062</a> <span class="keyword">const</span> XMLCh *name_;
|
|
<a name="l00063"></a><a class="code" href="classExternalFunction.html#0ad0a21279823e2a038364827e859725">00063</a> <span class="keyword">const</span> XMLCh *uriName_;
|
|
<a name="l00064"></a><a class="code" href="classExternalFunction.html#c4803adcaf53f91a84e6a83c25571cf5">00064</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> numArgs_;
|
|
<a name="l00065"></a>00065 };
|
|
<a name="l00066"></a>00066
|
|
<a name="l00067"></a>00067 <span class="preprocessor">#endif</span>
|
|
<a name="l00068"></a>00068 <span class="preprocessor"></span>
|
|
</pre></div></div>
|
|
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jan 5 19:53:55 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.5.5 </small></address>
|
|
</body>
|
|
</html>
|