PageRenderTime 46ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 0ms

/javadoc/3.0.0/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 | d3b352a226f27c600ff6966d973a1983 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!-- NewPage -->
    3. 

  3. <html lang="en">
    4. 

  4. <head>
    5. 

  5. <!-- Generated by javadoc (version 1.7.0_80) on Wed Aug 12 13:17:55 CEST 2015 -->
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    7. 

  7. <title>SqlSequencePlugin (SQL Processor, Core Module 3.0.0 API)</title>
    8. 

  8. <meta name="date" content="2015-08-12">
    9. 

  9. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
    10. 

  10. </head>
    11. 

  11. <body>
    12. 

  12. <script type="text/javascript"><!--
    13. 

  13.     if (location.href.indexOf('is-external=true') == -1) {
    14. 

  14.         parent.document.title="SqlSequencePlugin (SQL Processor, Core Module 3.0.0 API)";
    15. 

  15.     }
    16. 

  16. //-->
    17. 

  17. </script>
    18. 

  18. <noscript>
    19. 

  19. <div>JavaScript is disabled on your browser.</div>
    20. 

  20. </noscript>
    21. 

  21. <!-- ========= START OF TOP NAVBAR ======= -->
    22. 

  22. <div class="topNav"><a name="navbar_top">
    23. 

  23. <!--   -->
    24. 

  24. </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
    25. 

  25. <!--   -->
    26. 

  26. </a>
    27. 

  27. <ul class="navList" title="Navigation">
    28. 

  28. <li><a href="../../../../overview-summary.html">Overview</a></li>
    29. 

  29. <li><a href="package-summary.html">Package</a></li>
    30. 

  30. <li class="navBarCell1Rev">Class</li>
    31. 

  31. <li><a href="class-use/SqlSequencePlugin.html">Use</a></li>
    32. 

  32. <li><a href="package-tree.html">Tree</a></li>
    33. 

  33. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
    34. 

  34. <li><a href="../../../../index-all.html">Index</a></li>
    35. 

  35. <li><a href="../../../../help-doc.html">Help</a></li>
    36. 

  36. </ul>
    37. 

  37. </div>
    38. 

  38. <div class="subNav">
    39. 

  39. <ul class="navList">
    40. 

  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. 

  41. <li>Next Class</li>
    42. 

  42. </ul>
    43. 

  43. <ul class="navList">
    44. 

  44. <li><a href="../../../../index.html?org/sqlproc/engine/plugin/SqlSequencePlugin.html" target="_top">Frames</a></li>
    45. 

  45. <li><a href="SqlSequencePlugin.html" target="_top">No Frames</a></li>
    46. 

  46. </ul>
    47. 

  47. <ul class="navList" id="allclasses_navbar_top">
    48. 

  48. <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
    49. 

  49. </ul>
    50. 

  50. <div>
    51. 

  51. <script type="text/javascript"><!--
    52. 

  52.   allClassesLink = document.getElementById("allclasses_navbar_top");
    53. 

  53.   if(window==top) {
    54. 

  54.     allClassesLink.style.display = "block";
    55. 

  55.   }
    56. 

  56.   else {
    57. 

  57.     allClassesLink.style.display = "none";
    58. 

  58.   }
    59. 

  59.   //-->
    60. 

  60. </script>
    61. 

  61. </div>
    62. 

  62. <div>
    63. 

  63. <ul class="subNavList">
    64. 

  64. <li>Summary:&nbsp;</li>
    65. 

  65. <li>Nested&nbsp;|&nbsp;</li>
    66. 

  66. <li>Field&nbsp;|&nbsp;</li>
    67. 

  67. <li>Constr&nbsp;|&nbsp;</li>
    68. 

  68. <li><a href="#method_summary">Method</a></li>
    69. 

  69. </ul>
    70. 

  70. <ul class="subNavList">
    71. 

  71. <li>Detail:&nbsp;</li>
    72. 

  72. <li>Field&nbsp;|&nbsp;</li>
    73. 

  73. <li>Constr&nbsp;|&nbsp;</li>
    74. 

  74. <li><a href="#method_detail">Method</a></li>
    75. 

  75. </ul>
    76. 

  76. </div>
    77. 

  77. <a name="skip-navbar_top">
    78. 

  78. <!--   -->
    79. 

  79. </a></div>
    80. 

  80. <!-- ========= END OF TOP NAVBAR ========= -->
    81. 

  81. <!-- ======== START OF CLASS DATA ======== -->
    82. 

  82. <div class="header">
    83. 

  83. <div class="subTitle">org.sqlproc.engine.plugin</div>
    84. 

  84. <h2 title="Interface SqlSequencePlugin" class="title">Interface SqlSequencePlugin</h2>
    85. 

  85. </div>
    86. 

  86. <div class="contentContainer">
    87. 

  87. <div class="description">
    88. 

  88. <ul class="blockList">
    89. 

  89. <li class="blockList">
    90. 

  90. <dl>
    91. 

  91. <dt>All Superinterfaces:</dt>
    92. 

  92. <dd><a href="../../../../org/sqlproc/engine/plugin/Modifiers.html" title="interface in org.sqlproc.engine.plugin">Modifiers</a></dd>
    93. 

  93. </dl>
    94. 

  94. <dl>
    95. 

  95. <dt>All Known Implementing Classes:</dt>
    96. 

  96. <dd><a href="../../../../org/sqlproc/engine/plugin/DefaultSqlPlugins.html" title="class in org.sqlproc.engine.plugin">DefaultSqlPlugins</a></dd>
    97. 

  97. </dl>
    98. 

  98. <hr>
    99. 

  99. <br>
    100. 

  100. <pre>public interface <span class="strong">SqlSequencePlugin</span>
    101. 

  101. extends <a href="../../../../org/sqlproc/engine/plugin/Modifiers.html" title="interface in org.sqlproc.engine.plugin">Modifiers</a></pre>
    102. 

  102. <div class="block">The SQL Processor plugin devoted to the sequence SELECT SQL construction.
    103. 

  103.  
    104. 

  104.  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
    105. 

  105.  used in the META SQL query in the next way:
    106. 

  106.  <ul>
    107. 

  107.  <li>$n is the name of the sequence from the META SQL query</li>
    108. 

  108.  </ul></div>
    109. 

  109. <dl><dt><span class="strong">Author:</span></dt>
    110. 

  110.   <dd><a href="mailto:Vladimir.Hudec@gmail.com">Vladimir Hudec</a></dd></dl>
    111. 

  111. </li>
    112. 

  112. </ul>
    113. 

  113. </div>
    114. 

  114. <div class="summary">
    115. 

  115. <ul class="blockList">
    116. 

  116. <li class="blockList">
    117. 

  117. <!-- =========== FIELD SUMMARY =========== -->
    118. 

  118. <ul class="blockList">
    119. 

  119. <li class="blockList"><a name="field_summary">
    120. 

  120. <!--   -->
    121. 

  121. </a>
    122. 

  122. <h3>Field Summary</h3>
    123. 

  123. <ul class="blockList">
    124. 

  124. <li class="blockList"><a name="fields_inherited_from_class_org.sqlproc.engine.plugin.Modifiers">
    125. 

  125. <!--   -->
    126. 

  126. </a>
    127. 

  127. <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>
    128. 

  128. <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>
    129. 

  129. </ul>
    130. 

  130. </li>
    131. 

  131. </ul>
    132. 

  132. <!-- ========== METHOD SUMMARY =========== -->
    133. 

  133. <ul class="blockList">
    134. 

  134. <li class="blockList"><a name="method_summary">
    135. 

  135. <!--   -->
    136. 

  136. </a>
    137. 

  137. <h3>Method Summary</h3>
    138. 

  138. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
    139. 

  139. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
    140. 

  140. <tr>
    141. 

  141. <th class="colFirst" scope="col">Modifier and Type</th>
    142. 

  142. <th class="colLast" scope="col">Method and Description</th>
    143. 

  143. </tr>
    144. 

  144. <tr class="altColor">
    145. 

  145. <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>
    146. 

  146. <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,
    147. 

  147.               <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>
    148. 

  148. <div class="block">Used to construct the sequence SELECT SQL.</div>
    149. 

  149. </td>
    150. 

  150. </tr>
    151. 

  151. </table>
    152. 

  152. </li>
    153. 

  153. </ul>
    154. 

  154. </li>
    155. 

  155. </ul>
    156. 

  156. </div>
    157. 

  157. <div class="details">
    158. 

  158. <ul class="blockList">
    159. 

  159. <li class="blockList">
    160. 

  160. <!-- ============ METHOD DETAIL ========== -->
    161. 

  161. <ul class="blockList">
    162. 

  162. <li class="blockList"><a name="method_detail">
    163. 

  163. <!--   -->
    164. 

  164. </a>
    165. 

  165. <h3>Method Detail</h3>
    166. 

  166. <a name="sequenceSelect(org.sqlproc.engine.SqlRuntimeContext, java.lang.String)">
    167. 

  167. <!--   -->
    168. 

  168. </a>
    169. 

  169. <ul class="blockListLast">
    170. 

  170. <li class="blockList">
    171. 

  171. <h4>sequenceSelect</h4>
    172. 

  172. <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,
    173. 

  173.                     <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>
    174. 

  174. <div class="block">Used to construct the sequence SELECT SQL.</div>
    175. 

  175. <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>
    176. 

  176. <dt><span class="strong">Returns:</span></dt><dd>the final sequence SELECT SQL</dd></dl>
    177. 

  177. </li>
    178. 

  178. </ul>
    179. 

  179. </li>
    180. 

  180. </ul>
    181. 

  181. </li>
    182. 

  182. </ul>
    183. 

  183. </div>
    184. 

  184. </div>
    185. 

  185. <!-- ========= END OF CLASS DATA ========= -->
    186. 

  186. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    187. 

  187. <div class="bottomNav"><a name="navbar_bottom">
    188. 

  188. <!--   -->
    189. 

  189. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
    190. 

  190. <!--   -->
    191. 

  191. </a>
    192. 

  192. <ul class="navList" title="Navigation">
    193. 

  193. <li><a href="../../../../overview-summary.html">Overview</a></li>
    194. 

  194. <li><a href="package-summary.html">Package</a></li>
    195. 

  195. <li class="navBarCell1Rev">Class</li>
    196. 

  196. <li><a href="class-use/SqlSequencePlugin.html">Use</a></li>
    197. 

  197. <li><a href="package-tree.html">Tree</a></li>
    198. 

  198. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
    199. 

  199. <li><a href="../../../../index-all.html">Index</a></li>
    200. 

  200. <li><a href="../../../../help-doc.html">Help</a></li>
    201. 

  201. </ul>
    202. 

  202. </div>
    203. 

  203. <div class="subNav">
    204. 

  204. <ul class="navList">
    205. 

  205. <li><a href="../../../../org/sqlproc/engine/plugin/SqlPluginFactory.html" title="interface in org.sqlproc.engine.plugin"><span class="strong">Prev Class</span></a></li>
    206. 

  206. <li>Next Class</li>
    207. 

  207. </ul>
    208. 

  208. <ul class="navList">
    209. 

  209. <li><a href="../../../../index.html?org/sqlproc/engine/plugin/SqlSequencePlugin.html" target="_top">Frames</a></li>
    210. 

  210. <li><a href="SqlSequencePlugin.html" target="_top">No Frames</a></li>
    211. 

  211. </ul>
    212. 

  212. <ul class="navList" id="allclasses_navbar_bottom">
    213. 

  213. <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
    214. 

  214. </ul>
    215. 

  215. <div>
    216. 

  216. <script type="text/javascript"><!--
    217. 

  217.   allClassesLink = document.getElementById("allclasses_navbar_bottom");
    218. 

  218.   if(window==top) {
    219. 

  219.     allClassesLink.style.display = "block";
    220. 

  220.   }
    221. 

  221.   else {
    222. 

  222.     allClassesLink.style.display = "none";
    223. 

  223.   }
    224. 

  224.   //-->
    225. 

  225. </script>
    226. 

  226. </div>
    227. 

  227. <div>
    228. 

  228. <ul class="subNavList">
    229. 

  229. <li>Summary:&nbsp;</li>
    230. 

  230. <li>Nested&nbsp;|&nbsp;</li>
    231. 

  231. <li>Field&nbsp;|&nbsp;</li>
    232. 

  232. <li>Constr&nbsp;|&nbsp;</li>
    233. 

  233. <li><a href="#method_summary">Method</a></li>
    234. 

  234. </ul>
    235. 

  235. <ul class="subNavList">
    236. 

  236. <li>Detail:&nbsp;</li>
    237. 

  237. <li>Field&nbsp;|&nbsp;</li>
    238. 

  238. <li>Constr&nbsp;|&nbsp;</li>
    239. 

  239. <li><a href="#method_detail">Method</a></li>
    240. 

  240. </ul>
    241. 

  241. </div>
    242. 

  242. <a name="skip-navbar_bottom">
    243. 

  243. <!--   -->
    244. 

  244. </a></div>
    245. 

  245. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    246. 

  246. <p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
    247. 

  247. </body>
    248. 

  248. </html>
    249. 

  249.