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:

java.io.Serializable, java.lang.Cloneable

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 inherited from class org.eclipse.persistence.tools.schemaframework.SequenceDefinition

sequence

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

name, qualifier

Constructor Summary

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

Method Summary

java.io.Writer	buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, java.io.Writer writer) INTERNAL: Return the SQL required to insert the sequence row into the sequence table.
java.io.Writer	buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, java.io.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(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERAL: Execute the SQL required to insert the sequence row into the sequence table.
java.lang.String	getSequenceCounterFieldName() PUBLIC:
java.lang.String	getSequenceNameFieldName() PUBLIC:
java.lang.String	getSequenceTableName() PUBLIC:
protected TableSequence	getTableSequence()

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

alter, alterOnDatabase, createOnDatabase, isAlterSupported

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

clone, createObject, dropFromDatabase, dropObject, getFullName, getName, getQualifier, postCreateObject, preDropObject, setName, setQualifier, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TableSequenceDefinition

public TableSequenceDefinition(Sequence sequence)

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

public java.io.Writer buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                          java.io.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 java.io.Writer buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                          java.io.Writer writer)
                                   throws ValidationException

INTERNAL: Return the SQL to delete the row from the sequence table.

Specified by:

buildDeletionWriter in class DatabaseObjectDefinition

Throws:

ValidationException

checkIfExist

public boolean checkIfExist(org.eclipse.persistence.internal.sessions.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

getSequenceTableName

public java.lang.String getSequenceTableName()

PUBLIC:

getSequenceCounterFieldName

public java.lang.String getSequenceCounterFieldName()

PUBLIC:

getSequenceNameFieldName

public java.lang.String getSequenceNameFieldName()

PUBLIC:

buildTableDefinition

public TableDefinition buildTableDefinition()

INTERNAL: Return a TableDefinition specifying sequence table.

Overrides:

buildTableDefinition in class SequenceDefinition

getTableSequence

protected TableSequence getTableSequence()