Top Description Fields Constructors Methods
org.eclipse.persistence.tools.schemaframework

public Class SequenceObjectDefinition

extends SequenceDefinition
Class Inheritance
Imports
java.io.*, org.eclipse.persistence.queries.SQLCall, org.eclipse.persistence.exceptions.*, org.eclipse.persistence.sequencing.Sequence, org.eclipse.persistence.internal.sessions.AbstractSession

Purpose: Sequence definition Native Sequence object.

Field Summary

Inherited from org.eclipse.persistence.tools.schemaframework.SequenceDefinition:
sequence

Constructor Summary

AccessConstructor and Description
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 Summary

Modifier and TypeMethod and Description
public void
alterIncrement(AbstractSession session, Writer schemaWriter)

INTERNAL: Execute the SQL required to alter sequence increment.

public void
alterOnDatabase(AbstractSession session)

Overrides org.eclipse.persistence.tools.schemaframework.SequenceDefinition.alterOnDatabase.

INTERNAL: Execute the SQL required to alter sequence increment.
public Writer
buildAlterIncrementWriter(AbstractSession session, Writer writer)

INTERNAL: Return the SQL required to alter INCREMENT BY

public Writer
buildCreationWriter(AbstractSession session, Writer writer)

Implements abstract org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildCreationWriter.

INTERNAL: Return the SQL required to create the Oracle sequence object.
public Writer
buildDeletionWriter(AbstractSession session, Writer writer)

Implements abstract org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildDeletionWriter.

INTERNAL: Return the SQL required to drop the Oracle sequence object.
public boolean
checkIfExist(AbstractSession session)

Implements abstract org.eclipse.persistence.tools.schemaframework.SequenceDefinition.checkIfExist.

INTERNAL: Check if the sequence object already exists, in which case dont create it.
public String
getFullName()

Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.getFullName.

INTERNAL: Most major databases support a creator name scope.
public boolean
isAlterSupported(AbstractSession session)

Overrides org.eclipse.persistence.tools.schemaframework.SequenceDefinition.isAlterSupported.

INTERNAL: Indicates whether alterIncrement is supported
Inherited from org.eclipse.persistence.tools.schemaframework.SequenceDefinition:
alterbuildTableDefinitioncreateOnDatabaseisTableSequenceDefinition

Constructor Detail

SequenceObjectDefinitionback to summary
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

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

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

alterOnDatabaseback to summary
public void alterOnDatabase(AbstractSession session) throws EclipseLinkException

Overrides org.eclipse.persistence.tools.schemaframework.SequenceDefinition.alterOnDatabase.

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

Annotations
@Override
buildAlterIncrementWriterback to summary
public Writer buildAlterIncrementWriter(AbstractSession session, Writer writer)

INTERNAL: Return the SQL required to alter INCREMENT BY

buildCreationWriterback to summary
public Writer buildCreationWriter(AbstractSession session, Writer writer)

Implements abstract org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildCreationWriter.

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

Annotations
@Override
buildDeletionWriterback to summary
public Writer buildDeletionWriter(AbstractSession session, Writer writer)

Implements abstract org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.buildDeletionWriter.

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

Annotations
@Override
checkIfExistback to summary
public boolean checkIfExist(AbstractSession session) throws DatabaseException

Implements abstract org.eclipse.persistence.tools.schemaframework.SequenceDefinition.checkIfExist.

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

Annotations
@Override
getFullNameback to summary
public String getFullName()

Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.getFullName.

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

Annotations
@Override
isAlterSupportedback to summary
public boolean isAlterSupported(AbstractSession session)

Overrides org.eclipse.persistence.tools.schemaframework.SequenceDefinition.isAlterSupported.

INTERNAL: Indicates whether alterIncrement is supported

Annotations
@Override