Package org.eclipse.persistence.tools.schemaframework

Class SequenceObjectDefinition

java.lang.Object

org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

org.eclipse.persistence.tools.schemaframework.SequenceDefinition

org.eclipse.persistence.tools.schemaframework.SequenceObjectDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class SequenceObjectDefinition
extends SequenceDefinition

Purpose: Sequence definition Native Sequence object.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.eclipse.persistence.tools.schemaframework.SequenceDefinition

sequence

Fields inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

name, qualifier

Constructor Summary

Constructors

Constructor	Description
SequenceObjectDefinition(Sequence sequence)	INTERNAL: Should be a sequence defining sequence object in the db: either NativeSequence with shouldAcquireValueAfterInsert() returning false; or DefaultSequence (only if case platform.getDefaultSequence() is a NativeSequence with shouldAcquireValueAfterInsert() returning false).

Method Summary

Modifier and Type	Method	Description
void	alterIncrement(AbstractSession session, Writer schemaWriter)	INTERNAL: Execute the SQL required to alter sequence increment.
void	alterOnDatabase(AbstractSession session)	INTERNAL: Execute the SQL required to alter sequence increment.
Writer	buildAlterIncrementWriter(AbstractSession session, Writer writer)	INTERNAL: Return the SQL required to alter INCREMENT BY
Writer	buildCreationWriter(AbstractSession session, Writer writer)	INTERNAL: Return the SQL required to create the Oracle sequence object.
Writer	buildDeletionWriter(AbstractSession session, Writer writer)	INTERNAL: Return the SQL required to drop the Oracle sequence object.
boolean	checkIfExist(AbstractSession session)	INTERNAL: Check if the sequence object already exists, in which case dont create it.
String	getFullName()	INTERNAL: Most major databases support a creator name scope.
boolean	isAlterSupported(AbstractSession session)	INTERNAL: Indicates whether alterIncrement is supported

Methods inherited from class org.eclipse.persistence.tools.schemaframework.SequenceDefinition

alter, buildTableDefinition, createOnDatabase, isTableSequenceDefinition

Methods inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

buildVPDCreationFunctionWriter, buildVPDCreationPolicyWriter, buildVPDDeletionWriter, clone, createDatabaseSchema, createDatabaseSchemaOnDatabase, createObject, dropDatabaseSchema, dropDatabaseSchemaOnDatabase, dropFromDatabase, dropObject, getDatabaseSchema, getFieldTypeDefinition, getFieldTypeDefinition, getName, getQualifier, hasDatabaseSchema, postCreateObject, preDropObject, setName, setQualifier, shouldCreateDatabaseSchema, shouldCreateVPDCalls, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SequenceObjectDefinition

public SequenceObjectDefinition(Sequence sequence)

INTERNAL: Should be a sequence defining sequence object in the db: either NativeSequence with shouldAcquireValueAfterInsert() returning false; or DefaultSequence (only if case platform.getDefaultSequence() is a NativeSequence with shouldAcquireValueAfterInsert() returning false).

Method Detail

buildCreationWriter

public Writer buildCreationWriter(AbstractSession session,
                                  Writer writer)

INTERNAL: Return the SQL required to create the Oracle sequence object.

Specified by:

buildCreationWriter in class DatabaseObjectDefinition

buildDeletionWriter

public Writer buildDeletionWriter(AbstractSession session,
                                  Writer writer)

INTERNAL: Return the SQL required to drop the Oracle sequence object.

Specified by:

buildDeletionWriter in class DatabaseObjectDefinition

buildAlterIncrementWriter

public Writer buildAlterIncrementWriter(AbstractSession session,
                                        Writer writer)

INTERNAL: Return the SQL required to alter INCREMENT BY

checkIfExist

public boolean checkIfExist(AbstractSession session)
                     throws DatabaseException

INTERNAL: Check if the sequence object already exists, in which case dont create it.

Specified by:

checkIfExist in class SequenceDefinition

Throws:

DatabaseException

isAlterSupported

public boolean isAlterSupported(AbstractSession session)

INTERNAL: Indicates whether alterIncrement is supported

Overrides:

isAlterSupported in class SequenceDefinition

alterOnDatabase

public void alterOnDatabase(AbstractSession session)
                     throws EclipseLinkException

INTERNAL: Execute the SQL required to alter sequence increment. Assume that the sequence exists.

Overrides:

alterOnDatabase in class SequenceDefinition

Throws:

EclipseLinkException

alterIncrement

public void alterIncrement(AbstractSession session,
                           Writer schemaWriter)
                    throws ValidationException

INTERNAL: Execute the SQL required to alter sequence increment. Assume that the sequence exists.

Throws:

ValidationException

getFullName

public String getFullName()

INTERNAL: Most major databases support a creator name scope. This means whenever the database object is referenced, it must be qualified.

Overrides:

getFullName in class DatabaseObjectDefinition