Module org.eclipse.persistence.core

Package org.eclipse.persistence.tools.schemaframework

Class SequenceDefinition

java.lang.Object

org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

org.eclipse.persistence.tools.schemaframework.SequenceDefinition

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

SequenceObjectDefinition, TableSequenceDefinition

public abstract class SequenceDefinition
extends DatabaseObjectDefinition

Purpose: Allow a generic way of creating sequences on the different platforms, and allow optional parameters to be specified.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Sequence	sequence

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

name, qualifier

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SequenceDefinition(String name)
protected	SequenceDefinition(Sequence sequence)

Method Summary

Modifier and Type	Method	Description
void	alter(AbstractSession session, Writer writer)	INTERNAL: Execute the SQL required to alter sequence.
void	alterOnDatabase(AbstractSession session)	INTERNAL: By default does nothing.
TableDefinition	buildTableDefinition()	INTERNAL: Return a TableDefinition
abstract boolean	checkIfExist(AbstractSession session)	INTERAL: Verify whether the sequence exists.
void	createOnDatabase(AbstractSession session)	INTERNAL: Creates this sequence definition on the database.
boolean	isAlterSupported(AbstractSession session)	INTERNAL: Indicates whether alter is supported
boolean	isTableSequenceDefinition()	INTERNAL:

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

buildCreationWriter, buildDeletionWriter, buildVPDCreationFunctionWriter, buildVPDCreationPolicyWriter, buildVPDDeletionWriter, clone, createDatabaseSchema, createDatabaseSchemaOnDatabase, createObject, dropDatabaseSchema, dropDatabaseSchemaOnDatabase, dropFromDatabase, dropObject, getDatabaseSchema, getFieldTypeDefinition, getFieldTypeDefinition, getFullName, 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

Field Details

sequence

protected Sequence sequence

Constructor Details

SequenceDefinition

protected SequenceDefinition(String name)

SequenceDefinition

protected SequenceDefinition(Sequence sequence)

Method Details

checkIfExist

public abstract boolean checkIfExist(AbstractSession session)
                              throws DatabaseException

INTERAL: Verify whether the sequence exists.

Throws:

DatabaseException

isAlterSupported

public boolean isAlterSupported(AbstractSession session)

INTERNAL: Indicates whether alter is supported

isTableSequenceDefinition

public boolean isTableSequenceDefinition()

INTERNAL:

alterOnDatabase

public void alterOnDatabase(AbstractSession session)
                     throws EclipseLinkException

INTERNAL: By default does nothing.

Throws:

EclipseLinkException

alter

public void alter(AbstractSession session,
 Writer writer)
           throws ValidationException

INTERNAL: Execute the SQL required to alter sequence. By default does nothing.

Throws:

ValidationException

createOnDatabase

public void createOnDatabase(AbstractSession session)
                      throws EclipseLinkException

INTERNAL: Creates this sequence definition on the database. If it already exists, the method will attempt to alter it based on what the platform supports.

Overrides:

createOnDatabase in class DatabaseObjectDefinition

Throws:

EclipseLinkException

buildTableDefinition

public TableDefinition buildTableDefinition()

INTERNAL: Return a TableDefinition