| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.10) on Mon Dec 05 10:27:04 MSK 2022 --> |
| <title>OraclePkGenerator (cayenne-doc: Cayenne Documentation 4.2.RC2 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-12-05"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="OraclePkGenerator (cayenne-doc: Cayenne Documentation 4.2.RC2 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = false; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/OraclePkGenerator.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.cayenne.dba.oracle</a></div> |
| <h2 title="Class OraclePkGenerator" class="title">Class OraclePkGenerator</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">org.apache.cayenne.dba.JdbcPkGenerator</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.cayenne.dba.oracle.OraclePkGenerator</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</a></code></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="../db2/DB2PkGenerator.html" title="class in org.apache.cayenne.dba.db2">DB2PkGenerator</a></code>, <code><a href="../derby/DerbyPkGenerator.html" title="class in org.apache.cayenne.dba.derby">DerbyPkGenerator</a></code>, <code><a href="../h2/H2PkGenerator.html" title="class in org.apache.cayenne.dba.h2">H2PkGenerator</a></code>, <code><a href="../ingres/IngresPkGenerator.html" title="class in org.apache.cayenne.dba.ingres">IngresPkGenerator</a></code>, <code><a href="../postgres/PostgresPkGenerator.html" title="class in org.apache.cayenne.dba.postgres">PostgresPkGenerator</a></code>, <code><a href="../sqlserver/SQLServerPkGenerator.html" title="class in org.apache.cayenne.dba.sqlserver">SQLServerPkGenerator</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">OraclePkGenerator</span> |
| extends <a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></pre> |
| <div class="block">Sequence-based primary key generator implementation for Oracle. Uses Oracle |
| sequences to generate primary key values. This approach is at least 50% |
| faster when tested with Oracle compared to the lookup table approach. |
| <p> |
| When using Cayenne key caching mechanism, make sure that sequences in the |
| database have "INCREMENT BY" greater or equal to OraclePkGenerator |
| "pkCacheSize" property value. If this is not the case, you will need to |
| adjust PkGenerator value accordingly. For example when sequence is |
| incremented by 1 each time, use the following code: |
| </p> |
| |
| <pre> |
| dataNode.getAdapter().getPkGenerator().setPkCacheSize(1); |
| </pre></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.cayenne.dba.JdbcPkGenerator"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.cayenne.dba.<a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></h3> |
| <code><a href="../JdbcPkGenerator.html#adapter">adapter</a>, <a href="../JdbcPkGenerator.html#DEFAULT_PK_CACHE_SIZE">DEFAULT_PK_CACHE_SIZE</a>, <a href="../JdbcPkGenerator.html#pkCache">pkCache</a>, <a href="../JdbcPkGenerator.html#pkCacheSize">pkCacheSize</a>, <a href="../JdbcPkGenerator.html#pkStartValue">pkStartValue</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colSecond" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">OraclePkGenerator</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Used by DI</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.cayenne.dba.JdbcAdapter)">OraclePkGenerator</a></span>​(<a href="../JdbcAdapter.html" title="class in org.apache.cayenne.dba">JdbcAdapter</a> adapter)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">createAutoPk</a></span>​(<a href="../../access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a> node, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>> dbEntities)</code></th> |
| <td class="colLast"> |
| <div class="block">Generates necessary database objects to provide automatic primary key support.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createAutoPkStatements(java.util.List)">createAutoPkStatements</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>> dbEntities)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a list of CREATE SEQUENCE statements for the list of DbEntities.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#createSequenceString(org.apache.cayenne.map.DbEntity)">createSequenceString</a></span>​(<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> ent)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">dropAutoPk</a></span>​(<a href="../../access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a> node, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>> dbEntities)</code></th> |
| <td class="colLast"> |
| <div class="block">Drops PK sequences for all specified DbEntities.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropAutoPkStatements(java.util.List)">dropAutoPkStatements</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>> dbEntities)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a list of DROP SEQUENCE statements for the list of DbEntities.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dropSequenceString(org.apache.cayenne.map.DbEntity)">dropSequenceString</a></span>​(<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> ent)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a SQL string needed to drop any database objects associated with |
| automatic primary key generation process for a specific DbEntity.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExistingSequences(org.apache.cayenne.access.DataNode)">getExistingSequences</a></span>​(<a href="../../access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a> node)</code></th> |
| <td class="colLast"> |
| <div class="block">Fetches a list of existing sequences that might match Cayenne generated |
| ones.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSequencePrefix()">getSequencePrefix</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>protected long</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#longPkFromDatabase(org.apache.cayenne.access.DataNode,org.apache.cayenne.map.DbEntity)">longPkFromDatabase</a></span>​(<a href="../../access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a> node, |
| <a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> entity)</code></th> |
| <td class="colLast"> |
| <div class="block">Generates primary key by calling Oracle sequence corresponding to the |
| <code>dbEntity</code>.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#pkCacheSize(org.apache.cayenne.map.DbEntity)">pkCacheSize</a></span>​(<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> entity)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectAllSequencesQuery()">selectAllSequencesQuery</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#selectNextValQuery(java.lang.String)">selectNextValQuery</a></span>​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> pkGeneratingSequenceName)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sequenceName(org.apache.cayenne.map.DbEntity)">sequenceName</a></span>​(<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> entity)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns expected primary key sequence name for a DbEntity.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.cayenne.dba.JdbcPkGenerator"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.cayenne.dba.<a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></h3> |
| <code><a href="../JdbcPkGenerator.html#autoPkTableExists(org.apache.cayenne.access.DataNode)">autoPkTableExists</a>, <a href="../JdbcPkGenerator.html#dropAutoPkString()">dropAutoPkString</a>, <a href="../JdbcPkGenerator.html#generatePk(org.apache.cayenne.access.DataNode,org.apache.cayenne.map.DbAttribute)">generatePk</a>, <a href="../JdbcPkGenerator.html#getAdapter()">getAdapter</a>, <a href="../JdbcPkGenerator.html#getPkCacheSize()">getPkCacheSize</a>, <a href="../JdbcPkGenerator.html#pkCreateString(java.lang.String)">pkCreateString</a>, <a href="../JdbcPkGenerator.html#pkDeleteString(java.util.List)">pkDeleteString</a>, <a href="../JdbcPkGenerator.html#pkSelectString(java.lang.String)">pkSelectString</a>, <a href="../JdbcPkGenerator.html#pkTableCreateString()">pkTableCreateString</a>, <a href="../JdbcPkGenerator.html#pkUpdateString(java.lang.String)">pkUpdateString</a>, <a href="../JdbcPkGenerator.html#reset()">reset</a>, <a href="../JdbcPkGenerator.html#runUpdate(org.apache.cayenne.access.DataNode,java.lang.String)">runUpdate</a>, <a href="../JdbcPkGenerator.html#setAdapter(org.apache.cayenne.dba.DbAdapter)">setAdapter</a>, <a href="../JdbcPkGenerator.html#setPkCacheSize(int)">setPkCacheSize</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>OraclePkGenerator</h4> |
| <pre>public OraclePkGenerator()</pre> |
| <div class="block">Used by DI</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>4.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.apache.cayenne.dba.JdbcAdapter)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>OraclePkGenerator</h4> |
| <pre>protected OraclePkGenerator​(<a href="../JdbcAdapter.html" title="class in org.apache.cayenne.dba">JdbcAdapter</a> adapter)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="createAutoPk(org.apache.cayenne.access.DataNode,java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAutoPk</h4> |
| <pre class="methodSignature">public void createAutoPk​(<a href="../../access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a> node, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>> dbEntities) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../PkGenerator.html#createAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">PkGenerator</a></code></span></div> |
| <div class="block">Generates necessary database objects to provide automatic primary key support.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../PkGenerator.html#createAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">createAutoPk</a></code> in interface <code><a href="../PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../JdbcPkGenerator.html#createAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">createAutoPk</a></code> in class <code><a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>node</code> - node that provides access to a DataSource.</dd> |
| <dd><code>dbEntities</code> - a list of entities that require primary key auto-generation |
| support</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createAutoPkStatements(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createAutoPkStatements</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> createAutoPkStatements​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>> dbEntities)</pre> |
| <div class="block">Creates a list of CREATE SEQUENCE statements for the list of DbEntities.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../PkGenerator.html#createAutoPkStatements(java.util.List)">createAutoPkStatements</a></code> in interface <code><a href="../PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../JdbcPkGenerator.html#createAutoPkStatements(java.util.List)">createAutoPkStatements</a></code> in class <code><a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dropAutoPk(org.apache.cayenne.access.DataNode,java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropAutoPk</h4> |
| <pre class="methodSignature">public void dropAutoPk​(<a href="../../access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a> node, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>> dbEntities) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Drops PK sequences for all specified DbEntities.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../PkGenerator.html#dropAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">dropAutoPk</a></code> in interface <code><a href="../PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../JdbcPkGenerator.html#dropAutoPk(org.apache.cayenne.access.DataNode,java.util.List)">dropAutoPk</a></code> in class <code><a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>node</code> - node that provides access to a DataSource.</dd> |
| <dd><code>dbEntities</code> - a list of entities whose primary key auto-generation support |
| should be dropped.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="dropAutoPkStatements(java.util.List)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropAutoPkStatements</h4> |
| <pre class="methodSignature">public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> dropAutoPkStatements​(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a>> dbEntities)</pre> |
| <div class="block">Creates a list of DROP SEQUENCE statements for the list of DbEntities.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../PkGenerator.html#dropAutoPkStatements(java.util.List)">dropAutoPkStatements</a></code> in interface <code><a href="../PkGenerator.html" title="interface in org.apache.cayenne.dba">PkGenerator</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../JdbcPkGenerator.html#dropAutoPkStatements(java.util.List)">dropAutoPkStatements</a></code> in class <code><a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="createSequenceString(org.apache.cayenne.map.DbEntity)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createSequenceString</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> createSequenceString​(<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> ent)</pre> |
| </li> |
| </ul> |
| <a id="dropSequenceString(org.apache.cayenne.map.DbEntity)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>dropSequenceString</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> dropSequenceString​(<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> ent)</pre> |
| <div class="block">Returns a SQL string needed to drop any database objects associated with |
| automatic primary key generation process for a specific DbEntity.</div> |
| </li> |
| </ul> |
| <a id="selectNextValQuery(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>selectNextValQuery</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> selectNextValQuery​(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> pkGeneratingSequenceName)</pre> |
| </li> |
| </ul> |
| <a id="selectAllSequencesQuery()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>selectAllSequencesQuery</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> selectAllSequencesQuery()</pre> |
| </li> |
| </ul> |
| <a id="longPkFromDatabase(org.apache.cayenne.access.DataNode,org.apache.cayenne.map.DbEntity)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>longPkFromDatabase</h4> |
| <pre class="methodSignature">protected long longPkFromDatabase​(<a href="../../access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a> node, |
| <a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> entity) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></pre> |
| <div class="block">Generates primary key by calling Oracle sequence corresponding to the |
| <code>dbEntity</code>. Executed SQL looks like this: |
| |
| <pre> |
| SELECT pk_table_name.nextval FROM DUAL |
| </pre></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../JdbcPkGenerator.html#longPkFromDatabase(org.apache.cayenne.access.DataNode,org.apache.cayenne.map.DbEntity)">longPkFromDatabase</a></code> in class <code><a href="../JdbcPkGenerator.html" title="class in org.apache.cayenne.dba">JdbcPkGenerator</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang" class="externalLink">Exception</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="pkCacheSize(org.apache.cayenne.map.DbEntity)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>pkCacheSize</h4> |
| <pre class="methodSignature">protected int pkCacheSize​(<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> entity)</pre> |
| </li> |
| </ul> |
| <a id="sequenceName(org.apache.cayenne.map.DbEntity)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>sequenceName</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> sequenceName​(<a href="../../map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</a> entity)</pre> |
| <div class="block">Returns expected primary key sequence name for a DbEntity.</div> |
| </li> |
| </ul> |
| <a id="getSequencePrefix()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSequencePrefix</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getSequencePrefix()</pre> |
| </li> |
| </ul> |
| <a id="getExistingSequences(org.apache.cayenne.access.DataNode)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getExistingSequences</h4> |
| <pre class="methodSignature">protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>> getExistingSequences​(<a href="../../access/DataNode.html" title="class in org.apache.cayenne.access">DataNode</a> node) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql" class="externalLink">SQLException</a></pre> |
| <div class="block">Fetches a list of existing sequences that might match Cayenne generated |
| ones.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql" class="externalLink">SQLException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/OraclePkGenerator.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 class="aboutLanguage"><a href="http://cayenne.apache.org" target="top">Apache Cayenne</a></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2001–2022 <a href="https://cayenne.apache.org/">Apache Cayenne</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |