Module eclipselink

Package org.eclipse.persistence.tools.schemaframework

Class SequenceDefinition

java.lang.Object

org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

org.eclipse.persistence.tools.schemaframework.SequenceDefinition

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

SequenceObjectDefinition, TableSequenceDefinition

public abstract 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

Modifier and Type	Field	Description
protected Sequence	sequence	Deprecated, for removal: This API element is subject to removal in a future version. To be removed with no replacement.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SequenceDefinition(String name)
protected	SequenceDefinition(Sequence sequence)	Deprecated, for removal: This API element is subject to removal in a future version. Use SequenceDefinition(String) instead.

Method Summary

Modifier and Type	Method	Description
void	alter(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer writer)	Deprecated, for removal: This API element is subject to removal in a future version.
void	alterOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)	Deprecated, for removal: This API element is subject to removal in a future version.
TableDefinition	buildTableDefinition()	INTERNAL: Return a TableDefinition
abstract 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	createOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)	Deprecated, for removal: This API element is subject to removal in a future version.
int	getInitialValue()
int	getPreallocationSize()
boolean	isAlterSupported(org.eclipse.persistence.internal.sessions.AbstractSession session)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	isTableSequenceDefinition()	INTERNAL:
void	setInitialValue(int initialValue)
void	setPreallocationSize(int preallocationSize)

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

buildCreationWriter, buildDeletionWriter, buildVPDCreationFunctionWriter, buildVPDCreationPolicyWriter, buildVPDDeletionWriter, clone, createDatabaseSchema, createDatabaseSchemaOnDatabase, createObject, dropDatabaseSchema, dropDatabaseSchemaOnDatabase, dropFromDatabase, dropObject, getDatabaseSchema, getFullName, getName, getQualifier, hasDatabaseSchema, postCreateObject, preDropObject, setName, setQualifier, shouldCreateDatabaseSchema, shouldCreateVPDCalls, toString

Methods inherited from class java.lang.Object

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

Field Details

sequence

@Deprecated(forRemoval=true,
            since="4.0.9")
protected Sequence sequence

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

To be removed with no replacement.

Constructor Details

SequenceDefinition

protected SequenceDefinition(String name)

SequenceDefinition

@Deprecated(forRemoval=true,
            since="4.0.9")
protected SequenceDefinition(Sequence sequence)

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

Use SequenceDefinition(String) instead.

Method Details

checkIfExist

@Deprecated(forRemoval=true,
            since="4.0.9")
public abstract 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: Verify whether the sequence exists.

Throws:

DatabaseException

getInitialValue

public int getInitialValue()

getPreallocationSize

public int getPreallocationSize()

isAlterSupported

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

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

INTERNAL: Indicates whether alter is supported

isTableSequenceDefinition

public boolean isTableSequenceDefinition()

INTERNAL:

alterOnDatabase

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

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

INTERNAL: By default, does nothing.

Throws:

EclipseLinkException

alter

@Deprecated(forRemoval=true,
            since="4.0.9")
public void alter(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: Execute the SQL required to alter sequence. By default, does nothing.

Throws:

ValidationException

createOnDatabase

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

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

INTERNAL: Creates this sequence definition on the database. If it already exists, the method will attempt to alter it based on what the platform supports.

Overrides:

createOnDatabase in class DatabaseObjectDefinition

Throws:

EclipseLinkException

buildTableDefinition

public TableDefinition buildTableDefinition()

INTERNAL: Return a TableDefinition

setInitialValue

public void setInitialValue(int initialValue)

setPreallocationSize

public void setPreallocationSize(int preallocationSize)