|
||||||||||
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 | |
---|---|
java.lang.String |
classToTableName(java.lang.String className)
Return a table name for an entity class |
java.lang.String |
collectionTableName(java.lang.String ownerEntity,
java.lang.String ownerEntityTable,
java.lang.String associatedEntity,
java.lang.String associatedEntityTable,
java.lang.String propertyName)
Return a collection table name ie an association having a join table |
java.lang.String |
columnName(java.lang.String columnName)
Alter the column name given in the mapping document |
java.lang.String |
foreignKeyColumnName(java.lang.String propertyName,
java.lang.String propertyEntityName,
java.lang.String propertyTableName,
java.lang.String referencedColumnName)
Return the foreign key column name for the given parameters |
java.lang.String |
joinKeyColumnName(java.lang.String joinedColumn,
java.lang.String joinedTable)
Return the join key column name ie a FK column used in a JOINED strategy or for a secondary table |
java.lang.String |
logicalCollectionColumnName(java.lang.String columnName,
java.lang.String propertyName,
java.lang.String referencedColumn)
Returns the logical foreign key column name used to refer to this column in the mapping metadata |
java.lang.String |
logicalCollectionTableName(java.lang.String tableName,
java.lang.String ownerEntityTable,
java.lang.String associatedEntityTable,
java.lang.String propertyName)
Returns the logical collection table name used to refer to a table in the mapping metadata |
java.lang.String |
logicalColumnName(java.lang.String columnName,
java.lang.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 |
java.lang.String |
propertyToColumnName(java.lang.String propertyName)
Return a column name for a property path expression |
java.lang.String |
tableName(java.lang.String tableName)
Alter the table name given in the mapping document |
Method Detail |
---|
java.lang.String classToTableName(java.lang.String className)
className
- the fully-qualified class name
java.lang.String propertyToColumnName(java.lang.String propertyName)
propertyName
- a property path
java.lang.String tableName(java.lang.String tableName)
tableName
- a table name
java.lang.String columnName(java.lang.String columnName)
columnName
- a column name
java.lang.String collectionTableName(java.lang.String ownerEntity, java.lang.String ownerEntityTable, java.lang.String associatedEntity, java.lang.String associatedEntityTable, java.lang.String propertyName)
ownerEntity
- ownerEntityTable
- owner side table nameassociatedEntity
- associatedEntityTable
- reverse side table name if anypropertyName
- collection rolejava.lang.String joinKeyColumnName(java.lang.String joinedColumn, java.lang.String joinedTable)
joinedColumn
- joined column name (logical one) used to join withjoinedTable
- joined table name (ie the referenced table) used to join withjava.lang.String foreignKeyColumnName(java.lang.String propertyName, java.lang.String propertyEntityName, java.lang.String propertyTableName, java.lang.String referencedColumnName)
propertyName
- the property name involvedpropertyEntityName
- propertyTableName
- the property table name involved (logical one)referencedColumnName
- the referenced column name involved (logical one)java.lang.String logicalColumnName(java.lang.String columnName, java.lang.String propertyName)
columnName
- given column name if anypropertyName
- property name of this columnjava.lang.String logicalCollectionTableName(java.lang.String tableName, java.lang.String ownerEntityTable, java.lang.String associatedEntityTable, java.lang.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 rolejava.lang.String logicalCollectionColumnName(java.lang.String columnName, java.lang.String propertyName, java.lang.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 |