oracle.toplink.essentials.tools.schemaframework

Class TableSequenceDefinition

java.lang.Object

oracle.toplink.essentials.tools.schemaframework.DatabaseObjectDefinition

oracle.toplink.essentials.tools.schemaframework.SequenceDefinition

oracle.toplink.essentials.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

Modifier and Type	Field and Description
int	initialValue
java.lang.String	sequenceCounterFieldName Hold the name of the column in the sequence table which specifies the sequence numeric value
java.lang.String	sequenceNameFieldName Hold the name of the column in the sequence table which specifies the sequence name
java.lang.String	sequenceTableName Hold the name of the sequence table

Fields inherited from class oracle.toplink.essentials.tools.schemaframework.DatabaseObjectDefinition

name, qualifier

Constructor Summary

Constructors

Constructor and Description
TableSequenceDefinition(java.lang.String name, java.lang.String sequenceTableName, java.lang.String sequenceNameFieldName, java.lang.String sequenceCounterFieldName, int initialValue)
TableSequenceDefinition(java.lang.String name, TableSequence sequence)
TableSequenceDefinition(TableSequence sequence)

Method Summary

Modifier and Type	Method and Description
java.io.Writer	buildCreationWriter(AbstractSession session, java.io.Writer writer) INTERNAL: Return the SQL required to insert the sequence row into the sequence table.
java.io.Writer	buildDeletionWriter(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(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:
void	setInitialValue(int initialValue) PUBLIC:
void	setSequenceCounterFieldName(java.lang.String sequenceCounterFieldName) PUBLIC:
void	setSequenceNameFieldName(java.lang.String sequenceNameFieldName) PUBLIC:
void	setSequenceTableName(java.lang.String sequenceTableName) PUBLIC:

Methods inherited from class oracle.toplink.essentials.tools.schemaframework.SequenceDefinition

alter, alterOnDatabase, createOnDatabase, isAlterSupported

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

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

Methods inherited from class java.lang.Object

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

Field Detail

sequenceTableName

public java.lang.String sequenceTableName

Hold the name of the sequence table

sequenceNameFieldName

public java.lang.String sequenceNameFieldName

Hold the name of the column in the sequence table which specifies the sequence name

sequenceCounterFieldName

public java.lang.String sequenceCounterFieldName

Hold the name of the column in the sequence table which specifies the sequence numeric value

initialValue

public int initialValue

Constructor Detail

TableSequenceDefinition

public TableSequenceDefinition(java.lang.String name,
                               java.lang.String sequenceTableName,
                               java.lang.String sequenceNameFieldName,
                               java.lang.String sequenceCounterFieldName,
                               int initialValue)

TableSequenceDefinition

public TableSequenceDefinition(TableSequence sequence)

TableSequenceDefinition

public TableSequenceDefinition(java.lang.String name,
                               TableSequence sequence)

Method Detail

buildCreationWriter

public java.io.Writer buildCreationWriter(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(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(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

setInitialValue

public void setInitialValue(int initialValue)

PUBLIC:

setSequenceTableName

public void setSequenceTableName(java.lang.String sequenceTableName)

PUBLIC:

getSequenceTableName

public java.lang.String getSequenceTableName()

PUBLIC:

setSequenceCounterFieldName

public void setSequenceCounterFieldName(java.lang.String sequenceCounterFieldName)

PUBLIC:

getSequenceCounterFieldName

public java.lang.String getSequenceCounterFieldName()

PUBLIC:

setSequenceNameFieldName

public void setSequenceNameFieldName(java.lang.String sequenceNameFieldName)

PUBLIC:

getSequenceNameFieldName

public java.lang.String getSequenceNameFieldName()

PUBLIC:

buildTableDefinition

public TableDefinition buildTableDefinition()

INTERNAL: Return a TableDefinition specifying sequence table.

Overrides:

buildTableDefinition in class SequenceDefinition