|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface NamingStrategy
A set of rules for determining the physical column
and table names given the information in the mapping
document. May be used to implement project-scoped
naming standards for database objects.
#propertyToTableName(String, String) should be replaced by
collectionTableName(String,String,String,String,String)
DefaultNamingStrategy,
ImprovedNamingStrategy| Method Summary | |
|---|---|
String |
classToTableName(String className)
Return a table name for an entity class |
String |
collectionTableName(String ownerEntity,
String ownerEntityTable,
String associatedEntity,
String associatedEntityTable,
String propertyName)
Return a collection table name ie an association having a join table |
String |
columnName(String columnName)
Alter the column name given in the mapping document |
String |
foreignKeyColumnName(String propertyName,
String propertyEntityName,
String propertyTableName,
String referencedColumnName)
Return the foreign key column name for the given parameters |
String |
joinKeyColumnName(String joinedColumn,
String joinedTable)
Return the join key column name ie a FK column used in a JOINED strategy or for a secondary table |
String |
logicalCollectionColumnName(String columnName,
String propertyName,
String referencedColumn)
Returns the logical foreign key column name used to refer to this column in the mapping metadata |
String |
logicalCollectionTableName(String tableName,
String ownerEntityTable,
String associatedEntityTable,
String propertyName)
Returns the logical collection table name used to refer to a table in the mapping metadata |
String |
logicalColumnName(String columnName,
String propertyName)
Return the logical column name used to refer to a column in the metadata (like index, unique constraints etc) A full bijection is required between logicalNames and physical ones logicalName have to be case insersitively unique for a given table |
String |
propertyToColumnName(String propertyName)
Return a column name for a property path expression |
String |
tableName(String tableName)
Alter the table name given in the mapping document |
| Method Detail |
|---|
String classToTableName(String className)
className - the fully-qualified class name
String propertyToColumnName(String propertyName)
propertyName - a property path
String tableName(String tableName)
tableName - a table name
String columnName(String columnName)
columnName - a column name
String collectionTableName(String ownerEntity,
String ownerEntityTable,
String associatedEntity,
String associatedEntityTable,
String propertyName)
ownerEntity - ownerEntityTable - owner side table nameassociatedEntity - associatedEntityTable - reverse side table name if anypropertyName - collection role
String joinKeyColumnName(String joinedColumn,
String joinedTable)
joinedColumn - joined column name (logical one) used to join withjoinedTable - joined table name (ie the referenced table) used to join with
String foreignKeyColumnName(String propertyName,
String propertyEntityName,
String propertyTableName,
String referencedColumnName)
propertyName - the property name involvedpropertyEntityName - propertyTableName - the property table name involved (logical one)referencedColumnName - the referenced column name involved (logical one)
String logicalColumnName(String columnName,
String propertyName)
columnName - given column name if anypropertyName - property name of this column
String logicalCollectionTableName(String tableName,
String ownerEntityTable,
String associatedEntityTable,
String propertyName)
tableName - the metadata explicit nameownerEntityTable - owner table entity table name (logical one)associatedEntityTable - reverse side table name if any (logical one)propertyName - collection role
String logicalCollectionColumnName(String columnName,
String propertyName,
String referencedColumn)
columnName - given column name in the metadata if anypropertyName - property namereferencedColumn - referenced column name (logical one) in the join
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||