EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

org.eclipse.persistence.sequencing
Class UUIDSequence

java.lang.Object
  extended by org.eclipse.persistence.sequencing.Sequence
      extended by org.eclipse.persistence.sequencing.UUIDSequence
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class UUIDSequence
extends Sequence

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.eclipse.persistence.sequencing.Sequence
depth, initialValue, isCustomQualifier, name, platform, qualifier, shouldAlwaysOverrideExistingValue, size
 
Constructor Summary
UUIDSequence()
           
UUIDSequence(java.lang.String name)
           
 
Method Summary
 java.lang.Object getGeneratedValue(org.eclipse.persistence.internal.databaseaccess.Accessor accessor, org.eclipse.persistence.internal.sessions.AbstractSession writeSession, java.lang.String seqName)
          INTERNAL: Return the newly-generated sequencing value.
 java.util.Vector getGeneratedVector(org.eclipse.persistence.internal.databaseaccess.Accessor accessor, org.eclipse.persistence.internal.sessions.AbstractSession writeSession, java.lang.String seqName, int size)
          INTERNAL: Return a Vector of newly-generated sequencing values.
 void onConnect()
          INTERNAL: This method is called when Sequencing object is created.
 void onDisconnect()
          INTERNAL: This method is called when Sequencing object is destroyed.
 boolean shouldAcquireValueAfterInsert()
          INTERNAL: Indicates whether sequencing value should be acquired after INSERT.
 boolean shouldUsePreallocation()
          INTERNAL: Indicates whether several sequencing values should be acquired at a time and be kept by TopLink.
 boolean shouldUseTransaction()
          INTERNAL: Indicates whether TopLink should internally call beginTransaction() before getGeneratedValue/Vector, and commitTransaction after.
 
Methods inherited from class org.eclipse.persistence.sequencing.Sequence
clone, equalNameAndSize, equals, getDatasourcePlatform, getGeneratedValue, getGeneratedVector, getInitialValue, getName, getPreallocationSize, getQualified, getQualifier, isConnected, isCustomQualifier, isNative, isTable, isUnaryTable, onConnect, onDisconnect, setDatasourcePlatform, setInitialValue, setName, setPreallocationSize, setQualifier, setShouldAlwaysOverrideExistingValue, shouldAlwaysOverrideExistingValue, shouldAlwaysOverrideExistingValue, toString, verifyPlatform
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UUIDSequence

public UUIDSequence()

UUIDSequence

public UUIDSequence(java.lang.String name)
Method Detail

getGeneratedValue

public java.lang.Object getGeneratedValue(org.eclipse.persistence.internal.databaseaccess.Accessor accessor,
                                          org.eclipse.persistence.internal.sessions.AbstractSession writeSession,
                                          java.lang.String seqName)
Description copied from class: Sequence
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).

Specified by:
getGeneratedValue in class Sequence
Parameters:
accessor - Accessor is a separate sequencing accessor (may be null);
writeSession - Session is a Session used for writing (either ClientSession or DatabaseSession);
seqName - String is sequencing number field name

getGeneratedVector

public java.util.Vector getGeneratedVector(org.eclipse.persistence.internal.databaseaccess.Accessor accessor,
                                           org.eclipse.persistence.internal.sessions.AbstractSession writeSession,
                                           java.lang.String seqName,
                                           int size)
Description copied from class: Sequence
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).

Specified by:
getGeneratedVector in class Sequence
Parameters:
accessor - Accessor is a separate sequencing accessor (may be null);
writeSession - Session is a Session used for writing (either ClientSession or DatabaseSession);
seqName - String is sequencing number field name
size - int number of values to preallocate (output Vector size).

onConnect

public void onConnect()
Description copied from class: Sequence
INTERNAL: This method is called when Sequencing object is created. If it requires initialization, subclass should override this method.

Specified by:
onConnect in class Sequence

onDisconnect

public void onDisconnect()
Description copied from class: Sequence
INTERNAL: This method is called when Sequencing object is destroyed. If it requires deinitialization, subclass should override this method.

Specified by:
onDisconnect in class Sequence

shouldAcquireValueAfterInsert

public boolean shouldAcquireValueAfterInsert()
Description copied from class: Sequence
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.

Specified by:
shouldAcquireValueAfterInsert in class Sequence

shouldUseTransaction

public boolean shouldUseTransaction()
Description copied from class: Sequence
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.

Specified by:
shouldUseTransaction in class Sequence

shouldUsePreallocation

public boolean shouldUsePreallocation()
Description copied from class: Sequence
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.

Overrides:
shouldUsePreallocation in class Sequence

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference