com.webobjects.eoaccess
Interface EOSchemaSynchronization

All Superinterfaces:

EOSchemaSynchronization

Deprecated. Deprecated in WebObjects 5.4. Replaced by com.webobjects.eoaccess.synchronization.EOSchemaSynchronization.

@Deprecated
public interface EOSchemaSynchronization
extends EOSchemaSynchronization

Since:

5.1

See Also:

EOSchemaSynchronization

Nested Class Summary

Nested classes/interfaces inherited from interface com.webobjects.eoaccess.synchronization.EOSchemaSynchronization

EOSchemaSynchronization.ColumnTypes

Field Summary

static String	AllowsNullKey Deprecated. Key for use in change dictionaries whose value of "YES" or "NO" is the setting in the database for whether a database column allows NULL values.
static String	ColumnNameKey Deprecated. Key for use in change dictionaries whose value is the column name in the database for an EOAttribute.
static String	ExternalNameKey Deprecated. Key for use in change dictionaries whose value is the external name (database table name) for an EOEntity.
static String	ExternalTypeKey Deprecated. Key for use in change dictionaries whose value is the external type (database type) for an EOAttribute.
static String	NameKey Deprecated. Key for use in change dictionaries whose value is the name in the database for a property.
static String	PrecisionKey Deprecated. Key for use in change dictionaries whose value is the precision value in the database for an EOAttribute.
static String	RelationshipsKey Deprecated. Key for use in change dictionaries whose value is a dictionary of relationships which have been modified since the last time the model and schema were synchronized.
static String	ScaleKey Deprecated. Key for use in change dictionaries whose value is the scale value in the database for an EOAttribute.
static String	SchemaSynchronizationForeignKeyConstraintsKey Deprecated. Options dictionary key; an associated value of "YES" determines that the EOSQLExpression should generate SQL to create foreign key constraints.
static String	SchemaSynchronizationPrimaryKeyConstraintsKey Deprecated. Options dictionary key; an associated value of "YES" determines that the EOSQLExpression should generate SQL to create primary key constraints.
static String	SchemaSynchronizationPrimaryKeySupportKey Deprecated. Options dictionary key; an associated value of "YES" determines that the EOSQLExpression should generate SQL to create primary key support.
static String	WidthKey Deprecated. Key for use in change dictionaries whose corresponding value is the width value in the database for an EOAttribute.

Method Summary

boolean	isColumnTypeEquivalentToColumnType(EOSchemaSynchronization.ColumnTypes candidate, EOSchemaSynchronization.ColumnTypes columnType, NSDictionary options) Deprecated. Returns true if the name, precision, width, and scale of candidate are identical to the name, precision, width, and scale of columnType, false otherwise.
String	phraseCastingColumnNamed(String columnName, EOSchemaSynchronization.ColumnTypes type, EOSchemaSynchronization.ColumnTypes castType, NSDictionary options) Deprecated. Returns an SQL string to cast the values in the column identified by columnName from the current type to a new type specified by castType.
NSArray	statementsToConvertColumnType(String columnName, String tableName, EOSchemaSynchronization.ColumnTypes type, EOSchemaSynchronization.ColumnTypes newType, NSDictionary options) Deprecated. Returns an array of EOSQLExpressions to convert in place of the type of the column indentifed by columnName in the table identified by tableName from the current type to the type specified by newType.
NSArray	statementsToCopyTableNamed(String tableName, NSArray entityGroup, NSDictionary changes, NSDictionary options) Deprecated. Returns an array of EOSQLExpressions to copy the specified table into a new table, whose definition is provided by entityGroup, an array of EOEntity objects with the same external name.
NSArray	statementsToDeleteColumnNamed(String columnName, String tableName, NSDictionary options) Deprecated. Returns an array of EOSQLExpressions to delete the column indentifed by columnName from the table identified by tableName.
NSArray	statementsToDropForeignKeyConstraintsOnEntityGroups(NSArray entityGroups, NSDictionary changes, NSDictionary options) Deprecated. Returns an array of EOSQLExpressions to drop foreign key constraints for the table corresponding to entityGroups, which is an array containing arrays of EOEntity objects with the same external name.
NSArray	statementsToDropPrimaryKeyConstraintsOnEntityGroups(NSArray entityGroups, NSDictionary changes, NSDictionary options) Deprecated. Returns an array of EOSQLExpressions to drop primary key constraints for the table corresponding to entityGroups, which is an array containing arrays of EOEntity objects with the same external name.
NSArray	statementsToDropPrimaryKeySupportForEntityGroups(NSArray entityGroups, NSDictionary changes, NSDictionary options) Deprecated. Returns an array of EOSQLExpressions to drop primary key support for the table corresponding to entityGroups, which is an array containing arrays of EOEntity objects with the same external name.
NSArray	statementsToImplementForeignKeyConstraintsOnEntityGroups(NSArray entityGroups, NSDictionary changes, NSDictionary options) Deprecated. Returns an array of EOSQLExpressions to implement foreign key constraints for the table corresponding to entityGroups, which is an array containing arrays of EOEntity objects with the same external name.
NSArray	statementsToImplementPrimaryKeyConstraintsOnEntityGroups(NSArray entityGroups, NSDictionary changes, NSDictionary options) Deprecated. Returns an array of EOSQLExpressions to implement primary key constraints for the table corresponding to entityGroups, which is an array containing arrays of EOEntity objects with the same external name.
NSArray	statementsToImplementPrimaryKeySupportForEntityGroups(NSArray entityGroups, NSDictionary changes, NSDictionary options) Deprecated. Returns an array of EOSQLExpressions to implement primary key support for the table corresponding to entityGroups, which is an array containing arrays of EOEntity objects with the same external name.
NSArray	statementsToInsertColumnForAttribute(EOAttribute attribute, NSDictionary options) Deprecated. Returns an array of EOSQLExpressions to insert a column in the database schema for the specified attribute.
NSArray	statementsToModifyColumnNullRule(String columnName, String tableName, boolean allowsNull, NSDictionary options) Deprecated. Returns an array of EOSQLExpressions to modify in place the column identified by columnName in the table identified by tableName to either allow or not allow NULL values as specified by allowsNull.
NSArray	statementsToRenameColumnNamed(String columnName, String tableName, String newName, NSDictionary options) Deprecated. Returns an array of EOSQLExpressions to rename in place of the the column indentifed by in the table identified by tableName to newName.
NSArray	statementsToRenameTableNamed(String tableName, String newName, NSDictionary options) Deprecated. Returns an array of EOSQLExpressions to rename in place the the table indentifed by tableName to newName.
NSArray	statementsToUpdateObjectStoreForEntityGroups(NSArray entityGroups, NSDictionary changes, NSDictionary options) Deprecated. Returns an array of EOSQLExpressions to update the database table that corresponds to model according to the changes and SQL generation instructions in the changes and options dictionaries.
NSArray	statementsToUpdateObjectStoreForModel(EOModel model, NSDictionary changes, NSDictionary options) Deprecated. Returns an array of EOSQLExpressions to synchronize the database with the EOModel model.

Methods inherited from interface com.webobjects.eoaccess.synchronization.EOSchemaSynchronization

columnDescriptionForTableAndModel, indexDescriptionForTableAndModel, isColumnTypeEquivalentToColumnType, newChanges, newOptions, objectStoreChangesFromAttributeToAttribute, phraseCastingColumnNamed, statementsToConvertColumnType, statementsToCopyTableNamed, statementsToDeleteColumnNamed, statementsToDropForeignKeyConstraintsOnEntityGroups, statementsToDropPrimaryKeyConstraintsOnEntityGroups, statementsToDropPrimaryKeySupportForEntityGroups, statementsToImplementForeignKeyConstraintsOnEntityGroups, statementsToImplementPrimaryKeyConstraintsOnEntityGroups, statementsToImplementPrimaryKeySupportForEntityGroups, statementsToInsertColumnForAttribute, statementsToModifyColumnNullRule, statementsToRenameColumnNamed, statementsToRenameTableNamed, statementsToUpdateObjectStoreForEntityGroups, statementsToUpdateObjectStoreForModel, supportsDirectColumnCoercion, supportsDirectColumnDeletion, supportsDirectColumnInsertion, supportsDirectColumnNullRuleModification, supportsDirectColumnRenaming, supportsSchemaSynchronization, supportsTableDescriptionIntrospection, tableDescriptionForModel

Field Detail

SchemaSynchronizationForeignKeyConstraintsKey

static final String SchemaSynchronizationForeignKeyConstraintsKey

Deprecated.

Options dictionary key; an associated value of "YES" determines that the EOSQLExpression should generate SQL to create foreign key constraints.

See Also:

Constant Field Values

SchemaSynchronizationPrimaryKeyConstraintsKey

static final String SchemaSynchronizationPrimaryKeyConstraintsKey

Deprecated.

Options dictionary key; an associated value of "YES" determines that the EOSQLExpression should generate SQL to create primary key constraints.

See Also:

Constant Field Values

SchemaSynchronizationPrimaryKeySupportKey

static final String SchemaSynchronizationPrimaryKeySupportKey

Deprecated.

Options dictionary key; an associated value of "YES" determines that the EOSQLExpression should generate SQL to create primary key support.

See Also:

Constant Field Values

AllowsNullKey

static final String AllowsNullKey

Deprecated.

Key for use in change dictionaries whose value of "YES" or "NO" is the setting in the database for whether a database column allows NULL values.

See Also:

EOAttribute.allowsNull(), Constant Field Values

ColumnNameKey

static final String ColumnNameKey

Deprecated.

Key for use in change dictionaries whose value is the column name in the database for an EOAttribute.

See Also:

EOAttribute.columnName(), Constant Field Values

ExternalNameKey

static final String ExternalNameKey

Deprecated.

Key for use in change dictionaries whose value is the external name (database table name) for an EOEntity.

See Also:

EOEntity.externalName(), Constant Field Values

ExternalTypeKey

static final String ExternalTypeKey

Deprecated.

Key for use in change dictionaries whose value is the external type (database type) for an EOAttribute.

See Also:

EOAttribute.externalType(), Constant Field Values

NameKey

static final String NameKey

Deprecated.

Key for use in change dictionaries whose value is the name in the database for a property.

See Also:

EOAttribute.name(), EOEntity.name(), EORelationship.name(), Constant Field Values

PrecisionKey

static final String PrecisionKey

Deprecated.

Key for use in change dictionaries whose value is the precision value in the database for an EOAttribute.

See Also:

EOAttribute.precision(), Constant Field Values

RelationshipsKey

static final String RelationshipsKey

Deprecated.

Key for use in change dictionaries whose value is a dictionary of relationships which have been modified since the last time the model and schema were synchronized.

See Also:

Constant Field Values

ScaleKey

static final String ScaleKey

Deprecated.

Key for use in change dictionaries whose value is the scale value in the database for an EOAttribute.

See Also:

EOAttribute.scale(), Constant Field Values

WidthKey

static final String WidthKey

Deprecated.

Key for use in change dictionaries whose corresponding value is the width value in the database for an EOAttribute.

See Also:

EOAttribute.width(), Constant Field Values

Method Detail

isColumnTypeEquivalentToColumnType

boolean isColumnTypeEquivalentToColumnType(EOSchemaSynchronization.ColumnTypes candidate,
                                           EOSchemaSynchronization.ColumnTypes columnType,
                                           NSDictionary options)

Deprecated.

Returns true if the name, precision, width, and scale of candidate are identical to the name, precision, width, and scale of columnType, false otherwise. If the columns are equivalent, the candidate column can be copied to columnType without casting.

Parameters:

candidate - A column to potentially copy.

columnType - A column into which to copy candidate.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

true if the specified attributes of candidate are identical to the corresponding attributes of columnType.

phraseCastingColumnNamed

String phraseCastingColumnNamed(String columnName,
                                EOSchemaSynchronization.ColumnTypes type,
                                EOSchemaSynchronization.ColumnTypes castType,
                                NSDictionary options)

Deprecated.

Returns an SQL string to cast the values in the column identified by columnName from the current type to a new type specified by castType. This method is used when the adaptor doesn't support in-place column type coercion, and the table has to be recreated. To move data from the old table to the new table, sometimes a conversion statement is needed (for example, to convert strings in a VARCHAR column to numbers). options is a dictionary describing the aspects of the schema for which to create SQL statements.

Parameters:

columnName - The name of a database column.

type - The type of the values in the specified column.

castType - The new type to which to cast the values in the specified column.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

An SQL string to cast the values in the specified column to castType

statementsToCopyTableNamed

NSArray statementsToCopyTableNamed(String tableName,
                                   NSArray entityGroup,
                                   NSDictionary changes,
                                   NSDictionary options)

Deprecated.

Returns an array of EOSQLExpressions to copy the specified table into a new table, whose definition is provided by entityGroup, an array of EOEntity objects with the same external name. This method is used when the adaptor doesn't support the in-place table modifications required to synchronize the database to a model.

The changes dictionary identifies the changes to make to the database schema. The options dictionary describes the aspects of the schema for which to create SQL statements.

Parameters:

tableName - The name of the table to be copied.

entityGroup - An array of EOEntity objects that defines a new database table into which to copy the named table.

changes - A dictionary of changes to make to the database schema.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

An array of the EOSQLExpressions to copy the table named tableName to a new table defined by entityGroup.

See Also:

EOSchemaSynchronization

statementsToInsertColumnForAttribute

NSArray statementsToInsertColumnForAttribute(EOAttribute attribute,
                                             NSDictionary options)

Deprecated.

Returns an array of EOSQLExpressions to insert a column in the database schema for the specified attribute. The options dictionary describes the aspects of the schema for which to create SQL statements.

Parameters:

attribute - An EOAttribute for which to insert a database column.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

An array of the EOSQLExpressions to insert the column for attribute.

See Also:

EOAttribute, EOSchemaSynchronization

statementsToModifyColumnNullRule

NSArray statementsToModifyColumnNullRule(String columnName,
                                         String tableName,
                                         boolean allowsNull,
                                         NSDictionary options)

Deprecated.

Returns an array of EOSQLExpressions to modify in place the column identified by columnName in the table identified by tableName to either allow or not allow NULL values as specified by allowsNull. The options dictionary describes the aspects of the schema for which to create SQL statements.

Parameters:

columnName - The name of a column to be modified.

tableName - The name of the table containing the specified column.

allowsNull - A boolean value to determine whether to allow or not allow NULL values in the specified column.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

An array of the EOSQLExpressions to modify the specified column to allow or disallow NULL values.

See Also:

EOSchemaSynchronization

statementsToConvertColumnType

NSArray statementsToConvertColumnType(String columnName,
                                      String tableName,
                                      EOSchemaSynchronization.ColumnTypes type,
                                      EOSchemaSynchronization.ColumnTypes newType,
                                      NSDictionary options)

Deprecated.

Returns an array of EOSQLExpressions to convert in place of the type of the column indentifed by columnName in the table identified by tableName from the current type to the type specified by newType. options is a dictionary describing the aspects of the schema for which to create SQL statements.

Parameters:

columnName - The name of a column to be modified.

tableName - The name of the table containing the specified column.

type - The current type of the specified column.

newType - The type to which to convert the specified column.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

An array of the EOSQLExpressions to convert in place the type of the specified column.

statementsToDeleteColumnNamed

NSArray statementsToDeleteColumnNamed(String columnName,
                                      String tableName,
                                      NSDictionary options)

Deprecated.

Returns an array of EOSQLExpressions to delete the column indentifed by columnName from the table identified by tableName. options is a dictionary describing the aspects of the schema for which to create SQL statements.

Parameters:

columnName - The name of a column to be deleted.

tableName - The name of the table containing the specified column.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

An array of the EOSQLExpressions to delete the specified column.

statementsToRenameColumnNamed

NSArray statementsToRenameColumnNamed(String columnName,
                                      String tableName,
                                      String newName,
                                      NSDictionary options)

Deprecated.

Returns an array of EOSQLExpressions to rename in place of the the column indentifed by in the table identified by tableName to newName. options is a dictionary describing the aspects of the schema for which to create SQL statements.

Parameters:

columnName - The name of a column to be renamed.

tableName - The name of the table containing the specified column.

newName - The new name for the specified column.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

An array of the EOSQLExpressions to rename in place the specified column.

statementsToDropForeignKeyConstraintsOnEntityGroups

NSArray statementsToDropForeignKeyConstraintsOnEntityGroups(NSArray entityGroups,
                                                            NSDictionary changes,
                                                            NSDictionary options)

Deprecated.

Returns an array of EOSQLExpressions to drop foreign key constraints for the table corresponding to entityGroups, which is an array containing arrays of EOEntity objects with the same external name. The changes dictionary identifies the changes to make to the database schema. The options dictionary describes the aspects of the schema for which to create SQL statements.

Parameters:

entityGroups - An array containing arrays of EOEntity objects with the same external name.

changes - A dictionary of changes to make to the database schema.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

An array of the EOSQLExpressions to drop foreign key constraints for the table corresponding to entityGroups.

See Also:

EOSchemaSynchronization

statementsToDropPrimaryKeyConstraintsOnEntityGroups

NSArray statementsToDropPrimaryKeyConstraintsOnEntityGroups(NSArray entityGroups,
                                                            NSDictionary changes,
                                                            NSDictionary options)

Deprecated.

Returns an array of EOSQLExpressions to drop primary key constraints for the table corresponding to entityGroups, which is an array containing arrays of EOEntity objects with the same external name. The changes dictionary identifies the changes to make to the database schema. The options dictionary describes the aspects of the schema for which to create SQL statements.

Parameters:

entityGroups - An array containing arrays of EOEntity objects with the same external name.

changes - A dictionary of changes to make to the database schema.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

An array of the EOSQLExpressions to drop primary key constraints for the table corresponding to entityGroups.

See Also:

EOSchemaSynchronization

statementsToDropPrimaryKeySupportForEntityGroups

NSArray statementsToDropPrimaryKeySupportForEntityGroups(NSArray entityGroups,
                                                         NSDictionary changes,
                                                         NSDictionary options)

Deprecated.

Returns an array of EOSQLExpressions to drop primary key support for the table corresponding to entityGroups, which is an array containing arrays of EOEntity objects with the same external name. The changes dictionary identifies the changes to make to the database schema. The options dictionary describes the aspects of the schema for which to create SQL statements.

Parameters:

entityGroups - An array containing arrays of EOEntity objects with the same external name.

changes - A dictionary of changes to make to the database schema.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

An array of the EOSQLExpressions to drop primary key support for the table corresponding to entityGroups.

See Also:

EOSchemaSynchronization

statementsToImplementForeignKeyConstraintsOnEntityGroups

NSArray statementsToImplementForeignKeyConstraintsOnEntityGroups(NSArray entityGroups,
                                                                 NSDictionary changes,
                                                                 NSDictionary options)

Deprecated.

Returns an array of EOSQLExpressions to implement foreign key constraints for the table corresponding to entityGroups, which is an array containing arrays of EOEntity objects with the same external name. The changes dictionary identifies changes to make to the database schema. The options dictionary describes the aspects of the schema for which to create SQL statements.

Parameters:

entityGroups - An array containing arrays of EOEntity objects with the same external name.

changes - A dictionary of changes to make to the database schema.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

An array of the EOSQLExpressions to implement foreign key constraints for the table corresponding to entityGroups.

See Also:

EOSchemaSynchronization

statementsToImplementPrimaryKeyConstraintsOnEntityGroups

NSArray statementsToImplementPrimaryKeyConstraintsOnEntityGroups(NSArray entityGroups,
                                                                 NSDictionary changes,
                                                                 NSDictionary options)

Deprecated.

Returns an array of EOSQLExpressions to implement primary key constraints for the table corresponding to entityGroups, which is an array containing arrays of EOEntity objects with the same external name. The changes dictionary identifies the changes to make to the database schema. The options dictionary describes the aspects of the schema for which to create SQL statements.

Parameters:

entityGroups - An array containing arrays of EOEntity objects with the same external name.

changes - A dictionary of changes to make to the database schema.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

An array of the EOSQLExpressions to implement primary key constraints for the table corresponding to entityGroups.

See Also:

EOSchemaSynchronization

statementsToImplementPrimaryKeySupportForEntityGroups

NSArray statementsToImplementPrimaryKeySupportForEntityGroups(NSArray entityGroups,
                                                              NSDictionary changes,
                                                              NSDictionary options)

Deprecated.

Returns an array of EOSQLExpressions to implement primary key support for the table corresponding to entityGroups, which is an array containing arrays of EOEntity objects with the same external name. The changes dictionary identifies the changes to make to the database schema. The options dictionary describes the aspects of the schema for which to create SQL statements.

Parameters:

entityGroups - An array containing arrays of EOEntity objects with the same external name.

changes - A dictionary of changes to make to the database schema.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

An array of the EOSQLExpressions to implement primary key support for the table corresponding to entityGroups.

See Also:

EOSchemaSynchronization

statementsToRenameTableNamed

NSArray statementsToRenameTableNamed(String tableName,
                                     String newName,
                                     NSDictionary options)

Deprecated.

Returns an array of EOSQLExpressions to rename in place the the table indentifed by tableName to newName. options is a dictionary describing the aspects of the schema for which to create SQL statements.

Parameters:

tableName - The name of a table to be renamed.

newName - The new name for the specified table.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

An array of the EOSQLExpressions to rename in place the specified table.

statementsToUpdateObjectStoreForModel

NSArray statementsToUpdateObjectStoreForModel(EOModel model,
                                              NSDictionary changes,
                                              NSDictionary options)

Deprecated.

Returns an array of EOSQLExpressions to synchronize the database with the EOModel model. Prepares the statements to insert and delete new and deleted tables before invoking statementsToUpdateObjectStoreForEntityGroups for each modified table. The changes dictionary identifies the changes to make to the database schema. The options dictionary describes the aspects of the schema for which to create SQL statements.

Parameters:

model - The EOModel with which to sychnronize the database.

changes - A dictionary of changes to make to the database schema.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

An array of the EOSQLExpressions to synchronize the database with model.

See Also:

EOSchemaSynchronization.statementsToUpdateObjectStoreForEntityGroups(com.webobjects.foundation.NSArray, com.webobjects.foundation.NSDictionary, com.webobjects.foundation.NSDictionary), EOSchemaSynchronization

statementsToUpdateObjectStoreForEntityGroups

NSArray statementsToUpdateObjectStoreForEntityGroups(NSArray entityGroups,
                                                     NSDictionary changes,
                                                     NSDictionary options)

Deprecated.

Returns an array of EOSQLExpressions to update the database table that corresponds to model according to the changes and SQL generation instructions in the changes and options dictionaries. model is an array of entity groups, which are arrays of EOEntity objects that have the same external name. Inserts and deletes columns, and updates modified columns.

Parameters:

entityGroups - An array of entity groups, which are arrays of EOEntity objects that have the same external name.

changes - A dictionary of changes to make to the database schema.

options - A dictionary describing the aspects of the schema for which to create SQL statements.

Returns:

An array of the EOSQLExpressions to update the database table corresponding to the entity groups in model.

See Also:

EOSchemaSynchronization