oracle.toplink.tools.schemaframework
Class SequenceDefinition

java.lang.Object
oracle.toplink.tools.schemaframework.DatabaseObjectDefinition
oracle.toplink.tools.schemaframework.SequenceDefinition

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

Direct Known Subclasses:

OracleSequenceDefinition

public 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 inherited from class oracle.toplink.tools.schemaframework.DatabaseObjectDefinition

name, qualifier

Constructor Summary

SequenceDefinition(java.lang.String name)

Method Summary

void	alter(oracle.toplink.publicinterface.Session session, java.io.Writer writer) INTERNAL: Execute the SQL required to alter sequence.
void	alterOnDatabase(oracle.toplink.publicinterface.Session session) INTERNAL: Execute the SQL required to alter sequence.
java.io.Writer	buildCreationWriter(oracle.toplink.publicinterface.Session session, java.io.Writer writer) INTERNAL: Return the SQL required to insert the sequence row into the sequence table.
java.io.Writer	buildDeletionWriter(oracle.toplink.publicinterface.Session session, java.io.Writer writer) INTERNAL: Return the SQL to delete the row from the sequence table.
boolean	checkIfExist(oracle.toplink.publicinterface.Session session) INTERAL: Execute the SQL required to insert the sequence row into the sequence table.
void	createOnDatabase(oracle.toplink.publicinterface.Session session) INTERNAL: Execute the SQL required to insert the sequence row into the sequence table.
boolean	isAlterSupported() INTERNAL: Indicates whether alter is supported

Methods inherited from class oracle.toplink.tools.schemaframework.DatabaseObjectDefinition

createObject, dropFromDatabase, dropObject, getFullName, getName, getQualifier, setName, setQualifier, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SequenceDefinition

public SequenceDefinition(java.lang.String name)

Method Detail

buildCreationWriter

public java.io.Writer buildCreationWriter(oracle.toplink.publicinterface.Session 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(oracle.toplink.publicinterface.Session 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(oracle.toplink.publicinterface.Session session)
                     throws DatabaseException

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

Throws:

DatabaseException

createOnDatabase

public void createOnDatabase(oracle.toplink.publicinterface.Session session)
                      throws TopLinkException

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

Overrides:

createOnDatabase in class DatabaseObjectDefinition

Throws:

TopLinkException

isAlterSupported

public boolean isAlterSupported()

INTERNAL: Indicates whether alter is supported

alterOnDatabase

public void alterOnDatabase(oracle.toplink.publicinterface.Session session)
                     throws TopLinkException

INTERNAL: Execute the SQL required to alter sequence. Assume that the sequence table exists. Does nothing because sequencing increment is not stored in sequencing table.

Throws:

TopLinkException

alter

public void alter(oracle.toplink.publicinterface.Session session,
                  java.io.Writer writer)
           throws ValidationException

INTERNAL: Execute the SQL required to alter sequence. Assume that the sequence table exists. Does nothing because sequencing increment is not stored in sequencing table.

Throws:

ValidationException