/javadoc/3.1.0/core/org/sqlproc/engine/plugin/SqlSequencePlugin.html
HTML | 248 lines | 205 code | 1 blank | 42 comment | 0 complexity | 610dfe7c85121cf9f88d227651c655ab MD5 | raw file
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="en">
- <head>
- <!-- Generated by javadoc (version 1.7.0_80) on Fri Aug 21 15:07:14 CEST 2015 -->
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <title>SqlSequencePlugin (SQL Processor, Core Module 3.1.0 API)</title>
- <meta name="date" content="2015-08-21">
- <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
- </head>
- <body>
- <script type="text/javascript"><!--
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="SqlSequencePlugin (SQL Processor, Core Module 3.1.0 API)";
- }
- //-->
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a name="navbar_top">
- <!-- -->
- </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/SqlSequencePlugin.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../../index-all.html">Index</a></li>
- <li><a href="../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../../org/sqlproc/engine/plugin/SqlPluginFactory.html" title="interface in org.sqlproc.engine.plugin"><span class="strong">Prev Class</span></a></li>
- <li>Next Class</li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/sqlproc/engine/plugin/SqlSequencePlugin.html" target="_top">Frames</a></li>
- <li><a href="SqlSequencePlugin.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method_summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method_detail">Method</a></li>
- </ul>
- </div>
- <a name="skip-navbar_top">
- <!-- -->
- </a></div>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <!-- ======== START OF CLASS DATA ======== -->
- <div class="header">
- <div class="subTitle">org.sqlproc.engine.plugin</div>
- <h2 title="Interface SqlSequencePlugin" class="title">Interface SqlSequencePlugin</h2>
- </div>
- <div class="contentContainer">
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>All Superinterfaces:</dt>
- <dd><a href="../../../../org/sqlproc/engine/plugin/Modifiers.html" title="interface in org.sqlproc.engine.plugin">Modifiers</a></dd>
- </dl>
- <dl>
- <dt>All Known Implementing Classes:</dt>
- <dd><a href="../../../../org/sqlproc/engine/plugin/DefaultSqlPlugins.html" title="class in org.sqlproc.engine.plugin">DefaultSqlPlugins</a></dd>
- </dl>
- <hr>
- <br>
- <pre>public interface <span class="strong">SqlSequencePlugin</span>
- extends <a href="../../../../org/sqlproc/engine/plugin/Modifiers.html" title="interface in org.sqlproc.engine.plugin">Modifiers</a></pre>
- <div class="block">The SQL Processor plugin devoted to the sequence SELECT SQL construction.
-
- 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
- used in the META SQL query in the next way:
- <ul>
- <li>$n is the name of the sequence from the META SQL query</li>
- </ul></div>
- <dl><dt><span class="strong">Author:</span></dt>
- <dd><a href="mailto:Vladimir.Hudec@gmail.com">Vladimir Hudec</a></dd></dl>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- =========== FIELD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="field_summary">
- <!-- -->
- </a>
- <h3>Field Summary</h3>
- <ul class="blockList">
- <li class="blockList"><a name="fields_inherited_from_class_org.sqlproc.engine.plugin.Modifiers">
- <!-- -->
- </a>
- <h3>Fields inherited from interface org.sqlproc.engine.plugin.<a href="../../../../org/sqlproc/engine/plugin/Modifiers.html" title="interface in org.sqlproc.engine.plugin">Modifiers</a></h3>
- <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>
- </ul>
- </li>
- </ul>
- <!-- ========== METHOD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method_summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
- <caption><span>Methods</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Method and Description</th>
- </tr>
- <tr class="altColor">
- <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>
- <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> runtimeCtx,
- <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> sequenceName)</code>
- <div class="block">Used to construct the sequence SELECT SQL.</div>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- <div class="details">
- <ul class="blockList">
- <li class="blockList">
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method_detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="sequenceSelect(org.sqlproc.engine.SqlRuntimeContext, java.lang.String)">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>sequenceSelect</h4>
- <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> sequenceSelect(<a href="../../../../org/sqlproc/engine/SqlRuntimeContext.html" title="interface in org.sqlproc.engine">SqlRuntimeContext</a> runtimeCtx,
- <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> sequenceName)</pre>
- <div class="block">Used to construct the sequence SELECT SQL.</div>
- <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>
- <dt><span class="strong">Returns:</span></dt><dd>the final sequence SELECT SQL</dd></dl>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- </div>
- <!-- ========= END OF CLASS DATA ========= -->
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <div class="bottomNav"><a name="navbar_bottom">
- <!-- -->
- </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/SqlSequencePlugin.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../../index-all.html">Index</a></li>
- <li><a href="../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../../org/sqlproc/engine/plugin/SqlPluginFactory.html" title="interface in org.sqlproc.engine.plugin"><span class="strong">Prev Class</span></a></li>
- <li>Next Class</li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../index.html?org/sqlproc/engine/plugin/SqlSequencePlugin.html" target="_top">Frames</a></li>
- <li><a href="SqlSequencePlugin.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method_summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li>Constr | </li>
- <li><a href="#method_detail">Method</a></li>
- </ul>
- </div>
- <a name="skip-navbar_bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- <p class="legalCopy"><small>Copyright © 2015. All rights reserved.</small></p>
- </body>
- </html>