Module eclipselink

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(String name, boolean deleteSchema)	INTERNAL: Should be a sequence defining table sequence in the db: either TableSequence DefaultSequence (only if case platform.getDefaultSequence() is a TableSequence).
TableSequenceDefinition(Sequence sequence, boolean deleteSchema)	Deprecated, for removal: This API element is subject to removal in a future version. Use TableSequenceDefinition(String, boolean) instead.

Method Summary

Modifier and Type	Method	Description
Writer	buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer writer)	Deprecated, for removal: This API element is subject to removal in a future version.
Writer	buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer writer)	Deprecated, for removal: This API element is subject to removal in a future version.
TableDefinition	buildTableDefinition()	INTERNAL: Return a TableDefinition specifying sequence table.
boolean	checkIfExist(org.eclipse.persistence.internal.sessions.AbstractSession session)	Deprecated, for removal: This API element is subject to removal in a future version. Implement DatabasePlatform.checkSequenceExists(...) instead.
void	dropDatabaseSchema(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer writer)	Deprecated, for removal: This API element is subject to removal in a future version.
void	dropDatabaseSchemaOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)	Deprecated, for removal: This API element is subject to removal in a future version.
String	getDatabaseSchema()	PUBLIC: Return the schema associated with this table sequence.
String	getSequenceCounterFieldName()	PUBLIC:
String	getSequenceNameFieldName()	PUBLIC:
org.eclipse.persistence.internal.helper.DatabaseTable	getSequenceTable()	Deprecated, for removal: This API element is subject to removal in a future version. To be removed with no replacement.
List<IndexDefinition>	getSequenceTableIndexes()	PUBLIC:
String	getSequenceTableName()	PUBLIC:
String	getSequenceTableQualifiedName()	PUBLIC:
String	getSequenceTableQualifier()	PUBLIC:
protected TableSequence	getTableSequence()	Deprecated, for removal: This API element is subject to removal in a future version. To be removed with no replacement.
boolean	isTableSequenceDefinition()	INTERNAL:
void	preDropObject(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer dropSchemaWriter, boolean createSQLFiles)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setSequenceCounterFieldName(String sequenceCounterFieldName)
void	setSequenceNameFieldName(String sequenceNameFieldName)
void	setSequenceTableIndexes(List<IndexDefinition> sequenceTableIndexes)
void	setSequenceTableName(String sequenceTableName)
void	setSequenceTableQualifier(String sequenceTableQualifier)
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, getInitialValue, getPreallocationSize, isAlterSupported, setInitialValue, setPreallocationSize

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 Detail

tableDefinition

protected TableDefinition tableDefinition

deleteSchema

protected boolean deleteSchema

Constructor Detail

TableSequenceDefinition

@Deprecated(forRemoval=true,
            since="4.0.9")
public TableSequenceDefinition(Sequence sequence,
                               boolean deleteSchema)

Deprecated, for removal: This API element is subject to removal in a future version.

Use TableSequenceDefinition(String, boolean) instead.

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

TableSequenceDefinition

public TableSequenceDefinition(String name,
                               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 Detail

buildCreationWriter

@Deprecated(forRemoval=true,
            since="4.0.9")
public Writer buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                  Writer writer)
                           throws ValidationException

Deprecated, for removal: This API element is subject to removal in a future version.

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

@Deprecated(forRemoval=true,
            since="4.0.9")
public Writer buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                  Writer writer)
                           throws ValidationException

Deprecated, for removal: This API element is subject to removal in a future version.

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

@Deprecated(forRemoval=true,
            since="4.0.9")
public boolean checkIfExist(org.eclipse.persistence.internal.sessions.AbstractSession session)
                     throws DatabaseException

Deprecated, for removal: This API element is subject to removal in a future version.

Implement DatabasePlatform.checkSequenceExists(...) instead.

INTERNAL: 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

@Deprecated(forRemoval=true,
            since="4.0.9")
public void dropDatabaseSchema(org.eclipse.persistence.internal.sessions.AbstractSession session,
                               Writer writer)
                        throws EclipseLinkException

Deprecated, for removal: This API element is subject to removal in a future version.

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

@Deprecated(forRemoval=true,
            since="4.0.9")
public void dropDatabaseSchemaOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
                                  throws EclipseLinkException

Deprecated, for removal: This API element is subject to removal in a future version.

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

@Deprecated(forRemoval=true,
            since="4.0.9")
public org.eclipse.persistence.internal.helper.DatabaseTable getSequenceTable()

Deprecated, for removal: This API element is subject to removal in a future version.

To be removed with no replacement.

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

@Deprecated(forRemoval=true,
            since="4.0.9")
protected TableSequence getTableSequence()

Deprecated, for removal: This API element is subject to removal in a future version.

To be removed with no replacement.

isTableSequenceDefinition

public boolean isTableSequenceDefinition()

INTERNAL:

Overrides:

isTableSequenceDefinition in class SequenceDefinition

preDropObject

@Deprecated(forRemoval=true,
            since="4.0.9")
public void preDropObject(org.eclipse.persistence.internal.sessions.AbstractSession session,
                          Writer dropSchemaWriter,
                          boolean createSQLFiles)

Deprecated, for removal: This API element is subject to removal in a future version.

Execute any statements required before the deletion of the object

Overrides:

preDropObject in class DatabaseObjectDefinition

setSequenceCounterFieldName

public void setSequenceCounterFieldName(String sequenceCounterFieldName)

setSequenceNameFieldName

public void setSequenceNameFieldName(String sequenceNameFieldName)

setSequenceTableIndexes

public void setSequenceTableIndexes(List<IndexDefinition> sequenceTableIndexes)

setSequenceTableName

public void setSequenceTableName(String sequenceTableName)

setSequenceTableQualifier

public void setSequenceTableQualifier(String sequenceTableQualifier)

shouldDropTableDefinition

protected boolean shouldDropTableDefinition()

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