Top Description Fields Constructors Methods
org.eclipse.persistence.tools.schemaframework

public abstract Class SequenceDefinition

extends DatabaseObjectDefinition
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.tools.schemaframework.SequenceObjectDefinition, org.eclipse.persistence.tools.schemaframework.TableSequenceDefinition
Imports
java.io.Writer, org.eclipse.persistence.exceptions.*, org.eclipse.persistence.internal.sessions.AbstractSession, org.eclipse.persistence.sequencing.Sequence

Purpose: Allow a generic way of creating sequences on the different platforms, and allow optional parameters to be specified.

Field Summary

Modifier and TypeField and Description
protected Sequence
Inherited from org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition:
namequalifier

Constructor Summary

AccessConstructor and Description
protected
protected

Method Summary

Modifier and TypeMethod and Description
public void
alter(AbstractSession session, Writer writer)

INTERNAL: Execute the SQL required to alter sequence.

public void
alterOnDatabase(AbstractSession session)

INTERNAL: By default does nothing.

public TableDefinition
buildTableDefinition()

INTERNAL: Return a TableDefinition

public abstract boolean
checkIfExist(AbstractSession session)

INTERAL: Verify whether the sequence exists.

public void
createOnDatabase(AbstractSession session)

Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.createOnDatabase.

INTERNAL: Creates this sequence definition on the database.
public boolean
isAlterSupported(AbstractSession session)

INTERNAL: Indicates whether alter is supported

public boolean
Inherited from org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition:
buildCreationWriterbuildDeletionWriterbuildVPDCreationFunctionWriterbuildVPDCreationPolicyWriterbuildVPDDeletionWriterclonecreateDatabaseSchemacreateDatabaseSchemaOnDatabasecreateObjectdropDatabaseSchemadropDatabaseSchemaOnDatabasedropFromDatabasedropObjectgetDatabaseSchemagetFieldTypeDefinitiongetFieldTypeDefinitiongetFullNamegetNamegetQualifierhasDatabaseSchemapostCreateObjectpreDropObjectsetNamesetQualifiershouldCreateDatabaseSchemashouldCreateVPDCallstoString

Field Detail

sequenceback to summary
protected Sequence sequence

Constructor Detail

SequenceDefinitionback to summary
protected SequenceDefinition(String name)
SequenceDefinitionback to summary
protected SequenceDefinition(Sequence sequence)

Method Detail

alterback to summary
public void alter(AbstractSession session, Writer writer) throws ValidationException

INTERNAL: Execute the SQL required to alter sequence. By default does nothing.

alterOnDatabaseback to summary
public void alterOnDatabase(AbstractSession session) throws EclipseLinkException

INTERNAL: By default does nothing.

buildTableDefinitionback to summary
public TableDefinition buildTableDefinition()

INTERNAL: Return a TableDefinition

checkIfExistback to summary
public abstract boolean checkIfExist(AbstractSession session) throws DatabaseException

INTERAL: Verify whether the sequence exists.

createOnDatabaseback to summary
public void createOnDatabase(AbstractSession session) throws EclipseLinkException

Overrides org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition.createOnDatabase.

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.

Annotations
@Override
isAlterSupportedback to summary
public boolean isAlterSupported(AbstractSession session)

INTERNAL: Indicates whether alter is supported

isTableSequenceDefinitionback to summary
public boolean isTableSequenceDefinition()

INTERNAL: