TableSequence (EclipseLink 2.6.7, API Reference)

java.lang.Object
- org.eclipse.persistence.sequencing.Sequence
- - org.eclipse.persistence.sequencing.StandardSequence
  - - org.eclipse.persistence.sequencing.QuerySequence
    - - org.eclipse.persistence.sequencing.TableSequence

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class TableSequence
extends QuerySequence
```
Purpose: Defines sequencing through using a SEQUENCE table.
Description This is the default sequencing mechanism. A table defaulting to SEQUENCE is used to generate unique ids. The table has a name field (SEQ_NAME) storing each sequences name, and a counter (SEQ_COUNT) storing the last sequence id generated. There will be a row in the table for each sequence object.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`counterFieldName` Hold the name of the column in the sequence table which specifies the sequence numeric value
`static java.lang.String`	`defaultTableName` Deprecated. Use an empty string as a default sequence table name instead, that triggers usage of platform.getDefaultSequenceTableName() when the sequence is connected.
`protected java.lang.String`	`nameFieldName` Hold the name of the column in the sequence table which specifies the sequence name
`protected org.eclipse.persistence.internal.helper.DatabaseTable`	`table` Hold the database table

Fields inherited from class org.eclipse.persistence.sequencing.QuerySequence
selectQuery, shouldAcquireValueAfterInsert, shouldSelectBeforeUpdate, shouldSkipUpdate, shouldUseTransaction, updateQuery, wasSelectQueryCreated, wasUpdateQueryCreated

Fields inherited from class org.eclipse.persistence.sequencing.Sequence
depth, initialValue, isCustomQualifier, name, platform, qualifier, shouldAlwaysOverrideExistingValue, size

Constructor Summary

Constructors
Constructor and Description
`TableSequence()`
`TableSequence(java.lang.String name)` Create a new sequence with the name.
`TableSequence(java.lang.String name, int size)` Create a new sequence with the name and sequence pre-allocation size.
`TableSequence(java.lang.String name, int size, int initialValue)`
`TableSequence(java.lang.String name, int size, java.lang.String tableName)`
`TableSequence(java.lang.String name, int size, java.lang.String tableName, java.lang.String nameFieldName, java.lang.String counterFieldName)`
`TableSequence(java.lang.String name, java.lang.String tableName)` Create a new sequence with the name, and the sequence table name.
`TableSequence(java.lang.String name, java.lang.String tableName, java.lang.String nameFieldName, java.lang.String counterFieldName)` Create a new sequence with the name, and the sequence table information.

Method Summary

Methods
Modifier and Type	Method and Description
`protected ValueReadQuery`	`buildSelectQuery()` INTERNAL:
`protected DataModifyQuery`	`buildUpdateQuery()` INTERNAL:
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getCounterFieldName()`
`java.lang.String`	`getNameFieldName()`
`java.lang.String`	`getQualifiedTableName()`
`org.eclipse.persistence.internal.helper.DatabaseTable`	`getTable()`
`java.util.List<IndexDefinition>`	`getTableIndexes()`
`java.lang.String`	`getTableName()`
`boolean`	`isTable()`
`void`	`onConnect()` INTERNAL:
`void`	`setCounterFieldName(java.lang.String name)`
`void`	`setNameFieldName(java.lang.String name)`
`void`	`setTable(org.eclipse.persistence.internal.helper.DatabaseTable table)`
`void`	`setTableName(java.lang.String name)`

Methods inherited from class org.eclipse.persistence.sequencing.QuerySequence
buildSelectQuery, buildUpdateQuery, createArguments, getSelectQuery, getUpdateQuery, onDisconnect, select, setSelectQuery, setShouldAcquireValueAfterInsert, setShouldSelectBeforeUpdate, setShouldSkipUpdate, setShouldUseTransaction, setUpdateQuery, shouldAcquireValueAfterInsert, shouldSelectBeforeUpdate, shouldSkipUpdate, shouldUseTransaction, update, updateAndSelectSequence

Methods inherited from class org.eclipse.persistence.sequencing.StandardSequence
createVector, getGeneratedValue, getGeneratedVector, setInitialValue

Methods inherited from class org.eclipse.persistence.sequencing.Sequence
clone, equalNameAndSize, getDatasourcePlatform, getGeneratedValue, getGeneratedVector, getInitialValue, getName, getPreallocationSize, getQualified, getQualifier, isConnected, isCustomQualifier, isNative, isUnaryTable, onConnect, onDisconnect, setDatasourcePlatform, setName, setPreallocationSize, setQualifier, setShouldAlwaysOverrideExistingValue, shouldAlwaysOverrideExistingValue, shouldAlwaysOverrideExistingValue, shouldUsePreallocation, toString, verifyPlatform

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- defaultTableName
```
public static final java.lang.String defaultTableName
```
  Deprecated. Use an empty string as a default sequence table name instead, that triggers usage of platform.getDefaultSequenceTableName() when the sequence is connected.
  
  Default sequence table name
  
  See Also:
  Constant Field Values
- table
```
protected org.eclipse.persistence.internal.helper.DatabaseTable table
```
  Hold the database table
- counterFieldName
```
protected java.lang.String counterFieldName
```
  Hold the name of the column in the sequence table which specifies the sequence numeric value
- nameFieldName
```
protected java.lang.String nameFieldName
```
  Hold the name of the column in the sequence table which specifies the sequence name

Constructor Detail

TableSequence
```
public TableSequence()
```

TableSequence
```
public TableSequence(java.lang.String name)
```
Create a new sequence with the name.

TableSequence
```
public TableSequence(java.lang.String name,
             int size)
```
Create a new sequence with the name and sequence pre-allocation size.

TableSequence

public TableSequence(java.lang.String name,
             int size,
             int initialValue)

TableSequence

public TableSequence(java.lang.String name,
             java.lang.String tableName)

Create a new sequence with the name, and the sequence table name.

TableSequence

public TableSequence(java.lang.String name,
             java.lang.String tableName,
             java.lang.String nameFieldName,
             java.lang.String counterFieldName)

Create a new sequence with the name, and the sequence table information.

TableSequence

public TableSequence(java.lang.String name,
             int size,
             java.lang.String tableName)

TableSequence

public TableSequence(java.lang.String name,
             int size,
             java.lang.String tableName,
             java.lang.String nameFieldName,
             java.lang.String counterFieldName)

Method Detail

isTable
```
public boolean isTable()
```
Overrides:

isTable in class Sequence

equals

public boolean equals(java.lang.Object obj)

Overrides:: equals in class QuerySequence

getCounterFieldName

public java.lang.String getCounterFieldName()

setCounterFieldName

public void setCounterFieldName(java.lang.String name)

getNameFieldName

public java.lang.String getNameFieldName()

setNameFieldName

public void setNameFieldName(java.lang.String name)

getTable

public org.eclipse.persistence.internal.helper.DatabaseTable getTable()

getTableIndexes

public java.util.List<IndexDefinition> getTableIndexes()

getTableName

public java.lang.String getTableName()

getQualifiedTableName

public java.lang.String getQualifiedTableName()

setTable

public void setTable(org.eclipse.persistence.internal.helper.DatabaseTable table)

setTableName

public void setTableName(java.lang.String name)

onConnect
```
public void onConnect()
```
Description copied from class: QuerySequence

INTERNAL:

Overrides:

onConnect in class QuerySequence

buildSelectQuery
```
protected ValueReadQuery buildSelectQuery()
```
Description copied from class: QuerySequence

INTERNAL:

Overrides:

buildSelectQuery in class QuerySequence

buildUpdateQuery
```
protected DataModifyQuery buildUpdateQuery()
```
Description copied from class: QuerySequence

INTERNAL:

Overrides:

buildUpdateQuery in class QuerySequence

Class TableSequence

Field Summary

Fields inherited from class org.eclipse.persistence.sequencing.QuerySequence

Fields inherited from class org.eclipse.persistence.sequencing.Sequence

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.persistence.sequencing.QuerySequence

Methods inherited from class org.eclipse.persistence.sequencing.StandardSequence

Methods inherited from class org.eclipse.persistence.sequencing.Sequence

Methods inherited from class java.lang.Object

Field Detail

defaultTableName

table

counterFieldName

nameFieldName

Constructor Detail

TableSequence

TableSequence

TableSequence

TableSequence

TableSequence

TableSequence

TableSequence

TableSequence

Method Detail

isTable

equals

getCounterFieldName

setCounterFieldName

getNameFieldName

setNameFieldName

getTable

getTableIndexes

getTableName

getQualifiedTableName

setTable

setTableName

onConnect

buildSelectQuery

buildUpdateQuery