oracle.toplink.essentials.tools.schemaframework

Class OracleSequenceDefinition

java.lang.Object

oracle.toplink.essentials.tools.schemaframework.DatabaseObjectDefinition

oracle.toplink.essentials.tools.schemaframework.SequenceDefinition

oracle.toplink.essentials.tools.schemaframework.OracleSequenceDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

TimesTenSequenceDefinition

public class OracleSequenceDefinition
extends SequenceDefinition

Purpose: Support Oracle native sequence creation. Oracle has custom support for sequences.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	increment The increment can be used to support pre-allocation.
protected int	start The start is the first sequence value that will be available for TopLink to use.

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

name, qualifier

Constructor Summary

Constructors

Constructor and Description
OracleSequenceDefinition(NativeSequence sequence)
OracleSequenceDefinition(java.lang.String name)
OracleSequenceDefinition(java.lang.String name, int preallocationSize)
OracleSequenceDefinition(java.lang.String name, int preallocationSize, int start)

Method Summary

Modifier and Type	Method and Description
void	alterIncrement(AbstractSession session, java.io.Writer schemaWriter) INTERNAL: Execute the SQL required to alter sequence increment.
void	alterOnDatabase(AbstractSession session) INTERNAL: Execute the SQL required to alter sequence increment.
java.io.Writer	buildAlterIncrementWriter(AbstractSession session, java.io.Writer writer) INTERNAL: Return the SQL required to alter INCREMENT BY
java.io.Writer	buildCreationWriter(AbstractSession session, java.io.Writer writer) INTERNAL: Return the SQL required to create the Oracle sequence object.
java.io.Writer	buildDeletionWriter(AbstractSession session, java.io.Writer writer) INTERNAL: Return the SQL required to drop the Oracle sequence object.
boolean	checkIfExist(AbstractSession session) INTERNAL: Check if the sequence object already exists, in which case dont create it.
int	getIncrement() The increment can be used to support pre-allocation.
int	getStart() The start used as a starting value for sequence
boolean	isAlterSupported() INTERNAL: Indicates whether alterIncrement is supported
void	setIncrement(int increment) The increment can be used to support pre-allocation.
void	setStart(int start) The start used as a starting value for sequence
void	setStartAndIncrement(int value) The start used as a starting value for sequence

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

alter, buildTableDefinition, createOnDatabase

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

increment

protected int increment

The increment can be used to support pre-allocation.

start

protected int start

The start is the first sequence value that will be available for TopLink to use.

Constructor Detail

OracleSequenceDefinition

public OracleSequenceDefinition(java.lang.String name,
                                int preallocationSize)

OracleSequenceDefinition

public OracleSequenceDefinition(java.lang.String name,
                                int preallocationSize,
                                int start)

OracleSequenceDefinition

public OracleSequenceDefinition(java.lang.String name)

OracleSequenceDefinition

public OracleSequenceDefinition(NativeSequence sequence)

Method Detail

buildCreationWriter

public java.io.Writer buildCreationWriter(AbstractSession session,
                                          java.io.Writer writer)

INTERNAL: Return the SQL required to create the Oracle sequence object.

Specified by:

buildCreationWriter in class DatabaseObjectDefinition

buildDeletionWriter

public java.io.Writer buildDeletionWriter(AbstractSession session,
                                          java.io.Writer writer)

INTERNAL: Return the SQL required to drop the Oracle sequence object.

Specified by:

buildDeletionWriter in class DatabaseObjectDefinition

buildAlterIncrementWriter

public java.io.Writer buildAlterIncrementWriter(AbstractSession session,
                                                java.io.Writer writer)

INTERNAL: Return the SQL required to alter INCREMENT BY

checkIfExist

public boolean checkIfExist(AbstractSession session)
                     throws DatabaseException

INTERNAL: Check if the sequence object already exists, in which case dont create it.

Specified by:

checkIfExist in class SequenceDefinition

Throws:

DatabaseException

getIncrement

public int getIncrement()

The increment can be used to support pre-allocation.

setIncrement

public void setIncrement(int increment)

The increment can be used to support pre-allocation.

getStart

public int getStart()

The start used as a starting value for sequence

setStart

public void setStart(int start)

The start used as a starting value for sequence

setStartAndIncrement

public void setStartAndIncrement(int value)

The start used as a starting value for sequence

isAlterSupported

public boolean isAlterSupported()

INTERNAL: Indicates whether alterIncrement is supported

Overrides:

isAlterSupported in class SequenceDefinition

alterOnDatabase

public void alterOnDatabase(AbstractSession session)
                     throws TopLinkException

INTERNAL: Execute the SQL required to alter sequence increment. Assume that the sequence exists.

Overrides:

alterOnDatabase in class SequenceDefinition

Throws:

TopLinkException

alterIncrement

public void alterIncrement(AbstractSession session,
                           java.io.Writer schemaWriter)
                    throws ValidationException

INTERNAL: Execute the SQL required to alter sequence increment. Assume that the sequence exists.

Throws:

ValidationException