XQuilla/docs/simple-api/EventGenerator_8hpp-source.html
2020-02-17 22:17:06 +01:00

102 lines
11 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&amp;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&nbsp;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>EventGenerator.hpp</h1><a href="EventGenerator_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: EventGenerator.hpp 639 2008-09-01 13:22:54Z 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 _EVENTGENERATOR_HPP</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define _EVENTGENERATOR_HPP</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;xqilla/framework/XQillaExport.hpp&gt;</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;<a class="code" href="ReferenceCounted_8hpp.html">xqilla/framework/ReferenceCounted.hpp</a>&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;<a class="code" href="ResultImpl_8hpp.html">xqilla/runtime/ResultImpl.hpp</a>&gt;</span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">class </span><a class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a>;
<a name="l00030"></a>00030 <span class="keyword">class </span><a class="code" href="classEventHandler.html">EventHandler</a>;
<a name="l00031"></a>00031 <span class="keyword">class </span>ASTNode;
<a name="l00032"></a>00032 <span class="keyword">class </span>QueryPathNode;
<a name="l00033"></a>00033
<a name="l00034"></a><a class="code" href="classEventGenerator.html">00034</a> <span class="keyword">class </span>XQILLA_API <a class="code" href="classEventGenerator.html">EventGenerator</a> : <span class="keyword">public</span> <a class="code" href="classReferenceCounted.html" title="Super class for reference counted classes.">ReferenceCounted</a>
<a name="l00035"></a>00035 {
<a name="l00036"></a>00036 <span class="keyword">public</span>:
<a name="l00037"></a><a class="code" href="classEventGenerator.html#e6e5557a3042765b3be5e6d7136280fe">00037</a> <span class="keyword">typedef</span> <a class="code" href="classRefCountPointer.html" title="Super class of all the reference counted wrappers for Items.">RefCountPointer&lt;EventGenerator&gt;</a> <a class="code" href="classRefCountPointer.html" title="Super class of all the reference counted wrappers for Items.">Ptr</a>;
<a name="l00038"></a>00038
<a name="l00039"></a><a class="code" href="classEventGenerator.html#65ef84c1033c722593ce41386efe679a">00039</a> <span class="keyword">virtual</span> ~<a class="code" href="classEventGenerator.html">EventGenerator</a>() {}
<a name="l00040"></a>00040
<a name="l00043"></a>00043 <span class="keyword">virtual</span> <a class="code" href="classRefCountPointer.html" title="Super class of all the reference counted wrappers for Items.">EventGenerator::Ptr</a> generateEvents(<a class="code" href="classEventHandler.html">EventHandler</a> *events, <a class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a> *context) = 0;
<a name="l00044"></a>00044
<a name="l00045"></a><a class="code" href="classEventGenerator.html#f5706f4d964a19492fed64cb14a9eb73">00045</a> <span class="keyword">static</span> <span class="keywordtype">void</span> generateAndTailCall(<span class="keyword">const</span> <a class="code" href="classRefCountPointer.html" title="Super class of all the reference counted wrappers for Items.">EventGenerator::Ptr</a> &amp;generator, <a class="code" href="classEventHandler.html">EventHandler</a> *events,
<a name="l00046"></a>00046 <a class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a> *context)
<a name="l00047"></a>00047 {
<a name="l00048"></a>00048 <a class="code" href="classRefCountPointer.html" title="Super class of all the reference counted wrappers for Items.">EventGenerator::Ptr</a> gen = generator;
<a name="l00049"></a>00049 <span class="keywordflow">while</span>(gen.<a class="code" href="classRefCountPointer.html#1de8e3bd6a0af6661047049983243e1c">notNull</a>()) {
<a name="l00050"></a>00050 gen = gen-&gt;generateEvents(events, context);
<a name="l00051"></a>00051 }
<a name="l00052"></a>00052 }
<a name="l00053"></a>00053
<a name="l00054"></a>00054 };
<a name="l00055"></a>00055
<a name="l00056"></a><a class="code" href="classASTNodeEventGenerator.html">00056</a> <span class="keyword">class </span>XQILLA_API <a class="code" href="classASTNodeEventGenerator.html">ASTNodeEventGenerator</a> : <span class="keyword">public</span> <a class="code" href="classEventGenerator.html">EventGenerator</a>
<a name="l00057"></a>00057 {
<a name="l00058"></a>00058 <span class="keyword">public</span>:
<a name="l00059"></a>00059 <a class="code" href="classASTNodeEventGenerator.html">ASTNodeEventGenerator</a>(<span class="keyword">const</span> ASTNode *ast, <span class="keywordtype">bool</span> preserveNS, <span class="keywordtype">bool</span> preserveType);
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="keyword">virtual</span> <a class="code" href="classRefCountPointer.html" title="Super class of all the reference counted wrappers for Items.">EventGenerator::Ptr</a> <a class="code" href="classEventGenerator.html#067ad4ae2db64171737fd6c1e538f90e" title="Returns the result of this expression via the EventHandler provided.">generateEvents</a>(<a class="code" href="classEventHandler.html">EventHandler</a> *events, <a class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a> *context);
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="keyword">protected</span>:
<a name="l00064"></a><a class="code" href="classASTNodeEventGenerator.html#5090d55d1f185291bd45cee4d32c5b3b">00064</a> <span class="keyword">const</span> ASTNode *ast_;
<a name="l00065"></a><a class="code" href="classASTNodeEventGenerator.html#0a90882b1e31984d57a322a5fce8a015">00065</a> <span class="keywordtype">bool</span> preserveNS_, preserveType_;
<a name="l00066"></a>00066 };
<a name="l00067"></a>00067
<a name="l00068"></a><a class="code" href="classGenerateEventsResult.html">00068</a> <span class="keyword">class </span>XQILLA_API <a class="code" href="classGenerateEventsResult.html">GenerateEventsResult</a> : <span class="keyword">public</span> <a class="code" href="classResultImpl.html" title="A lazily evaluated query result.">ResultImpl</a>
<a name="l00069"></a>00069 {
<a name="l00070"></a>00070 <span class="keyword">public</span>:
<a name="l00071"></a>00071 <a class="code" href="classGenerateEventsResult.html">GenerateEventsResult</a>(<span class="keyword">const</span> ASTNode *ast, <span class="keyword">const</span> QueryPathNode *projection);
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="keyword">virtual</span> <a class="code" href="classRefCountPointer.html" title="Super class of all the reference counted wrappers for Items.">Item::Ptr</a> <a class="code" href="classResultImpl.html#8f095d8add3f386c32a9580524c44ae3" title="Gets the next item, or returns a tail call Result which will give the next item.">nextOrTail</a>(<a class="code" href="classResult.html" title="A scoped pointer wrapper for the lazily evaluated query result.">Result</a> &amp;tail, <a class="code" href="classDynamicContext.html" title="The execution time dynamic context interface.">DynamicContext</a> *context);
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="keyword">private</span>:
<a name="l00076"></a>00076 <span class="keyword">const</span> ASTNode *ast_;
<a name="l00077"></a>00077 <span class="keyword">const</span> QueryPathNode *projection_;
<a name="l00078"></a>00078 };
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jan 5 19:53:54 2009 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.5 </small></address>
</body>
</html>