EclipseLink 1.2.0, build 'v20091016-r5565' API Reference

org.eclipse.persistence.tools.schemaframework
Class SequenceObjectDefinition

java.lang.Object
  extended by org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
      extended by org.eclipse.persistence.tools.schemaframework.SequenceDefinition
          extended by org.eclipse.persistence.tools.schemaframework.SequenceObjectDefinition
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class SequenceObjectDefinition
extends SequenceDefinition

Purpose: Sequence definition Native Sequence object.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.eclipse.persistence.tools.schemaframework.SequenceDefinition
sequence
 
Fields inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
name, qualifier
 
Constructor Summary
SequenceObjectDefinition(Sequence sequence)
          INTERNAL: Should be a sequence defining sequence object in the db: either NativeSequence with shouldAcquireValueAfterInsert() returning false; or DefaultSequence (only if case platform.getDefaultSequence() is a NativeSequence with shouldAcquireValueAfterInsert() returning false).
 
Method Summary
 void alterIncrement(org.eclipse.persistence.internal.sessions.AbstractSession session, java.io.Writer schemaWriter)
          INTERNAL: Execute the SQL required to alter sequence increment.
 void alterOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
          INTERNAL: Execute the SQL required to alter sequence increment.
 java.io.Writer buildAlterIncrementWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, java.io.Writer writer)
          INTERNAL: Return the SQL required to alter INCREMENT BY
 java.io.Writer buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, java.io.Writer writer)
          INTERNAL: Return the SQL required to create the Oracle sequence object.
 java.io.Writer buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, java.io.Writer writer)
          INTERNAL: Return the SQL required to drop the Oracle sequence object.
 boolean checkIfExist(org.eclipse.persistence.internal.sessions.AbstractSession session)
          INTERNAL: Check if the sequence object already exists, in which case dont create it.
 java.lang.String getFullName()
          INTERNAL: Most major databases support a creator name scope.
 boolean isAlterSupported(org.eclipse.persistence.internal.sessions.AbstractSession session)
          INTERNAL: Indicates whether alterIncrement is supported
 
Methods inherited from class org.eclipse.persistence.tools.schemaframework.SequenceDefinition
alter, buildTableDefinition, createOnDatabase
 
Methods inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
clone, createObject, dropFromDatabase, dropObject, getName, getQualifier, setName, setQualifier, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SequenceObjectDefinition

public SequenceObjectDefinition(Sequence sequence)
INTERNAL: Should be a sequence defining sequence object in the db: either NativeSequence with shouldAcquireValueAfterInsert() returning false; or DefaultSequence (only if case platform.getDefaultSequence() is a NativeSequence with shouldAcquireValueAfterInsert() returning false).

Method Detail

buildCreationWriter

public java.io.Writer buildCreationWriter(org.eclipse.persistence.internal.sessions.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(org.eclipse.persistence.internal.sessions.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(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                                java.io.Writer writer)
INTERNAL: Return the SQL required to alter INCREMENT BY


checkIfExist

public boolean checkIfExist(org.eclipse.persistence.internal.sessions.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

isAlterSupported

public boolean isAlterSupported(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: Indicates whether alterIncrement is supported

Overrides:
isAlterSupported in class SequenceDefinition

alterOnDatabase

public void alterOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
                     throws EclipseLinkException
INTERNAL: Execute the SQL required to alter sequence increment. Assume that the sequence exists.

Overrides:
alterOnDatabase in class SequenceDefinition
Throws:
EclipseLinkException

alterIncrement

public void alterIncrement(org.eclipse.persistence.internal.sessions.AbstractSession session,
                           java.io.Writer schemaWriter)
                    throws ValidationException
INTERNAL: Execute the SQL required to alter sequence increment. Assume that the sequence exists.

Throws:
ValidationException

getFullName

public java.lang.String getFullName()
INTERNAL: Most major databases support a creator name scope. This means whenever the database object is referenced, it must be qualified.

Overrides:
getFullName in class DatabaseObjectDefinition

EclipseLink 1.2.0, build 'v20091016-r5565' API Reference