Module org.eclipse.persistence.core

Package org.eclipse.persistence.tools.schemaframework

Class TableSequenceDefinition

java.lang.Object

org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

org.eclipse.persistence.tools.schemaframework.SequenceDefinition

org.eclipse.persistence.tools.schemaframework.TableSequenceDefinition

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

UnaryTableSequenceDefinition

public class TableSequenceDefinition
extends SequenceDefinition

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 boolean	deleteSchema
protected TableDefinition	tableDefinition

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
TableSequenceDefinition(Sequence sequence, boolean deleteSchema)	INTERNAL: Should be a sequence defining table sequence in the db: either TableSequence DefaultSequence (only if case platform.getDefaultSequence() is a TableSequence).

Method Summary

Modifier and Type	Method	Description
Writer	buildCreationWriter(AbstractSession session, Writer writer)	INTERNAL: Return the SQL required to insert the sequence row into the sequence table.
Writer	buildDeletionWriter(AbstractSession session, Writer writer)	INTERNAL: Return the SQL to delete the row from the sequence table.
TableDefinition	buildTableDefinition()	INTERNAL: Return a TableDefinition specifying sequence table.
boolean	checkIfExist(AbstractSession session)	INTERAL: Execute the SQL required to insert the sequence row into the sequence table.
void	dropDatabaseSchema(AbstractSession session, Writer writer)	INTERNAL: Execute the DDL to drop the database schema for this object.
void	dropDatabaseSchemaOnDatabase(AbstractSession session)	INTERNAL: Execute the DDL to drop the database schema for this object.
String	getDatabaseSchema()	PUBLIC: Return the schema associated with this table sequence.
String	getSequenceCounterFieldName()	PUBLIC:
String	getSequenceNameFieldName()	PUBLIC:
DatabaseTable	getSequenceTable()	Return the database table for the sequence.
List<IndexDefinition>	getSequenceTableIndexes()	PUBLIC:
String	getSequenceTableName()	PUBLIC:
String	getSequenceTableQualifiedName()	PUBLIC:
String	getSequenceTableQualifier()	PUBLIC:
protected TableSequence	getTableSequence()
boolean	isTableSequenceDefinition()	INTERNAL:
void	preDropObject(AbstractSession session, Writer dropSchemaWriter, boolean createSQLFiles)	Execute any statements required before the deletion of the object
protected boolean	shouldDropTableDefinition()	INTERNAL: Returns true if the table definition should be dropped during buildDeletionWriter.

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

alter, alterOnDatabase, createOnDatabase, isAlterSupported

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

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

Methods inherited from class java.lang.Object

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

Field Details

tableDefinition

protected TableDefinition tableDefinition

deleteSchema

protected boolean deleteSchema

Constructor Details

TableSequenceDefinition

public TableSequenceDefinition(Sequence sequence,
 boolean deleteSchema)

INTERNAL: Should be a sequence defining table sequence in the db: either TableSequence DefaultSequence (only if case platform.getDefaultSequence() is a TableSequence).

Method Details

buildCreationWriter

public Writer buildCreationWriter(AbstractSession session,
 Writer writer)
                           throws ValidationException

INTERNAL: Return the SQL required to insert the sequence row into the sequence table. Assume that the sequence table exists.

Specified by:

buildCreationWriter in class DatabaseObjectDefinition

Throws:

ValidationException

buildDeletionWriter

public Writer buildDeletionWriter(AbstractSession session,
 Writer writer)
                           throws ValidationException

INTERNAL: Return the SQL to delete the row from the sequence table. If we're dealing with create creation, then delegate to the table so that is dropped outright since we will delete the schema.

Specified by:

buildDeletionWriter in class DatabaseObjectDefinition

Throws:

ValidationException

checkIfExist

public boolean checkIfExist(AbstractSession session)
                     throws DatabaseException

INTERAL: Execute the SQL required to insert the sequence row into the sequence table. Assume that the sequence table exists.

Specified by:

checkIfExist in class SequenceDefinition

Throws:

DatabaseException

dropDatabaseSchema

public void dropDatabaseSchema(AbstractSession session,
 Writer writer)
                        throws EclipseLinkException

INTERNAL: Execute the DDL to drop the database schema for this object. Does nothing at this level, subclasses that support this must override this method.

Overrides:

dropDatabaseSchema in class DatabaseObjectDefinition

Throws:

EclipseLinkException

See Also:

• TableDefinition

dropDatabaseSchemaOnDatabase

public void dropDatabaseSchemaOnDatabase(AbstractSession session)
                                  throws EclipseLinkException

INTERNAL: Execute the DDL to drop the database schema for this object. Does nothing at this level, subclasses that support this must override this method.

Overrides:

dropDatabaseSchemaOnDatabase in class DatabaseObjectDefinition

Throws:

EclipseLinkException

See Also:

• TableDefinition

getDatabaseSchema

public String getDatabaseSchema()

PUBLIC: Return the schema associated with this table sequence.

Overrides:

getDatabaseSchema in class DatabaseObjectDefinition

See Also:

• TableDefinition

getSequenceCounterFieldName

public String getSequenceCounterFieldName()

PUBLIC:

getSequenceNameFieldName

public String getSequenceNameFieldName()

PUBLIC:

getSequenceTable

public DatabaseTable getSequenceTable()

Return the database table for the sequence.

getSequenceTableIndexes

public List<IndexDefinition> getSequenceTableIndexes()

PUBLIC:

getSequenceTableName

public String getSequenceTableName()

PUBLIC:

getSequenceTableQualifier

public String getSequenceTableQualifier()

PUBLIC:

getSequenceTableQualifiedName

public String getSequenceTableQualifiedName()

PUBLIC:

buildTableDefinition

public TableDefinition buildTableDefinition()

INTERNAL: Return a TableDefinition specifying sequence table. Cache the table definition for re-use (during CREATE and DROP)

Overrides:

buildTableDefinition in class SequenceDefinition

getTableSequence

protected TableSequence getTableSequence()

isTableSequenceDefinition

public boolean isTableSequenceDefinition()

INTERNAL:

Overrides:

isTableSequenceDefinition in class SequenceDefinition

preDropObject

public void preDropObject(AbstractSession session,
 Writer dropSchemaWriter,
 boolean createSQLFiles)

Execute any statements required before the deletion of the object

Overrides:

preDropObject in class DatabaseObjectDefinition

shouldDropTableDefinition

protected boolean shouldDropTableDefinition()

INTERNAL: Returns true if the table definition should be dropped during buildDeletionWriter.