blob: bbae807528cbe45d2ffe7f40c8dea5d5c592a087 [file] [log] [blame]
<!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 (1.8.0_252) on Fri Jul 16 09:39:10 UTC 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Sequence (EclipseLink 3.0.2, API Reference)</title>
<meta name="date" content="2021-07-16">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Sequence (EclipseLink 3.0.2, API Reference)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":10,"i3":10,"i4":10,"i5":6,"i6":10,"i7":6,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":6,"i20":10,"i21":6,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":6,"i30":10,"i31":10,"i32":10,"i33":6,"i34":10,"i35":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="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">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/persistence/sequencing/QuerySequence.html" title="class in org.eclipse.persistence.sequencing"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/persistence/sequencing/SequencingControl.html" title="interface in org.eclipse.persistence.sequencing"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/persistence/sequencing/Sequence.html" target="_top">Frames</a></li>
<li><a href="Sequence.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.eclipse.persistence.sequencing</div>
<h2 title="Class Sequence" class="title">Class Sequence</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">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.eclipse.persistence.sequencing.Sequence</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/eclipse/persistence/sequencing/DefaultSequence.html" title="class in org.eclipse.persistence.sequencing">DefaultSequence</a>, <a href="../../../../org/eclipse/persistence/sequencing/StandardSequence.html" title="class in org.eclipse.persistence.sequencing">StandardSequence</a>, <a href="../../../../org/eclipse/persistence/sequencing/UUIDSequence.html" title="class in org.eclipse.persistence.sequencing">UUIDSequence</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">Sequence</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a></pre>
<div class="block"><p>
<b>Purpose</b>: Abstract class to define sequencing.
<p>
<b>Description</b>
A sequence defines how generated ids are obtained.
The main sequence types are TableSequence and NativeSequence.
Descriptors using sequencing will use the sequence object defined in their session's
DatabaseLogin with the name matching their sequence name. If a specific sequence is
not defined for the name the DatabaseLogin's default sequence will be used.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/eclipse/persistence/sequencing/TableSequence.html" title="class in org.eclipse.persistence.sequencing"><code>TableSequence</code></a>,
<a href="../../../../org/eclipse/persistence/sequencing/NativeSequence.html" title="class in org.eclipse.persistence.sequencing"><code>NativeSequence</code></a>,
<a href="../../../../serialized-form.html#org.eclipse.persistence.sequencing.Sequence">Serialized Form</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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#depth">depth</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#initialValue">initialValue</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#isCustomQualifier">isCustomQualifier</a></span></code>&nbsp;</td>
</tr>
<tr 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">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#name">name</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.eclipse.persistence.internal.databaseaccess.Platform</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#platform">platform</a></span></code>&nbsp;</td>
</tr>
<tr 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">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#qualifier">qualifier</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#shouldAlwaysOverrideExistingValue">shouldAlwaysOverrideExistingValue</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#size">size</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#Sequence--">Sequence</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#Sequence-java.lang.String-">Sequence</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">String</a>&nbsp;name)</code>
<div class="block">Create a new sequence with the name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#Sequence-java.lang.String-int-">Sequence</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">String</a>&nbsp;name,
int&nbsp;size)</code>
<div class="block">Create a new sequence with the name and sequence pre-allocation size.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#Sequence-java.lang.String-int-int-">Sequence</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">String</a>&nbsp;name,
int&nbsp;size,
int&nbsp;initialValue)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#clone--">clone</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#equalNameAndSize-org.eclipse.persistence.sequencing.Sequence-org.eclipse.persistence.sequencing.Sequence-">equalNameAndSize</a></span>(<a href="../../../../org/eclipse/persistence/sequencing/Sequence.html" title="class in org.eclipse.persistence.sequencing">Sequence</a>&nbsp;seq1,
<a href="../../../../org/eclipse/persistence/sequencing/Sequence.html" title="class in org.eclipse.persistence.sequencing">Sequence</a>&nbsp;seq2)</code>
<div class="block">INTERNAL:
Used in equals.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</code>&nbsp;</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>org.eclipse.persistence.internal.databaseaccess.Platform</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#getDatasourcePlatform--">getDatasourcePlatform</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#getGeneratedValue-org.eclipse.persistence.internal.databaseaccess.Accessor-org.eclipse.persistence.internal.sessions.AbstractSession-">getGeneratedValue</a></span>(org.eclipse.persistence.internal.databaseaccess.Accessor&nbsp;accessor,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;writeSession)</code>
<div class="block">INTERNAL:
Return the newly-generated sequencing value.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#getGeneratedValue-org.eclipse.persistence.internal.databaseaccess.Accessor-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.String-">getGeneratedValue</a></span>(org.eclipse.persistence.internal.databaseaccess.Accessor&nbsp;accessor,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;writeSession,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;seqName)</code>
<div class="block">INTERNAL:
Return the newly-generated sequencing value.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#getGeneratedVector-org.eclipse.persistence.internal.databaseaccess.Accessor-org.eclipse.persistence.internal.sessions.AbstractSession-">getGeneratedVector</a></span>(org.eclipse.persistence.internal.databaseaccess.Accessor&nbsp;accessor,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;writeSession)</code>
<div class="block">INTERNAL:
Return a Vector of newly-generated sequencing values.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#getGeneratedVector-org.eclipse.persistence.internal.databaseaccess.Accessor-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.String-int-">getGeneratedVector</a></span>(org.eclipse.persistence.internal.databaseaccess.Accessor&nbsp;accessor,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;writeSession,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;seqName,
int&nbsp;size)</code>
<div class="block">INTERNAL:
Return a Vector of newly-generated sequencing values.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#getInitialValue--">getInitialValue</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#getName--">getName</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#getPreallocationSize--">getPreallocationSize</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#getQualified-java.lang.String-">getQualified</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">String</a>&nbsp;str)</code>
<div class="block">INTERNAL:</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#getQualifier--">getQualifier</a></span>()</code>
<div class="block">INTERNAL:</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#isConnected--">isConnected</a></span>()</code>
<div class="block">PUBLIC:
Indicates that Sequence is connected.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#isCustomQualifier--">isCustomQualifier</a></span>()</code>
<div class="block">INTERNAL:</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#isNative--">isNative</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#isTable--">isTable</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#isUnaryTable--">isUnaryTable</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#onConnect--">onConnect</a></span>()</code>
<div class="block">INTERNAL:
This method is called when Sequencing object is created.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#onConnect-org.eclipse.persistence.internal.databaseaccess.Platform-">onConnect</a></span>(org.eclipse.persistence.internal.databaseaccess.Platform&nbsp;platform)</code>
<div class="block">INTERNAL:
This method is called when Sequencing object is created.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#onDisconnect--">onDisconnect</a></span>()</code>
<div class="block">INTERNAL:
This method is called when Sequencing object is destroyed.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#onDisconnect-org.eclipse.persistence.internal.databaseaccess.Platform-">onDisconnect</a></span>(org.eclipse.persistence.internal.databaseaccess.Platform&nbsp;platform)</code>
<div class="block">INTERNAL:
This method is called when Sequencing object is destroyed.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#setDatasourcePlatform-org.eclipse.persistence.internal.databaseaccess.Platform-">setDatasourcePlatform</a></span>(org.eclipse.persistence.internal.databaseaccess.Platform&nbsp;platform)</code>&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#setInitialValue-int-">setInitialValue</a></span>(int&nbsp;initialValue)</code>&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#setName-java.lang.String-">setName</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">String</a>&nbsp;name)</code>&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#setPreallocationSize-int-">setPreallocationSize</a></span>(int&nbsp;size)</code>&nbsp;</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#setQualifier-java.lang.String-">setQualifier</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">String</a>&nbsp;qualifier)</code>
<div class="block">INTERNAL:</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#setShouldAlwaysOverrideExistingValue-boolean-">setShouldAlwaysOverrideExistingValue</a></span>(boolean&nbsp;shouldAlwaysOverrideExistingValue)</code>
<div class="block">ADVANCED:
Set that to true if the sequence should always override the existing pk value.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#shouldAcquireValueAfterInsert--">shouldAcquireValueAfterInsert</a></span>()</code>
<div class="block">INTERNAL:
Indicates whether sequencing value should be acquired after INSERT.</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#shouldAlwaysOverrideExistingValue--">shouldAlwaysOverrideExistingValue</a></span>()</code>
<div class="block">INTERNAL:
Indicates whether the existing pk value should always be overridden by the sequence.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#shouldAlwaysOverrideExistingValue-java.lang.String-">shouldAlwaysOverrideExistingValue</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">String</a>&nbsp;seqName)</code>
<div class="block">INTERNAL:
Indicates whether the existing pk value should always be overridden by the sequence.</div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#shouldUsePreallocation--">shouldUsePreallocation</a></span>()</code>
<div class="block">INTERNAL:
Indicates whether several sequencing values should be acquired at a time
and be kept by TopLink.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#shouldUseTransaction--">shouldUseTransaction</a></span>()</code>
<div class="block">INTERNAL:
Indicates whether TopLink should internally call beginTransaction() before
getGeneratedValue/Vector, and commitTransaction after.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/sequencing/Sequence.html#verifyPlatform-org.eclipse.persistence.internal.databaseaccess.Platform-">verifyPlatform</a></span>(org.eclipse.persistence.internal.databaseaccess.Platform&nbsp;otherPlatform)</code>
<div class="block">INTERNAL:
Make sure that the sequence is not used by more than one platform.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;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">Object</a></h3>
<code><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">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">getClass</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">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">notifyAll</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">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">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">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="name">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>name</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name</pre>
</li>
</ul>
<a name="size">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>protected&nbsp;int size</pre>
</li>
</ul>
<a name="platform">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>platform</h4>
<pre>protected&nbsp;org.eclipse.persistence.internal.databaseaccess.Platform platform</pre>
</li>
</ul>
<a name="initialValue">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initialValue</h4>
<pre>protected&nbsp;int initialValue</pre>
</li>
</ul>
<a name="depth">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>depth</h4>
<pre>protected&nbsp;int depth</pre>
</li>
</ul>
<a name="qualifier">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>qualifier</h4>
<pre>protected&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> qualifier</pre>
</li>
</ul>
<a name="isCustomQualifier">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCustomQualifier</h4>
<pre>protected&nbsp;boolean isCustomQualifier</pre>
</li>
</ul>
<a name="shouldAlwaysOverrideExistingValue">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>shouldAlwaysOverrideExistingValue</h4>
<pre>protected&nbsp;boolean shouldAlwaysOverrideExistingValue</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Sequence--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Sequence</h4>
<pre>public&nbsp;Sequence()</pre>
</li>
</ul>
<a name="Sequence-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Sequence</h4>
<pre>public&nbsp;Sequence(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
<div class="block">Create a new sequence with the name.</div>
</li>
</ul>
<a name="Sequence-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Sequence</h4>
<pre>public&nbsp;Sequence(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
int&nbsp;size)</pre>
<div class="block">Create a new sequence with the name and sequence pre-allocation size.</div>
</li>
</ul>
<a name="Sequence-java.lang.String-int-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Sequence</h4>
<pre>public&nbsp;Sequence(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
int&nbsp;size,
int&nbsp;initialValue)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isNative--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNative</h4>
<pre>public&nbsp;boolean&nbsp;isNative()</pre>
</li>
</ul>
<a name="isTable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isTable</h4>
<pre>public&nbsp;boolean&nbsp;isTable()</pre>
</li>
</ul>
<a name="isUnaryTable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUnaryTable</h4>
<pre>public&nbsp;boolean&nbsp;isUnaryTable()</pre>
</li>
</ul>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
</li>
</ul>
<a name="setName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setName</h4>
<pre>public&nbsp;void&nbsp;setName(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
</li>
</ul>
<a name="getPreallocationSize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPreallocationSize</h4>
<pre>public&nbsp;int&nbsp;getPreallocationSize()</pre>
</li>
</ul>
<a name="setPreallocationSize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPreallocationSize</h4>
<pre>public&nbsp;void&nbsp;setPreallocationSize(int&nbsp;size)</pre>
</li>
</ul>
<a name="getInitialValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInitialValue</h4>
<pre>public&nbsp;int&nbsp;getInitialValue()</pre>
</li>
</ul>
<a name="setInitialValue-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInitialValue</h4>
<pre>public&nbsp;void&nbsp;setInitialValue(int&nbsp;initialValue)</pre>
</li>
</ul>
<a name="clone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;clone()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><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">clone</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="equals-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public&nbsp;boolean&nbsp;equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="equalNameAndSize-org.eclipse.persistence.sequencing.Sequence-org.eclipse.persistence.sequencing.Sequence-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equalNameAndSize</h4>
<pre>public static&nbsp;boolean&nbsp;equalNameAndSize(<a href="../../../../org/eclipse/persistence/sequencing/Sequence.html" title="class in org.eclipse.persistence.sequencing">Sequence</a>&nbsp;seq1,
<a href="../../../../org/eclipse/persistence/sequencing/Sequence.html" title="class in org.eclipse.persistence.sequencing">Sequence</a>&nbsp;seq2)</pre>
<div class="block">INTERNAL:
Used in equals.</div>
</li>
</ul>
<a name="hashCode--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre>public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
<a name="setDatasourcePlatform-org.eclipse.persistence.internal.databaseaccess.Platform-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDatasourcePlatform</h4>
<pre>protected&nbsp;void&nbsp;setDatasourcePlatform(org.eclipse.persistence.internal.databaseaccess.Platform&nbsp;platform)</pre>
</li>
</ul>
<a name="getDatasourcePlatform--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatasourcePlatform</h4>
<pre>public&nbsp;org.eclipse.persistence.internal.databaseaccess.Platform&nbsp;getDatasourcePlatform()</pre>
</li>
</ul>
<a name="shouldAcquireValueAfterInsert--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldAcquireValueAfterInsert</h4>
<pre>public abstract&nbsp;boolean&nbsp;shouldAcquireValueAfterInsert()</pre>
<div class="block">INTERNAL:
Indicates whether sequencing value should be acquired after INSERT.
Note that preallocation could be used only in case sequencing values
should be acquired before insert (this method returns false).
In default implementation, it is true for table sequencing and native
sequencing on Oracle platform, false for native sequencing on other platforms.</div>
</li>
</ul>
<a name="shouldUsePreallocation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldUsePreallocation</h4>
<pre>public&nbsp;boolean&nbsp;shouldUsePreallocation()</pre>
<div class="block">INTERNAL:
Indicates whether several sequencing values should be acquired at a time
and be kept by TopLink. This in only possible in case sequencing numbers should
be acquired before insert (shouldAcquireValueAfterInsert()==false).
In default implementation, it is true for table sequencing and native
sequencing on Oracle platform, false for native sequencing on other platforms.</div>
</li>
</ul>
<a name="shouldUseTransaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldUseTransaction</h4>
<pre>public abstract&nbsp;boolean&nbsp;shouldUseTransaction()</pre>
<div class="block">INTERNAL:
Indicates whether TopLink should internally call beginTransaction() before
getGeneratedValue/Vector, and commitTransaction after.
In default implementation, it is true for table sequencing and
false for native sequencing.</div>
</li>
</ul>
<a name="getGeneratedValue-org.eclipse.persistence.internal.databaseaccess.Accessor-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGeneratedValue</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getGeneratedValue(org.eclipse.persistence.internal.databaseaccess.Accessor&nbsp;accessor,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;writeSession,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;seqName)</pre>
<div class="block">INTERNAL:
Return the newly-generated sequencing value.
Used only in case preallocation is not used (shouldUsePreallocation()==false).
Accessor may be non-null only in case shouldUseSeparateConnection()==true.
Even in this case accessor could be null - if SequencingControl().shouldUseSeparateConnection()==false;
Therefore in case shouldUseSeparateConnection()==true, implementation should handle
both cases: use a separate connection if provided (accessor != null), or get by
without it (accessor == null).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>accessor</code> - Accessor is a separate sequencing accessor (may be null);</dd>
<dd><code>writeSession</code> - Session is a Session used for writing (either ClientSession or DatabaseSession);</dd>
<dd><code>seqName</code> - String is sequencing number field name</dd>
</dl>
</li>
</ul>
<a name="getGeneratedValue-org.eclipse.persistence.internal.databaseaccess.Accessor-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGeneratedValue</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getGeneratedValue(org.eclipse.persistence.internal.databaseaccess.Accessor&nbsp;accessor,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;writeSession)</pre>
<div class="block">INTERNAL:
Return the newly-generated sequencing value.
Used only in case preallocation is not used (shouldUsePreallocation()==false).
Accessor may be non-null only in case shouldUseSeparateConnection()==true.
Even in this case accessor could be null - if SequencingControl().shouldUseSeparateConnection()==false;
Therefore in case shouldUseSeparateConnection()==true, implementation should handle
both cases: use a separate connection if provided (accessor != null), or get by
without it (accessor == null).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>accessor</code> - Accessor is a separate sequencing accessor (may be null);</dd>
<dd><code>writeSession</code> - Session is a Session used for writing (either ClientSession or DatabaseSession);</dd>
</dl>
</li>
</ul>
<a name="getGeneratedVector-org.eclipse.persistence.internal.databaseaccess.Accessor-org.eclipse.persistence.internal.sessions.AbstractSession-java.lang.String-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGeneratedVector</h4>
<pre>public abstract&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;getGeneratedVector(org.eclipse.persistence.internal.databaseaccess.Accessor&nbsp;accessor,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;writeSession,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;seqName,
int&nbsp;size)</pre>
<div class="block">INTERNAL:
Return a Vector of newly-generated sequencing values.
Used only in case preallocation is used (shouldUsePreallocation()==true).
Accessor may be non-null only in case shouldUseSeparateConnection()==true.
Even in this case accessor could be null - if SequencingControl().shouldUseSeparateConnection()==false;
Therefore in case shouldUseSeparateConnection()==true, implementation should handle
both cases: use a separate connection if provided (accessor != null), or get by
without it (accessor == null).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>accessor</code> - Accessor is a separate sequencing accessor (may be null);</dd>
<dd><code>writeSession</code> - Session is a Session used for writing (either ClientSession or DatabaseSession);</dd>
<dd><code>seqName</code> - String is sequencing number field name</dd>
<dd><code>size</code> - int number of values to preallocate (output Vector size).</dd>
</dl>
</li>
</ul>
<a name="getGeneratedVector-org.eclipse.persistence.internal.databaseaccess.Accessor-org.eclipse.persistence.internal.sessions.AbstractSession-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGeneratedVector</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Vector.html?is-external=true" title="class or interface in java.util">Vector</a>&nbsp;getGeneratedVector(org.eclipse.persistence.internal.databaseaccess.Accessor&nbsp;accessor,
org.eclipse.persistence.internal.sessions.AbstractSession&nbsp;writeSession)</pre>
<div class="block">INTERNAL:
Return a Vector of newly-generated sequencing values.
Used only in case preallocation is used (shouldUsePreallocation()==true).
Accessor may be non-null only in case shouldUseSeparateConnection()==true.
Even in this case accessor could be null - if SequencingControl().shouldUseSeparateConnection()==false;
Therefore in case shouldUseSeparateConnection()==true, implementation should handle
both cases: use a separate connection if provided (accessor != null), or get by
without it (accessor == null).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>accessor</code> - Accessor is a separate sequencing accessor (may be null);</dd>
<dd><code>writeSession</code> - Session is a Session used for writing (either ClientSession or DatabaseSession);</dd>
</dl>
</li>
</ul>
<a name="onConnect-org.eclipse.persistence.internal.databaseaccess.Platform-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onConnect</h4>
<pre>public&nbsp;void&nbsp;onConnect(org.eclipse.persistence.internal.databaseaccess.Platform&nbsp;platform)</pre>
<div class="block">INTERNAL:
This method is called when Sequencing object is created.
Don't override this method.</div>
</li>
</ul>
<a name="onConnect--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onConnect</h4>
<pre>public abstract&nbsp;void&nbsp;onConnect()</pre>
<div class="block">INTERNAL:
This method is called when Sequencing object is created.
If it requires initialization, subclass should override this method.</div>
</li>
</ul>
<a name="onDisconnect-org.eclipse.persistence.internal.databaseaccess.Platform-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onDisconnect</h4>
<pre>public&nbsp;void&nbsp;onDisconnect(org.eclipse.persistence.internal.databaseaccess.Platform&nbsp;platform)</pre>
<div class="block">INTERNAL:
This method is called when Sequencing object is destroyed.
Don't override this method.</div>
</li>
</ul>
<a name="onDisconnect--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onDisconnect</h4>
<pre>public abstract&nbsp;void&nbsp;onDisconnect()</pre>
<div class="block">INTERNAL:
This method is called when Sequencing object is destroyed.
If it requires deinitialization, subclass should override this method.</div>
</li>
</ul>
<a name="isConnected--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConnected</h4>
<pre>public&nbsp;boolean&nbsp;isConnected()</pre>
<div class="block">PUBLIC:
Indicates that Sequence is connected.</div>
</li>
</ul>
<a name="verifyPlatform-org.eclipse.persistence.internal.databaseaccess.Platform-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verifyPlatform</h4>
<pre>protected&nbsp;void&nbsp;verifyPlatform(org.eclipse.persistence.internal.databaseaccess.Platform&nbsp;otherPlatform)</pre>
<div class="block">INTERNAL:
Make sure that the sequence is not used by more than one platform.</div>
</li>
</ul>
<a name="setQualifier-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQualifier</h4>
<pre>public&nbsp;void&nbsp;setQualifier(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;qualifier)</pre>
<div class="block">INTERNAL:</div>
</li>
</ul>
<a name="isCustomQualifier--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCustomQualifier</h4>
<pre>public&nbsp;boolean&nbsp;isCustomQualifier()</pre>
<div class="block">INTERNAL:</div>
</li>
</ul>
<a name="getQualifier--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQualifier</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getQualifier()</pre>
<div class="block">INTERNAL:</div>
</li>
</ul>
<a name="getQualified-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getQualified</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getQualified(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str)</pre>
<div class="block">INTERNAL:</div>
</li>
</ul>
<a name="setShouldAlwaysOverrideExistingValue-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setShouldAlwaysOverrideExistingValue</h4>
<pre>public&nbsp;void&nbsp;setShouldAlwaysOverrideExistingValue(boolean&nbsp;shouldAlwaysOverrideExistingValue)</pre>
<div class="block">ADVANCED:
Set that to true if the sequence should always override the existing pk value.</div>
</li>
</ul>
<a name="shouldAlwaysOverrideExistingValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldAlwaysOverrideExistingValue</h4>
<pre>public&nbsp;boolean&nbsp;shouldAlwaysOverrideExistingValue()</pre>
<div class="block">INTERNAL:
Indicates whether the existing pk value should always be overridden by the sequence.
As always the version of the method taking seqName is provided for the benefit
of DefaultSequence.</div>
</li>
</ul>
<a name="shouldAlwaysOverrideExistingValue-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>shouldAlwaysOverrideExistingValue</h4>
<pre>public&nbsp;boolean&nbsp;shouldAlwaysOverrideExistingValue(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;seqName)</pre>
<div class="block">INTERNAL:
Indicates whether the existing pk value should always be overridden by the sequence.</div>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><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">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="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">EclipseLink 3.0.2, API Reference</div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/eclipse/persistence/sequencing/QuerySequence.html" title="class in org.eclipse.persistence.sequencing"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/eclipse/persistence/sequencing/SequencingControl.html" title="interface in org.eclipse.persistence.sequencing"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/eclipse/persistence/sequencing/Sequence.html" target="_top">Frames</a></li>
<li><a href="Sequence.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &#169; 2007&#x2013;2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p>
</body>
</html>