PageRenderTime 50ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 0ms

/javadoc/3.1.2/core/org/sqlproc/engine/plugin/SqlSequencePlugin.html

https://github.com/hudec/hudec.github.com
HTML | 248 lines | 205 code | 1 blank | 42 comment | 0 complexity | 9eb836203cdf7f4f70b41cecb9599369 MD5 | raw file
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (version 1.7.0_80) on Sat Jan 02 15:07:00 CET 2016 -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. <title>SqlSequencePlugin (SQL Processor, Core Module 3.1.2 API)</title>
  8. <meta name="date" content="2016-01-02">
  9. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. if (location.href.indexOf('is-external=true') == -1) {
  14. parent.document.title="SqlSequencePlugin (SQL Processor, Core Module 3.1.2 API)";
  15. }
  16. //-->
  17. </script>
  18. <noscript>
  19. <div>JavaScript is disabled on your browser.</div>
  20. </noscript>
  21. <!-- ========= START OF TOP NAVBAR ======= -->
  22. <div class="topNav"><a name="navbar_top">
  23. <!-- -->
  24. </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
  25. <!-- -->
  26. </a>
  27. <ul class="navList" title="Navigation">
  28. <li><a href="../../../../overview-summary.html">Overview</a></li>
  29. <li><a href="package-summary.html">Package</a></li>
  30. <li class="navBarCell1Rev">Class</li>
  31. <li><a href="class-use/SqlSequencePlugin.html">Use</a></li>
  32. <li><a href="package-tree.html">Tree</a></li>
  33. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  34. <li><a href="../../../../index-all.html">Index</a></li>
  35. <li><a href="../../../../help-doc.html">Help</a></li>
  36. </ul>
  37. </div>
  38. <div class="subNav">
  39. <ul class="navList">
  40. <li><a href="../../../../org/sqlproc/engine/plugin/SqlPluginFactory.html" title="interface in org.sqlproc.engine.plugin"><span class="strong">Prev Class</span></a></li>
  41. <li>Next Class</li>
  42. </ul>
  43. <ul class="navList">
  44. <li><a href="../../../../index.html?org/sqlproc/engine/plugin/SqlSequencePlugin.html" target="_top">Frames</a></li>
  45. <li><a href="SqlSequencePlugin.html" target="_top">No Frames</a></li>
  46. </ul>
  47. <ul class="navList" id="allclasses_navbar_top">
  48. <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
  49. </ul>
  50. <div>
  51. <script type="text/javascript"><!--
  52. allClassesLink = document.getElementById("allclasses_navbar_top");
  53. if(window==top) {
  54. allClassesLink.style.display = "block";
  55. }
  56. else {
  57. allClassesLink.style.display = "none";
  58. }
  59. //-->
  60. </script>
  61. </div>
  62. <div>
  63. <ul class="subNavList">
  64. <li>Summary:&nbsp;</li>
  65. <li>Nested&nbsp;|&nbsp;</li>
  66. <li>Field&nbsp;|&nbsp;</li>
  67. <li>Constr&nbsp;|&nbsp;</li>
  68. <li><a href="#method_summary">Method</a></li>
  69. </ul>
  70. <ul class="subNavList">
  71. <li>Detail:&nbsp;</li>
  72. <li>Field&nbsp;|&nbsp;</li>
  73. <li>Constr&nbsp;|&nbsp;</li>
  74. <li><a href="#method_detail">Method</a></li>
  75. </ul>
  76. </div>
  77. <a name="skip-navbar_top">
  78. <!-- -->
  79. </a></div>
  80. <!-- ========= END OF TOP NAVBAR ========= -->
  81. <!-- ======== START OF CLASS DATA ======== -->
  82. <div class="header">
  83. <div class="subTitle">org.sqlproc.engine.plugin</div>
  84. <h2 title="Interface SqlSequencePlugin" class="title">Interface SqlSequencePlugin</h2>
  85. </div>
  86. <div class="contentContainer">
  87. <div class="description">
  88. <ul class="blockList">
  89. <li class="blockList">
  90. <dl>
  91. <dt>All Superinterfaces:</dt>
  92. <dd><a href="../../../../org/sqlproc/engine/plugin/Modifiers.html" title="interface in org.sqlproc.engine.plugin">Modifiers</a></dd>
  93. </dl>
  94. <dl>
  95. <dt>All Known Implementing Classes:</dt>
  96. <dd><a href="../../../../org/sqlproc/engine/plugin/DefaultSqlPlugins.html" title="class in org.sqlproc.engine.plugin">DefaultSqlPlugins</a></dd>
  97. </dl>
  98. <hr>
  99. <br>
  100. <pre>public interface <span class="strong">SqlSequencePlugin</span>
  101. extends <a href="../../../../org/sqlproc/engine/plugin/Modifiers.html" title="interface in org.sqlproc.engine.plugin">Modifiers</a></pre>
  102. <div class="block">The SQL Processor plugin devoted to the sequence SELECT SQL construction.
  103. There are utilized the patterns from the <a href="../../../../org/sqlproc/engine/SqlFeature.html" title="enum in org.sqlproc.engine"><code>SqlFeature</code></a>. These pattern have to be combined with the sequence name
  104. used in the META SQL query in the next way:
  105. <ul>
  106. <li>$n is the name of the sequence from the META SQL query</li>
  107. </ul></div>
  108. <dl><dt><span class="strong">Author:</span></dt>
  109. <dd><a href="mailto:Vladimir.Hudec@gmail.com">Vladimir Hudec</a></dd></dl>
  110. </li>
  111. </ul>
  112. </div>
  113. <div class="summary">
  114. <ul class="blockList">
  115. <li class="blockList">
  116. <!-- =========== FIELD SUMMARY =========== -->
  117. <ul class="blockList">
  118. <li class="blockList"><a name="field_summary">
  119. <!-- -->
  120. </a>
  121. <h3>Field Summary</h3>
  122. <ul class="blockList">
  123. <li class="blockList"><a name="fields_inherited_from_class_org.sqlproc.engine.plugin.Modifiers">
  124. <!-- -->
  125. </a>
  126. <h3>Fields inherited from interface&nbsp;org.sqlproc.engine.plugin.<a href="../../../../org/sqlproc/engine/plugin/Modifiers.html" title="interface in org.sqlproc.engine.plugin">Modifiers</a></h3>
  127. <code><a href="../../../../org/sqlproc/engine/plugin/Modifiers.html#MODIFIER_ANY">MODIFIER_ANY</a>, <a href="../../../../org/sqlproc/engine/plugin/Modifiers.html#MODIFIER_ANYSET">MODIFIER_ANYSET</a>, <a href="../../../../org/sqlproc/engine/plugin/Modifiers.html#MODIFIER_CALL">MODIFIER_CALL</a>, <a href="../../../../org/sqlproc/engine/plugin/Modifiers.html#MODIFIER_DISCRIMINATOR">MODIFIER_DISCRIMINATOR</a>, <a href="../../../../org/sqlproc/engine/plugin/Modifiers.html#MODIFIER_EMPTY">MODIFIER_EMPTY</a>, <a href="../../../../org/sqlproc/engine/plugin/Modifiers.html#MODIFIER_GTYPE">MODIFIER_GTYPE</a>, <a href="../../../../org/sqlproc/engine/plugin/Modifiers.html#MODIFIER_ID">MODIFIER_ID</a>, <a href="../../../../org/sqlproc/engine/plugin/Modifiers.html#MODIFIER_IDENTITY_GENERATOR">MODIFIER_IDENTITY_GENERATOR</a>, <a href="../../../../org/sqlproc/engine/plugin/Modifiers.html#MODIFIER_IDENTITY_SELECT">MODIFIER_IDENTITY_SELECT</a>, <a href="../../../../org/sqlproc/engine/plugin/Modifiers.html#MODIFIER_NOTEMPTY">MODIFIER_NOTEMPTY</a>, <a href="../../../../org/sqlproc/engine/plugin/Modifiers.html#MODIFIER_NOTNULL">MODIFIER_NOTNULL</a>, <a href="../../../../org/sqlproc/engine/plugin/Modifiers.html#MODIFIER_NULL">MODIFIER_NULL</a>, <a href="../../../../org/sqlproc/engine/plugin/Modifiers.html#MODIFIER_SEQUENCE">MODIFIER_SEQUENCE</a>, <a href="../../../../org/sqlproc/engine/plugin/Modifiers.html#MODIFIER_TYPE">MODIFIER_TYPE</a></code></li>
  128. </ul>
  129. </li>
  130. </ul>
  131. <!-- ========== METHOD SUMMARY =========== -->
  132. <ul class="blockList">
  133. <li class="blockList"><a name="method_summary">
  134. <!-- -->
  135. </a>
  136. <h3>Method Summary</h3>
  137. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  138. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  139. <tr>
  140. <th class="colFirst" scope="col">Modifier and Type</th>
  141. <th class="colLast" scope="col">Method and Description</th>
  142. </tr>
  143. <tr class="altColor">
  144. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
  145. <td class="colLast"><code><strong><a href="../../../../org/sqlproc/engine/plugin/SqlSequencePlugin.html#sequenceSelect(org.sqlproc.engine.SqlRuntimeContext,%20java.lang.String)">sequenceSelect</a></strong>(<a href="../../../../org/sqlproc/engine/SqlRuntimeContext.html" title="interface in org.sqlproc.engine">SqlRuntimeContext</a>&nbsp;runtimeCtx,
  146. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;sequenceName)</code>
  147. <div class="block">Used to construct the sequence SELECT SQL.</div>
  148. </td>
  149. </tr>
  150. </table>
  151. </li>
  152. </ul>
  153. </li>
  154. </ul>
  155. </div>
  156. <div class="details">
  157. <ul class="blockList">
  158. <li class="blockList">
  159. <!-- ============ METHOD DETAIL ========== -->
  160. <ul class="blockList">
  161. <li class="blockList"><a name="method_detail">
  162. <!-- -->
  163. </a>
  164. <h3>Method Detail</h3>
  165. <a name="sequenceSelect(org.sqlproc.engine.SqlRuntimeContext, java.lang.String)">
  166. <!-- -->
  167. </a>
  168. <ul class="blockListLast">
  169. <li class="blockList">
  170. <h4>sequenceSelect</h4>
  171. <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;sequenceSelect(<a href="../../../../org/sqlproc/engine/SqlRuntimeContext.html" title="interface in org.sqlproc.engine">SqlRuntimeContext</a>&nbsp;runtimeCtx,
  172. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;sequenceName)</pre>
  173. <div class="block">Used to construct the sequence SELECT SQL.</div>
  174. <dl><dt><span class="strong">Parameters:</span></dt><dd><code>runtimeCtx</code> - the public runtime context</dd><dd><code>sequenceName</code> - the sequence name</dd>
  175. <dt><span class="strong">Returns:</span></dt><dd>the final sequence SELECT SQL</dd></dl>
  176. </li>
  177. </ul>
  178. </li>
  179. </ul>
  180. </li>
  181. </ul>
  182. </div>
  183. </div>
  184. <!-- ========= END OF CLASS DATA ========= -->
  185. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  186. <div class="bottomNav"><a name="navbar_bottom">
  187. <!-- -->
  188. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  189. <!-- -->
  190. </a>
  191. <ul class="navList" title="Navigation">
  192. <li><a href="../../../../overview-summary.html">Overview</a></li>
  193. <li><a href="package-summary.html">Package</a></li>
  194. <li class="navBarCell1Rev">Class</li>
  195. <li><a href="class-use/SqlSequencePlugin.html">Use</a></li>
  196. <li><a href="package-tree.html">Tree</a></li>
  197. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  198. <li><a href="../../../../index-all.html">Index</a></li>
  199. <li><a href="../../../../help-doc.html">Help</a></li>
  200. </ul>
  201. </div>
  202. <div class="subNav">
  203. <ul class="navList">
  204. <li><a href="../../../../org/sqlproc/engine/plugin/SqlPluginFactory.html" title="interface in org.sqlproc.engine.plugin"><span class="strong">Prev Class</span></a></li>
  205. <li>Next Class</li>
  206. </ul>
  207. <ul class="navList">
  208. <li><a href="../../../../index.html?org/sqlproc/engine/plugin/SqlSequencePlugin.html" target="_top">Frames</a></li>
  209. <li><a href="SqlSequencePlugin.html" target="_top">No Frames</a></li>
  210. </ul>
  211. <ul class="navList" id="allclasses_navbar_bottom">
  212. <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
  213. </ul>
  214. <div>
  215. <script type="text/javascript"><!--
  216. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  217. if(window==top) {
  218. allClassesLink.style.display = "block";
  219. }
  220. else {
  221. allClassesLink.style.display = "none";
  222. }
  223. //-->
  224. </script>
  225. </div>
  226. <div>
  227. <ul class="subNavList">
  228. <li>Summary:&nbsp;</li>
  229. <li>Nested&nbsp;|&nbsp;</li>
  230. <li>Field&nbsp;|&nbsp;</li>
  231. <li>Constr&nbsp;|&nbsp;</li>
  232. <li><a href="#method_summary">Method</a></li>
  233. </ul>
  234. <ul class="subNavList">
  235. <li>Detail:&nbsp;</li>
  236. <li>Field&nbsp;|&nbsp;</li>
  237. <li>Constr&nbsp;|&nbsp;</li>
  238. <li><a href="#method_detail">Method</a></li>
  239. </ul>
  240. </div>
  241. <a name="skip-navbar_bottom">
  242. <!-- -->
  243. </a></div>
  244. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  245. <p class="legalCopy"><small>Copyright &#169; 2016. All rights reserved.</small></p>
  246. </body>
  247. </html>