NativeSequence (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.NativeSequence

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class NativeSequence
extends QuerySequence
```
Purpose: Define a database's native sequencing mechanism.
Description Many databases have built in support for sequencing. This can be a SEQUENCE object such as in Oracle, or a auto-incrementing column such as the IDENTITY field in Sybase. For an auto-incrementing column the preallocation size is always 1. For a SEQUENCE object the preallocation size must match the SEQUENCE objects "increment by".

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected QuerySequence`	`delegateSequence` Allow sequencing to be delegated to another sequence if native sequencing is not supported.
`protected boolean`	`shouldUseIdentityIfPlatformSupports` true indicates that identity should be used - if the platform supports identity.

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
`NativeSequence()`
`NativeSequence(boolean shouldUseIdentityIfPlatformSupports)`
`NativeSequence(java.lang.String name)` Create a new sequence with the name.
`NativeSequence(java.lang.String name, boolean shouldUseIdentityIfPlatformSupports)`
`NativeSequence(java.lang.String name, int size)` Create a new sequence with the name and sequence pre-allocation size.
`NativeSequence(java.lang.String name, int size, boolean shouldUseIdentityIfPlatformSupports)`
`NativeSequence(java.lang.String name, int size, int initialValue)`
`NativeSequence(java.lang.String name, int size, int initialValue, boolean shouldUseIdentityIfPlatformSupports)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected ValueReadQuery`	`buildSelectQuery()` INTERNAL:
`protected ValueReadQuery`	`buildSelectQuery(java.lang.String seqName, java.lang.Integer size)` INTERNAL:
`boolean`	`equals(java.lang.Object obj)`
`QuerySequence`	`getDelegateSequence()` Return the sequence delegate.
`boolean`	`hasDelegateSequence()` Return if the sequence should be replaced by another sequence implementation.
`boolean`	`isNative()`
`void`	`onConnect()` INTERNAL:
`void`	`onDisconnect()` INTERNAL:
`void`	`setDelegateSequence(QuerySequence delegateSequence)` Set the sequence delegate.
`void`	`setShouldUseIdentityIfPlatformSupports(boolean shouldUseIdentityIfPlatformSupports)`
`boolean`	`shouldUseIdentityIfPlatformSupports()`

Methods inherited from class org.eclipse.persistence.sequencing.QuerySequence
buildUpdateQuery, buildUpdateQuery, createArguments, getSelectQuery, getUpdateQuery, 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, isTable, 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
- shouldUseIdentityIfPlatformSupports
```
protected boolean shouldUseIdentityIfPlatformSupports
```
  true indicates that identity should be used - if the platform supports identity. false indicates that sequence objects should be used - if the platform supports sequence objects.
- delegateSequence
```
protected QuerySequence delegateSequence
```
  Allow sequencing to be delegated to another sequence if native sequencing is not supported.

Constructor Detail

NativeSequence
```
public NativeSequence()
```

NativeSequence

public NativeSequence(boolean shouldUseIdentityIfPlatformSupports)

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

NativeSequence

public NativeSequence(java.lang.String name,
              boolean shouldUseIdentityIfPlatformSupports)

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

NativeSequence

public NativeSequence(java.lang.String name,
              int size,
              boolean shouldUseIdentityIfPlatformSupports)

NativeSequence

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

NativeSequence

public NativeSequence(java.lang.String name,
              int size,
              int initialValue,
              boolean shouldUseIdentityIfPlatformSupports)

Method Detail
- isNative
```
public boolean isNative()
```
  Overrides:
  
  isNative in class Sequence
- setShouldUseIdentityIfPlatformSupports
```
public void setShouldUseIdentityIfPlatformSupports(boolean shouldUseIdentityIfPlatformSupports)
```
- shouldUseIdentityIfPlatformSupports
```
public boolean shouldUseIdentityIfPlatformSupports()
```
- equals
```
public boolean equals(java.lang.Object obj)
```
  Overrides:
  
  equals in class QuerySequence
- buildSelectQuery
```
protected ValueReadQuery buildSelectQuery()
```
  INTERNAL:
  
  Overrides:
  
  buildSelectQuery in class QuerySequence
- buildSelectQuery
```
protected ValueReadQuery buildSelectQuery(java.lang.String seqName,
                              java.lang.Integer size)
```
  INTERNAL:
  
  Overrides:
  
  buildSelectQuery in class QuerySequence
- hasDelegateSequence
```
public boolean hasDelegateSequence()
```
  Return if the sequence should be replaced by another sequence implementation. This is used when the platform does not support the native sequence type.
- getDelegateSequence
```
public QuerySequence getDelegateSequence()
```
  Return the sequence delegate. This is used when the platform does not support the native sequence type.
- setDelegateSequence
```
public void setDelegateSequence(QuerySequence delegateSequence)
```
  Set the sequence delegate. This is used when the platform does not support the native sequence type.
- onConnect
```
public void onConnect()
```
  INTERNAL:
  
  Overrides:
  
  onConnect in class QuerySequence
- onDisconnect
```
public void onDisconnect()
```
  INTERNAL:
  
  Overrides:
  
  onDisconnect in class QuerySequence

Class NativeSequence

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

shouldUseIdentityIfPlatformSupports

delegateSequence

Constructor Detail

NativeSequence

NativeSequence

NativeSequence

NativeSequence

NativeSequence

NativeSequence

NativeSequence

NativeSequence

Method Detail

isNative

setShouldUseIdentityIfPlatformSupports

shouldUseIdentityIfPlatformSupports

equals

buildSelectQuery

buildSelectQuery

hasDelegateSequence

getDelegateSequence

setDelegateSequence

onConnect

onDisconnect