|
WebObjects 5.4.2 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.webobjects.eoaccess.synchronization.EOSchemaSynchronizationFactory com.webobjects.jdbcadaptor.OpenBasePlugIn.OpenBaseSynchronizationFactory
public static class OpenBasePlugIn.OpenBaseSynchronizationFactory
Nested Class Summary | |
---|---|
static class |
OpenBasePlugIn.OpenBaseSynchronizationFactory.OpenBaseColumnDescription
|
static class |
OpenBasePlugIn.OpenBaseSynchronizationFactory.OpenBaseIndexDescription
|
static class |
OpenBasePlugIn.OpenBaseSynchronizationFactory.OpenBaseTableDescription
|
Nested classes/interfaces inherited from class com.webobjects.eoaccess.synchronization.EOSchemaSynchronizationFactory |
---|
EOSchemaSynchronizationFactory.Delegate |
Nested classes/interfaces inherited from interface com.webobjects.eoaccess.synchronization.EOSchemaSynchronization |
---|
EOSchemaSynchronization.ColumnTypes |
Constructor Summary | |
---|---|
OpenBasePlugIn.OpenBaseSynchronizationFactory(EOAdaptor adaptor)
|
Method Summary | |
---|---|
protected NSArray |
createIndexExpressionsForEntity(EOEntity entity,
EOEntityIndex anIndex,
EOEntity masterEntity)
|
protected String |
createIndexStatementForEntity(EOEntity entity,
String indexName,
String tableName,
NSArray attributeList)
|
protected String |
createIndexStatementForEntity(EOEntity entity,
String indexName,
String tableName,
String attributeName)
|
protected String |
dropIndexStatementForEntity(EOEntity entity,
String indexName,
String tableName)
|
NSArray |
dropPrimaryKeySupportStatementsForEntityGroup(NSArray entityGroup)
The default implementation returns null . |
NSArray |
dropPrimaryKeySupportStatementsForEntityGroups(NSArray entityGroups)
Returns an array of EOSQLExpression objects that define the SQL necessary to drop the primary key generation support for all the entities in each of the the entity groups in entityGroups . |
NSArray |
foreignKeyConstraintStatementsForRelationship(EORelationship relationship)
Returns an array of EOSQLExpression objects that define the SQL statements necessary to create foreign key constraints for relationship . |
protected String |
formatColumnName(String name)
Formats the column name for insertion in a select statement. |
protected String |
formatTableName(String name)
Formats the table name for insertion in a select statement. |
boolean |
isColumnTypeEquivalentToColumnType(EOSchemaSynchronization.ColumnTypes candidate,
EOSchemaSynchronization.ColumnTypes columnType,
EOSchemaGenerationOptions options)
Returns true if the name, precision, width, and scale of candidate are identical to the name, precision, width, and scale of columnType , false otherwise. |
protected boolean |
isSinglePrimaryKeyAttribute(EOAttribute attribute)
|
EOSchemaSynchronizationColumnChanges |
objectStoreChangesFromAttributeToAttribute(EOAttribute schemaAttribute,
EOAttribute modelAttribute)
Compares schemaAttribute with modelAttribute and returns a change dictionary of state that is different between the the two. |
NSArray |
primaryKeyConstraintStatementsForEntityGroup(NSArray entityGroup)
Returns an array of EOSQLExpression objects that define the SQL necessary to create the primary key constraints for entityGroup . |
NSArray |
primaryKeySupportStatementsForEntityGroup(NSArray entityGroup)
The default implementation returns null . |
NSArray |
primaryKeySupportStatementsForEntityGroups(NSArray entityGroups)
Returns an array of EOSQLExpression objects that define the SQL necessary to create the primary key generation support for all the entities in each of the the entity groups in entityGroups . |
NSArray |
statementsToDeleteColumnNamed(String columnName,
String tableName,
EOSchemaGenerationOptions options)
The default implementation returns null . |
NSArray |
statementsToDropForeignKeyConstraintsOnEntityGroups(NSArray entityGroups,
EOSchemaSynchronizationModelChanges changes,
EOSchemaGenerationOptions options)
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,
EOSchemaSynchronizationModelChanges changes,
EOSchemaGenerationOptions options)
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 |
statementsToImplementPrimaryKeyConstraintsOnEntityGroups(NSArray entityGroups,
EOSchemaSynchronizationModelChanges changes,
EOSchemaGenerationOptions options)
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 |
statementsToModifyColumnNullRule(String columnName,
String tableName,
boolean allowsNull,
EOSchemaGenerationOptions options)
Returns null by default. |
NSArray |
statementsToRenameColumnNamed(String columnName,
String tableName,
String newName,
EOSchemaGenerationOptions options)
The default implementation returns null . |
NSArray |
statementsToRenameTableNamed(String tableName,
String newName,
EOSchemaGenerationOptions options)
Returns an array of EOSQLExpressions to rename in place the the table indentifed by tableName to newName . |
boolean |
supportsDirectColumnCoercion()
The default implementation returns false . |
boolean |
supportsDirectColumnDeletion()
The default implementation returns false . |
boolean |
supportsDirectColumnInsertion()
The default implementation returns false . |
boolean |
supportsDirectColumnNullRuleModification()
The default implementation returns false . |
boolean |
supportsDirectColumnRenaming()
The default implementation returns false . |
boolean |
supportsSchemaSynchronization()
The default implementation returns false . |
boolean |
supportsTableDescriptionIntrospection()
The default implementation returns false . |
EOSchemaTableDescription |
tableDescriptionForModel(String tableName,
EOModel eomodel)
Return a Table Description object that describe the database schema. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public OpenBasePlugIn.OpenBaseSynchronizationFactory(EOAdaptor adaptor)
Method Detail |
---|
public NSArray dropPrimaryKeySupportStatementsForEntityGroups(NSArray entityGroups)
EOSchemaSynchronizationFactory
entityGroups
. Returns an empty array if entityGroups
is null
or empty. If
primary key generation is not supported, returns an array that contains the string "The 'Drop Primary Key Support' option is unavailable."
This method invokes dropPrimaryKeySupportStatementsForEntityGroup
for each entity group in entityGroups
and returns an array of all the resulting EOSQLExpressions. Since the default implementation of dropPrimaryKeySupportStatementsForEntityGroup
returns null
, this method returns the "not supported" value (see above) by default, but a subclass need only override dropPrimaryKeySupportStatementsForEntityGroup
in order to enable this method as well.
dropPrimaryKeySupportStatementsForEntityGroups
in interface EOSchemaGeneration
dropPrimaryKeySupportStatementsForEntityGroups
in class EOSchemaSynchronizationFactory
entityGroups
- An NSArray of entity groups, which are arrays of EOEntity objects that have the same external name.
entityGroups
, or an empty array, or an array containing a string message that the option is not supported.EOSchemaSynchronizationFactory.dropPrimaryKeySupportStatementsForEntityGroup( NSArray entityGroup)
,
#schemaCreationStatementsForEntities( NSArray allEntities, NSDictionary options)
,
EOAdaptorChannel.primaryKeyForNewRowWithEntity( EOEntity entity)
,
EOEntity.externalName()
public NSArray foreignKeyConstraintStatementsForRelationship(EORelationship relationship)
EOSchemaGeneration
relationship
. Returns an empty array if unable to generate foreign key constraints for relationship
foreignKeyConstraintStatementsForRelationship
in interface EOSchemaGeneration
foreignKeyConstraintStatementsForRelationship
in class EOSchemaSynchronizationFactory
relationship
- An EORelationship.
relationship
, or an empty array.EOSQLExpression
,
EOSchemaSynchronizationFactory.foreignKeyConstraintStatementsForRelationship(EORelationship relationship)
,
#schemaCreationStatementsForEntities( NSArray allEntities, NSDictionary options)
public NSArray primaryKeySupportStatementsForEntityGroups(NSArray entityGroups)
EOSchemaSynchronizationFactory
entityGroups
. Returns an empty array if entityGroups
is null
or empty.
If primary key generation is not supported, returns an array that contains the string "The 'Create Primary Key Support' option is unavailable."
This method invokes primaryKeySupportStatementsForEntityGroup
for each entity group in entityGroups
and returns an array of all the resulting EOSQLExpressions. Since the default implementation of primaryKeySupportStatementsForEntityGroup
returns
null
, this method returns the "not supported" value (see above) by default, but a subclass need only override primaryKeySupportStatementsForEntityGroup
in order to enable this method as well.
primaryKeySupportStatementsForEntityGroups
in interface EOSchemaGeneration
primaryKeySupportStatementsForEntityGroups
in class EOSchemaSynchronizationFactory
entityGroups
- An NSArray of entity groups, which are arrays of EOEntity objects that have the same external name.
entityGroups
, or an empty array, or an array containing a string message that the option is not supported.EOSchemaSynchronizationFactory.primaryKeySupportStatementsForEntityGroup( NSArray entityGroup)
,
EOAdaptorChannel.primaryKeyForNewRowWithEntity( EOEntity entity)
,
EOEntity.externalName()
protected String formatTableName(String name)
EOSchemaSynchronizationFactory
formatTableName
in class EOSchemaSynchronizationFactory
name
- table name
protected String formatColumnName(String name)
EOSchemaSynchronizationFactory
formatColumnName
in class EOSchemaSynchronizationFactory
name
- column name
protected boolean isSinglePrimaryKeyAttribute(EOAttribute attribute)
public NSArray primaryKeyConstraintStatementsForEntityGroup(NSArray entityGroup)
EOSchemaSynchronizationFactory
entityGroup
. Returns an empty array if any of the primary key attributes in entityGroup
don't have a column name or if entityGroup
is null
.
This method creates a statement of the form:
ALTER TABLE TABLE_NAME ADD PRIMARY KEY (PRIMARY_KEY_COLUMN_NAMES)
where TABLE_NAME
is the external name for the first entity in entityGroup
and PRIMARY_KEY_COLUMN_NAMES
is a comma-separated list of the column names of the first entity's primary key attributes. If the subclass's database server's primary key
constraint semantics are different, the subclass should override this method.
primaryKeyConstraintStatementsForEntityGroup
in interface EOSchemaGeneration
primaryKeyConstraintStatementsForEntityGroup
in class EOSchemaSynchronizationFactory
entityGroup
- An array of EOEntity objects that have the same external name.
entityGroup
, or an empty array.EOAttribute.columnName()
,
EOEntity.externalName()
,
EOEntity.primaryKeyAttributes()
public boolean isColumnTypeEquivalentToColumnType(EOSchemaSynchronization.ColumnTypes candidate, EOSchemaSynchronization.ColumnTypes columnType, EOSchemaGenerationOptions options)
EOSchemaSynchronizationFactory
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.
isColumnTypeEquivalentToColumnType
in interface EOSchemaSynchronization
isColumnTypeEquivalentToColumnType
in class EOSchemaSynchronizationFactory
candidate
- A column to potentially copy.columnType
- A column into which to copy candidate
.options
- Unused.
true
if the specified attributes of candidate
are identical to the corresponding attributes of columnType
.public NSArray statementsToDropForeignKeyConstraintsOnEntityGroups(NSArray entityGroups, EOSchemaSynchronizationModelChanges changes, EOSchemaGenerationOptions options)
EOSchemaSynchronization
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.
statementsToDropForeignKeyConstraintsOnEntityGroups
in interface EOSchemaSynchronization
statementsToDropForeignKeyConstraintsOnEntityGroups
in class EOSchemaSynchronizationFactory
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.
entityGroups
.EOSchemaSynchronization
public NSArray statementsToDropPrimaryKeyConstraintsOnEntityGroups(NSArray entityGroups, EOSchemaSynchronizationModelChanges changes, EOSchemaGenerationOptions options)
EOSchemaSynchronization
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.
statementsToDropPrimaryKeyConstraintsOnEntityGroups
in interface EOSchemaSynchronization
statementsToDropPrimaryKeyConstraintsOnEntityGroups
in class EOSchemaSynchronizationFactory
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.
entityGroups
.EOSchemaSynchronization
public NSArray statementsToImplementPrimaryKeyConstraintsOnEntityGroups(NSArray entityGroups, EOSchemaSynchronizationModelChanges changes, EOSchemaGenerationOptions options)
EOSchemaSynchronization
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.
statementsToImplementPrimaryKeyConstraintsOnEntityGroups
in interface EOSchemaSynchronization
statementsToImplementPrimaryKeyConstraintsOnEntityGroups
in class EOSchemaSynchronizationFactory
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.
entityGroups
.EOSchemaSynchronization
protected NSArray createIndexExpressionsForEntity(EOEntity entity, EOEntityIndex anIndex, EOEntity masterEntity)
createIndexExpressionsForEntity
in class EOSchemaSynchronizationFactory
protected String createIndexStatementForEntity(EOEntity entity, String indexName, String tableName, NSArray attributeList)
createIndexStatementForEntity
in class EOSchemaSynchronizationFactory
protected String createIndexStatementForEntity(EOEntity entity, String indexName, String tableName, String attributeName)
protected String dropIndexStatementForEntity(EOEntity entity, String indexName, String tableName)
dropIndexStatementForEntity
in class EOSchemaSynchronizationFactory
public NSArray statementsToModifyColumnNullRule(String columnName, String tableName, boolean allowsNull, EOSchemaGenerationOptions options)
EOSchemaSynchronizationFactory
null
by default. Can be overridden by subclasses to return an array of EOSQLExpressions to modify in place of 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.
statementsToModifyColumnNullRule
in interface EOSchemaSynchronization
statementsToModifyColumnNullRule
in class EOSchemaSynchronizationFactory
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.
empty array
by default.EOSchemaSynchronization
public NSArray statementsToRenameColumnNamed(String columnName, String tableName, String newName, EOSchemaGenerationOptions options)
EOSchemaSynchronizationFactory
null
. Can be overridden by subclasses to return an array of EOSQLExpressions to rename the column indentifed by columnName
in the table identified by tableName
to newName
. options
is a dictionary describing the aspects of the schema for which to create SQL statements.
statementsToRenameColumnNamed
in interface EOSchemaSynchronization
statementsToRenameColumnNamed
in class EOSchemaSynchronizationFactory
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.
empty array
by default.public NSArray statementsToRenameTableNamed(String tableName, String newName, EOSchemaGenerationOptions options)
EOSchemaSynchronization
tableName
to newName
. options
is a dictionary describing the aspects of the schema for which to create SQL statements.
statementsToRenameTableNamed
in interface EOSchemaSynchronization
statementsToRenameTableNamed
in class EOSchemaSynchronizationFactory
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.
public NSArray statementsToDeleteColumnNamed(String columnName, String tableName, EOSchemaGenerationOptions options)
EOSchemaSynchronizationFactory
null
. Can be overridden by subclasses to return an array of EOSQLExpressions to delete in place of the column indentifed by tableName
. options
is a dictionary
describing the aspects of the schema for which to create SQL statements.
statementsToDeleteColumnNamed
in interface EOSchemaSynchronization
statementsToDeleteColumnNamed
in class EOSchemaSynchronizationFactory
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.
empty array
by default.public boolean supportsDirectColumnCoercion()
EOSchemaSynchronizationFactory
false
. Can be overridden by subclasses to return true
if the adaptor can change the type of an existing column in place.
supportsDirectColumnCoercion
in interface EOSchemaSynchronization
supportsDirectColumnCoercion
in class EOSchemaSynchronizationFactory
true
if the adaptor can change the type of an existing column in place.public boolean supportsDirectColumnDeletion()
EOSchemaSynchronizationFactory
false
. Can be overridden by subclasses to return true
if the adaptor can delete columns.
supportsDirectColumnDeletion
in interface EOSchemaSynchronization
supportsDirectColumnDeletion
in class EOSchemaSynchronizationFactory
true
if the adaptor can delete columns.public boolean supportsDirectColumnInsertion()
EOSchemaSynchronizationFactory
false
. Can be overridden by subclasses to return true
if the adaptor can add columns to a table.
supportsDirectColumnInsertion
in interface EOSchemaSynchronization
supportsDirectColumnInsertion
in class EOSchemaSynchronizationFactory
true
if the adaptor can add columns to a table.public boolean supportsDirectColumnNullRuleModification()
EOSchemaSynchronizationFactory
false
. Can be overridden by subclasses to return true
if the adaptor can modify the null
rule of an existing column in place.
supportsDirectColumnNullRuleModification
in interface EOSchemaSynchronization
supportsDirectColumnNullRuleModification
in class EOSchemaSynchronizationFactory
true
if the adaptor can modify the null
rule of an existing column in place.public boolean supportsDirectColumnRenaming()
EOSchemaSynchronizationFactory
false
. Can be overridden by subclasses to return true
if the adaptor can rename columns in a table.
supportsDirectColumnRenaming
in interface EOSchemaSynchronization
supportsDirectColumnRenaming
in class EOSchemaSynchronizationFactory
true
if the adaptor can rename columns in a table.public boolean supportsSchemaSynchronization()
EOSchemaSynchronizationFactory
false
. Can be overridden by subclasses to return true
if the adaptor can update the database schema to reflect changes in an EOModel.
supportsSchemaSynchronization
in interface EOSchemaSynchronization
supportsSchemaSynchronization
in class EOSchemaSynchronizationFactory
true
if the adaptor can update the database schema.public boolean supportsTableDescriptionIntrospection()
EOSchemaSynchronizationFactory
false
. Can be overridden by subclasses to return true
if the adaptor can describe the database schema.
supportsTableDescriptionIntrospection
in interface EOSchemaSynchronization
supportsTableDescriptionIntrospection
in class EOSchemaSynchronizationFactory
true
if the adaptor can describe the database schema.public EOSchemaTableDescription tableDescriptionForModel(String tableName, EOModel eomodel)
EOSchemaSynchronization
tableDescriptionForModel
in interface EOSchemaSynchronization
tableDescriptionForModel
in class EOSchemaSynchronizationFactory
tableName
- table name to describeeomodel
- model to introscpect
public NSArray primaryKeySupportStatementsForEntityGroup(NSArray entityGroup)
EOSchemaSynchronizationFactory
null
. Can be overridden by subclasses to return an array of EOSQLExpression objects that define the SQL necessary to create the primary key generation support for entityGroup
.
primaryKeySupportStatementsForEntityGroup
in interface EOSchemaGeneration
primaryKeySupportStatementsForEntityGroup
in class EOSchemaSynchronizationFactory
entityGroup
- An array of EOEntity objects that have the same external name.
null
by default.EOSchemaSynchronizationFactory.dropPrimaryKeySupportStatementsForEntityGroup( NSArray entityGroup)
,
EOAdaptorChannel.primaryKeyForNewRowWithEntity( EOEntity entity)
,
EOEntity.externalName()
public NSArray dropPrimaryKeySupportStatementsForEntityGroup(NSArray entityGroup)
EOSchemaSynchronizationFactory
null
. Can be overridden by subclasses to return an array of EOSQLExpression objects that define the SQL necessary to drop the primary key generation support for entityGroup
.
dropPrimaryKeySupportStatementsForEntityGroup
in interface EOSchemaGeneration
dropPrimaryKeySupportStatementsForEntityGroup
in class EOSchemaSynchronizationFactory
entityGroup
- An array of EOEntity objects that have the same external name.
null
by default.EOSchemaSynchronizationFactory.primaryKeySupportStatementsForEntityGroup( NSArray entityGroup)
,
EOEntity.externalName()
public EOSchemaSynchronizationColumnChanges objectStoreChangesFromAttributeToAttribute(EOAttribute schemaAttribute, EOAttribute modelAttribute)
EOSchemaSynchronization
schemaAttribute
with modelAttribute
and returns a change dictionary of state that is different between the the two. The possible keys in the change dictionary are: ExternalTypeKey
AllowsNullKey
PrecisionKey
ScaleKey
WidthKey
The values in the change dictionary are the corresponding values of schemaAttribute
, that is, the values stored in the database.
objectStoreChangesFromAttributeToAttribute
in interface EOSchemaSynchronization
objectStoreChangesFromAttributeToAttribute
in class EOSchemaSynchronizationFactory
schemaAttribute
- An EOAttribute as represented in the database.modelAttribute
- An EOAttribute as represented in the EOModel.
schemaAttribute
and modelAttribute
.
|
Last updated June 2008 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |