|
EclipseLink 2.5.0, build 'v20130507-3faac2b' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition
org.eclipse.persistence.tools.schemaframework.SequenceDefinition
org.eclipse.persistence.tools.schemaframework.TableSequenceDefinition
public class TableSequenceDefinition
Purpose: Allow a generic way of creating sequences on the different platforms, and allow optional parameters to be specified.
| Field Summary | |
|---|---|
protected boolean |
deleteSchema
|
protected TableDefinition |
tableDefinition
|
| 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 | |
|---|---|
TableSequenceDefinition(Sequence sequence,
boolean deleteSchema)
INTERNAL: Should be a sequence defining table sequence in the db: either TableSequence DefaultSequence (only if case platform.getDefaultSequence() is a TableSequence). |
|
| Method Summary | |
|---|---|
java.io.Writer |
buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
INTERNAL: Return the SQL required to insert the sequence row into the sequence table. |
java.io.Writer |
buildDeletionWriter(org.eclipse.persistence.internal.sessions.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(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERAL: Execute the SQL required to insert the sequence row into the sequence table. |
void |
dropDatabaseSchema(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
INTERNAL: Execute the DDL to drop the database schema for this object. |
void |
dropDatabaseSchemaOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL: Execute the DDL to drop the database schema for this object. |
java.lang.String |
getDatabaseSchema()
PUBLIC: Return the schema associated with this table sequence. |
java.lang.String |
getSequenceCounterFieldName()
PUBLIC: |
java.lang.String |
getSequenceNameFieldName()
PUBLIC: |
org.eclipse.persistence.internal.helper.DatabaseTable |
getSequenceTable()
Return the database table for the sequence. |
java.util.List<IndexDefinition> |
getSequenceTableIndexes()
PUBLIC: |
java.lang.String |
getSequenceTableName()
PUBLIC: |
java.lang.String |
getSequenceTableQualifier()
PUBLIC: |
protected TableSequence |
getTableSequence()
|
boolean |
isTableSequenceDefinition()
INTERNAL: |
void |
preDropObject(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer dropSchemaWriter,
boolean createSQLFiles)
Execute any statements required before the deletion of the object |
protected boolean |
shouldDropTableDefinition()
INTERNAL: Returns true if the table definition should be dropped during buildDeletionWriter. |
| Methods inherited from class org.eclipse.persistence.tools.schemaframework.SequenceDefinition |
|---|
alter, alterOnDatabase, createOnDatabase, isAlterSupported |
| Methods inherited from class org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition |
|---|
buildVPDCreationFunctionWriter, buildVPDCreationPolicyWriter, buildVPDDeletionWriter, clone, createDatabaseSchema, createDatabaseSchemaOnDatabase, createObject, dropFromDatabase, dropObject, getFullName, getName, getQualifier, hasDatabaseSchema, postCreateObject, setName, setQualifier, shouldCreateDatabaseSchema, shouldCreateVPDCalls, toString |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected TableDefinition tableDefinition
protected boolean deleteSchema
| Constructor Detail |
|---|
public TableSequenceDefinition(Sequence sequence,
boolean deleteSchema)
| Method Detail |
|---|
public java.io.Writer buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
throws ValidationException
buildCreationWriter in class DatabaseObjectDefinitionValidationException
public java.io.Writer buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
throws ValidationException
buildDeletionWriter in class DatabaseObjectDefinitionValidationException
public boolean checkIfExist(org.eclipse.persistence.internal.sessions.AbstractSession session)
throws DatabaseException
checkIfExist in class SequenceDefinitionDatabaseException
public void dropDatabaseSchema(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer writer)
throws EclipseLinkException
dropDatabaseSchema in class DatabaseObjectDefinitionEclipseLinkExceptionTableDefinition
public void dropDatabaseSchemaOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
throws EclipseLinkException
dropDatabaseSchemaOnDatabase in class DatabaseObjectDefinitionEclipseLinkExceptionTableDefinitionpublic java.lang.String getDatabaseSchema()
getDatabaseSchema in class DatabaseObjectDefinitionTableDefinitionpublic java.lang.String getSequenceCounterFieldName()
public java.lang.String getSequenceNameFieldName()
public org.eclipse.persistence.internal.helper.DatabaseTable getSequenceTable()
public java.util.List<IndexDefinition> getSequenceTableIndexes()
public java.lang.String getSequenceTableName()
public java.lang.String getSequenceTableQualifier()
public TableDefinition buildTableDefinition()
buildTableDefinition in class SequenceDefinitionprotected TableSequence getTableSequence()
public boolean isTableSequenceDefinition()
isTableSequenceDefinition in class SequenceDefinition
public void preDropObject(org.eclipse.persistence.internal.sessions.AbstractSession session,
java.io.Writer dropSchemaWriter,
boolean createSQLFiles)
preDropObject in class DatabaseObjectDefinitionsession - dropSchemaWriter - protected boolean shouldDropTableDefinition()
|
EclipseLink 2.5.0, build 'v20130507-3faac2b' API Reference | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||