org.eclipse.persistence.tools.schemaframework

Class TableDefinition

java.lang.Object

org.eclipse.persistence.tools.schemaframework.DatabaseObjectDefinition

org.eclipse.persistence.tools.schemaframework.TableDefinition

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

TypeTableDefinition

public class TableDefinition
extends DatabaseObjectDefinition

Purpose: Allow a generic way of creating tables on the different platforms.

See Also:

Serialized Form

Field Summary

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

name, qualifier

Constructor Summary

Constructors

Constructor and Description
TableDefinition()

Method Summary

Methods

Modifier and Type	Method and Description
void	addField(FieldDefinition field) PUBLIC: Add the field to the table.
void	addField(String fieldName, Class type) PUBLIC: Add the field to the table, default sizes are used.
void	addField(String fieldName, Class type, int fieldSize) PUBLIC: Add the field to the table.
void	addField(String fieldName, Class type, int fieldSize, int fieldSubSize) PUBLIC: Add the field to the table.
void	addField(String fieldName, String typeName) PUBLIC: Add the field to the type to a nested type.
void	addForeignKeyConstraint(ForeignKeyConstraint foreignKey) PUBLIC: Add a foreign key constraint to the table.
void	addForeignKeyConstraint(String name, String sourceField, String targetField, String targetTable) PUBLIC: Add a foreign key constraint to the table.
void	addIdentityField(String fieldName, Class type) PUBLIC: Add the field to the table, default sizes are used.
void	addIdentityField(String fieldName, Class type, int fieldSize) PUBLIC: Add the field to the table, default sizes are used.
void	addPrimaryKeyField(String fieldName, Class type) PUBLIC: Add the field to the table, default sizes are used.
void	addPrimaryKeyField(String fieldName, Class type, int fieldSize) PUBLIC: Add the field to the table, default sizes are used.
void	addUniqueKeyConstraint(String name, String sourceField) PUBLIC: Add a unique key constraint to the table.
void	addUniqueKeyConstraint(String name, String[] sourceFields) PUBLIC: Add a unique key constraint to the table.
void	addUniqueKeyConstraint(UniqueKeyConstraint uniqueKey) PUBLIC: Add a unique key constraint to the table.
Writer	buildConstraintCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, ForeignKeyConstraint foreignKey, Writer writer) INTERNAL: Return the alter table statement to add the constraints.
Writer	buildConstraintDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, ForeignKeyConstraint foreignKey, Writer writer) INTERNAL: Return the alter table statement to drop the constraints.
Writer	buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer writer) INTERNAL: Return the create table statement.
Writer	buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer writer) INTERNAL: Return the drop table statement.
Writer	buildIndexCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, String key, List<String> columnNames, Writer writer) INTERNAL: Return the index creation statement.
Writer	buildIndexDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, String key, Writer writer) INTERNAL: Return the index drop statement.
Writer	buildUniqueConstraintCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, UniqueKeyConstraint uniqueKey, Writer writer) INTERNAL: Return the alter table statement to add the constraints.
Writer	buildUniqueConstraintDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session, UniqueKeyConstraint uniqueKey, Writer writer) INTERNAL: Return the alter table statement to drop the constraints.
Object	clone() PUBLIC: Performs a deep copy of this table definition.
void	createConstraints(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer schemaWriter) INTERNAL: Execute the SQL alter table constraint creation string.
void	createConstraintsOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Execute the SQL alter table constraint creation string.
void	createIndexOnPrimaryKey(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer schemaWriter) INTERNAL: Write the SQL create index string to create index on primary key if passed a writer, else delegate to a method that executes the string on the database.
void	createIndexOnPrimaryKeyOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Execute the SQL create index statement to create index on the primary key.
void	createIndicesOnUniqueKeys(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer schemaWriter) INTERNAL: Write the SQL create index string if passed a writer, else delegate to a method that executes the string on the database.
void	createIndicesOnUniqueKeysOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Execute the SQL create index statement to create index on the unique keys.
void	createOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Execute the DDL to create this table.
String	deletionStringFor(org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor accessor) INTERNAL: Return the delete SQL string.
void	dropConstraints(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer schemaWriter) INTERNAL: Execute the SQL alter table constraint creation string.
void	dropConstraintsOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Execute the SQL alter table constraint creation string.
void	dropFromDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Execute the DDL to drop the table.
void	dropIndexOnPrimaryKey(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer schemaWriter) INTERNAL: Write the SQL drop index string to drop index on PK if passed a writer, else delegate to a method that executes the string on the database.
void	dropIndexOnPrimaryKeyOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Execute the SQL drop index string to drop the index on the PK. Exceptions are caught and masked (even if index doesn't exist).
void	dropIndicesOnUniqueKeys(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer schemaWriter) INTERNAL: Execute the SQL drop index string to drop indices. Exceptions are caught and masked so that all the indices are dropped (even if they don't exist).
void	dropIndicesOnUniqueKeysOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Execute the SQL drop index string on the database. Exceptions are caught and masked so that all the indices are dropped (even if they don't exist).
void	dropObject(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer schemaWriter, boolean createSQLFiles) INTERNAL: Execute the DDL to drop the table.
String	getCreationPrefix() INTERNAL: Return the beginning of the sql create statement - the part before the name.
String	getCreationSuffix() INTERNAL: Return the end of the sql create statement - the part after the field list.
Vector<FieldDefinition>	getFields() PUBLIC:
Vector<ForeignKeyConstraint>	getForeignKeys() PUBLIC: Returns the ForeignKeyConstraint list.
Vector<String>	getPrimaryKeyFieldNames() PUBLIC:
Vector<UniqueKeyConstraint>	getUniqueKeys() PUBLIC:
void	postCreateObject(org.eclipse.persistence.internal.sessions.AbstractSession session, Writer createSchemaWriter, boolean createSQLFiles) Execute any statements required after the creation of the object
void	setCreateSQLFiles(boolean genFlag) PUBLIC:
void	setCreationPrefix(String creationPrefix) INTERNAL: Set the beginning of the sql create statement - the part before the name.
void	setCreationSuffix(String creationSuffix) INTERNAL: Set the end of the sql create statement - the part after the field list.
void	setFields(Vector<FieldDefinition> fields) PUBLIC:
void	setForeignKeys(Vector<ForeignKeyConstraint> foreignKeys) PUBLIC: Set the ForeignKeyConstraint list.
void	setUniqueKeys(Vector<UniqueKeyConstraint> uniqueKeys) PUBLIC:

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

createObject, getFullName, getName, getQualifier, setName, setQualifier, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TableDefinition

public TableDefinition()

Method Detail

addField

public void addField(String fieldName,
            Class type)

PUBLIC: Add the field to the table, default sizes are used.

Parameters:

type - is the Java class type corresponding to the database type.

addField

public void addField(String fieldName,
            Class type,
            int fieldSize)

PUBLIC: Add the field to the table.

Parameters:

type - is the Java class type corresponding to the database type.

addField

public void addField(String fieldName,
            Class type,
            int fieldSize,
            int fieldSubSize)

PUBLIC: Add the field to the table.

Parameters:

type - is the Java class type corresponding to the database type.

addField

public void addField(String fieldName,
            String typeName)

PUBLIC: Add the field to the type to a nested type.

Parameters:

typeName - is the name of the nested type.

addField

public void addField(FieldDefinition field)

PUBLIC: Add the field to the table.

addForeignKeyConstraint

public void addForeignKeyConstraint(String name,
                           String sourceField,
                           String targetField,
                           String targetTable)

PUBLIC: Add a foreign key constraint to the table. If there is a same name foreign key constraint already, nothing will happen.

addUniqueKeyConstraint

public void addUniqueKeyConstraint(String name,
                          String sourceField)

PUBLIC: Add a unique key constraint to the table.

addUniqueKeyConstraint

public void addUniqueKeyConstraint(String name,
                          String[] sourceFields)

PUBLIC: Add a unique key constraint to the table.

addForeignKeyConstraint

public void addForeignKeyConstraint(ForeignKeyConstraint foreignKey)

PUBLIC: Add a foreign key constraint to the table. If there is a same name foreign key constraint already, nothing will happen.

addUniqueKeyConstraint

public void addUniqueKeyConstraint(UniqueKeyConstraint uniqueKey)

PUBLIC: Add a unique key constraint to the table.

addIdentityField

public void addIdentityField(String fieldName,
                    Class type)

PUBLIC: Add the field to the table, default sizes are used. Identity fields are used on Sybase for native sequencing, The field must be of number type and cannot have a subsize.

Parameters:

type - is the Java class type corresponding to the database type.

addIdentityField

public void addIdentityField(String fieldName,
                    Class type,
                    int fieldSize)

PUBLIC: Add the field to the table, default sizes are used. Identity fields are used on Sybase for native sequencing, The field must be of number type and cannot have a subsize.

Parameters:

type - is the Java class type corresponding to the database type.

addPrimaryKeyField

public void addPrimaryKeyField(String fieldName,
                      Class type)

PUBLIC: Add the field to the table, default sizes are used. This field is set as part of the primary key.

Parameters:

type - is the Java class type corresponding to the database type.

addPrimaryKeyField

public void addPrimaryKeyField(String fieldName,
                      Class type,
                      int fieldSize)

PUBLIC: Add the field to the table, default sizes are used. This field is set as part of the primary key.

Parameters:

type - is the Java class type corresponding to the database type.

buildConstraintCreationWriter

public Writer buildConstraintCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                   ForeignKeyConstraint foreignKey,
                                   Writer writer)
                                     throws ValidationException

INTERNAL: Return the alter table statement to add the constraints. This is done separately from the create because of dependencies.

Throws:

ValidationException

buildConstraintDeletionWriter

public Writer buildConstraintDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                   ForeignKeyConstraint foreignKey,
                                   Writer writer)
                                     throws ValidationException

INTERNAL: Return the alter table statement to drop the constraints. This is done separately to allow constraints to be dropped before the tables.

Throws:

ValidationException

buildUniqueConstraintCreationWriter

public Writer buildUniqueConstraintCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                         UniqueKeyConstraint uniqueKey,
                                         Writer writer)
                                           throws ValidationException

INTERNAL: Return the alter table statement to add the constraints. This is done separately from the create because of dependencies.

Throws:

ValidationException

buildUniqueConstraintDeletionWriter

public Writer buildUniqueConstraintDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                         UniqueKeyConstraint uniqueKey,
                                         Writer writer)
                                           throws ValidationException

INTERNAL: Return the alter table statement to drop the constraints. This is done separately to allow constraints to be dropped before the tables.

Throws:

ValidationException

buildIndexCreationWriter

public Writer buildIndexCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                              String key,
                              List<String> columnNames,
                              Writer writer)
                                throws ValidationException

INTERNAL: Return the index creation statement.

Throws:

ValidationException

buildIndexDeletionWriter

public Writer buildIndexDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                              String key,
                              Writer writer)
                                throws ValidationException

INTERNAL: Return the index drop statement.

Throws:

ValidationException

getCreationPrefix

public String getCreationPrefix()

INTERNAL: Return the beginning of the sql create statement - the part before the name. Unless temp table is created should be "CREATE TABLE "

setCreationPrefix

public void setCreationPrefix(String creationPrefix)

INTERNAL: Set the beginning of the sql create statement - the part before the name. Use to create temp. table.

getCreationSuffix

public String getCreationSuffix()

INTERNAL: Return the end of the sql create statement - the part after the field list. Unless temp table is created should be empty.

setCreationSuffix

public void setCreationSuffix(String creationSuffix)

INTERNAL: Set the end of the sql create statement - the part after the field list. Use to create temp table.

buildCreationWriter

public Writer buildCreationWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                         Writer writer)
                           throws ValidationException

INTERNAL: Return the create table statement.

Specified by:

buildCreationWriter in class DatabaseObjectDefinition

Throws:

ValidationException

buildDeletionWriter

public Writer buildDeletionWriter(org.eclipse.persistence.internal.sessions.AbstractSession session,
                         Writer writer)
                           throws ValidationException

INTERNAL: Return the drop table statement.

Specified by:

buildDeletionWriter in class DatabaseObjectDefinition

Throws:

ValidationException

clone

public Object clone()

PUBLIC: Performs a deep copy of this table definition.

Overrides:

clone in class DatabaseObjectDefinition

createConstraints

public void createConstraints(org.eclipse.persistence.internal.sessions.AbstractSession session,
                     Writer schemaWriter)
                       throws EclipseLinkException

INTERNAL: Execute the SQL alter table constraint creation string.

Throws:

EclipseLinkException

createConstraintsOnDatabase

public void createConstraintsOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
                                 throws EclipseLinkException

INTERNAL: Execute the SQL alter table constraint creation string.

Throws:

EclipseLinkException

createIndexOnPrimaryKey

public void createIndexOnPrimaryKey(org.eclipse.persistence.internal.sessions.AbstractSession session,
                           Writer schemaWriter)

INTERNAL:
Write the SQL create index string to create index on primary key if passed a writer, else delegate to a method that executes the string on the database.

Throws:

ValidationException - wraps any IOException from the writer

See Also:

createIndexOnPrimaryKeyOnDatabase(AbstractSession)

createIndicesOnUniqueKeys

public void createIndicesOnUniqueKeys(org.eclipse.persistence.internal.sessions.AbstractSession session,
                             Writer schemaWriter)
                               throws EclipseLinkException

INTERNAL:
Write the SQL create index string if passed a writer, else delegate to a method that executes the string on the database.

Throws:

ValidationException - wraps any IOException from the writer

EclipseLinkException

See Also:

createIndicesOnUniqueKeysOnDatabase(AbstractSession)

createIndexOnPrimaryKeyOnDatabase

public void createIndexOnPrimaryKeyOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL:
Execute the SQL create index statement to create index on the primary key.

createIndicesOnUniqueKeysOnDatabase

public void createIndicesOnUniqueKeysOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL:
Execute the SQL create index statement to create index on the unique keys.

createOnDatabase

public void createOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
                      throws EclipseLinkException

INTERNAL: Execute the DDL to create this table.

Overrides:

createOnDatabase in class DatabaseObjectDefinition

Throws:

EclipseLinkException

deletionStringFor

public String deletionStringFor(org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor accessor)

INTERNAL: Return the delete SQL string.

dropConstraints

public void dropConstraints(org.eclipse.persistence.internal.sessions.AbstractSession session,
                   Writer schemaWriter)
                     throws EclipseLinkException

INTERNAL: Execute the SQL alter table constraint creation string.

Throws:

EclipseLinkException

dropConstraintsOnDatabase

public void dropConstraintsOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
                               throws EclipseLinkException

INTERNAL: Execute the SQL alter table constraint creation string. Exceptions are caught and masked so that all the foreign keys are dropped (even if they don't exist).

Throws:

EclipseLinkException

dropFromDatabase

public void dropFromDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
                      throws EclipseLinkException

INTERNAL: Execute the DDL to drop the table.

Overrides:

dropFromDatabase in class DatabaseObjectDefinition

Throws:

EclipseLinkException

dropIndexOnPrimaryKey

public void dropIndexOnPrimaryKey(org.eclipse.persistence.internal.sessions.AbstractSession session,
                         Writer schemaWriter)
                           throws EclipseLinkException

INTERNAL:
Write the SQL drop index string to drop index on PK if passed a writer, else delegate to a method that executes the string on the database.

Throws:

ValidationException - wraps any IOException from the writer

EclipseLinkException

See Also:

dropIndexOnPrimaryKeyOnDatabase(AbstractSession)

dropIndicesOnUniqueKeys

public void dropIndicesOnUniqueKeys(org.eclipse.persistence.internal.sessions.AbstractSession session,
                           Writer schemaWriter)
                             throws EclipseLinkException

INTERNAL:
Execute the SQL drop index string to drop indices.
Exceptions are caught and masked so that all the indices are dropped (even if they don't exist).

Throws:

EclipseLinkException

dropIndexOnPrimaryKeyOnDatabase

public void dropIndexOnPrimaryKeyOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
                                     throws EclipseLinkException

INTERNAL:
Execute the SQL drop index string to drop the index on the PK.
Exceptions are caught and masked (even if index doesn't exist).

Throws:

EclipseLinkException

dropIndicesOnUniqueKeysOnDatabase

public void dropIndicesOnUniqueKeysOnDatabase(org.eclipse.persistence.internal.sessions.AbstractSession session)
                                       throws EclipseLinkException

INTERNAL:
Execute the SQL drop index string on the database.
Exceptions are caught and masked so that all the indices are dropped (even if they don't exist).

Throws:

EclipseLinkException

dropObject

public void dropObject(org.eclipse.persistence.internal.sessions.AbstractSession session,
              Writer schemaWriter,
              boolean createSQLFiles)
                throws EclipseLinkException

INTERNAL: Execute the DDL to drop the table. Either directly from the database of write out the statement to a file.

Overrides:

dropObject in class DatabaseObjectDefinition

Throws:

EclipseLinkException

getFields

public Vector<FieldDefinition> getFields()

PUBLIC:

getForeignKeys

public Vector<ForeignKeyConstraint> getForeignKeys()

PUBLIC: Returns the ForeignKeyConstraint list.

getUniqueKeys

public Vector<UniqueKeyConstraint> getUniqueKeys()

PUBLIC:

getPrimaryKeyFieldNames

public Vector<String> getPrimaryKeyFieldNames()

PUBLIC:

postCreateObject

public void postCreateObject(org.eclipse.persistence.internal.sessions.AbstractSession session,
                    Writer createSchemaWriter,
                    boolean createSQLFiles)

Execute any statements required after the creation of the object

Overrides:

postCreateObject in class DatabaseObjectDefinition

Parameters:

session -

createSchemaWriter -

setFields

public void setFields(Vector<FieldDefinition> fields)

PUBLIC:

setForeignKeys

public void setForeignKeys(Vector<ForeignKeyConstraint> foreignKeys)

PUBLIC: Set the ForeignKeyConstraint list. If the list contains the same name foreign key constraints, only the first one of that name will be added.

setUniqueKeys

public void setUniqueKeys(Vector<UniqueKeyConstraint> uniqueKeys)

PUBLIC:

setCreateSQLFiles

public void setCreateSQLFiles(boolean genFlag)

PUBLIC: