Package org.hibernate.cfg
Class EJB3NamingStrategy
- java.lang.Object
-
- org.hibernate.cfg.EJB3NamingStrategy
-
- All Implemented Interfaces:
java.io.Serializable
,NamingStrategy
- Direct Known Subclasses:
DefaultComponentSafeNamingStrategy
public class EJB3NamingStrategy extends java.lang.Object implements NamingStrategy, java.io.Serializable
Naming strategy implementing the EJB3 standards- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static NamingStrategy
INSTANCE
-
Constructor Summary
Constructors Constructor Description EJB3NamingStrategy()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
classToTableName(java.lang.String className)
Return a table name for an entity classjava.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 tablejava.lang.String
columnName(java.lang.String columnName)
Alter the column name given in the mapping documentjava.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 parametersjava.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 tablejava.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 metadatajava.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 metadatajava.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 tablejava.lang.String
propertyToColumnName(java.lang.String propertyName)
Return a column name for a property path expressionjava.lang.String
tableName(java.lang.String tableName)
Alter the table name given in the mapping document
-
-
-
Field Detail
-
INSTANCE
public static final NamingStrategy INSTANCE
-
-
Method Detail
-
classToTableName
public java.lang.String classToTableName(java.lang.String className)
Description copied from interface:NamingStrategy
Return a table name for an entity class- Specified by:
classToTableName
in interfaceNamingStrategy
- Parameters:
className
- the fully-qualified class name- Returns:
- a table name
-
propertyToColumnName
public java.lang.String propertyToColumnName(java.lang.String propertyName)
Description copied from interface:NamingStrategy
Return a column name for a property path expression- Specified by:
propertyToColumnName
in interfaceNamingStrategy
- Parameters:
propertyName
- a property path- Returns:
- a column name
-
tableName
public java.lang.String tableName(java.lang.String tableName)
Description copied from interface:NamingStrategy
Alter the table name given in the mapping document- Specified by:
tableName
in interfaceNamingStrategy
- Parameters:
tableName
- a table name- Returns:
- a table name
-
columnName
public java.lang.String columnName(java.lang.String columnName)
Description copied from interface:NamingStrategy
Alter the column name given in the mapping document- Specified by:
columnName
in interfaceNamingStrategy
- Parameters:
columnName
- a column name- Returns:
- a column name
-
collectionTableName
public java.lang.String collectionTableName(java.lang.String ownerEntity, java.lang.String ownerEntityTable, java.lang.String associatedEntity, java.lang.String associatedEntityTable, java.lang.String propertyName)
Description copied from interface:NamingStrategy
Return a collection table name ie an association having a join table- Specified by:
collectionTableName
in interfaceNamingStrategy
ownerEntityTable
- owner side table nameassociatedEntityTable
- reverse side table name if anypropertyName
- collection role
-
joinKeyColumnName
public java.lang.String joinKeyColumnName(java.lang.String joinedColumn, java.lang.String joinedTable)
Description copied from interface:NamingStrategy
Return the join key column name ie a FK column used in a JOINED strategy or for a secondary table- Specified by:
joinKeyColumnName
in interfaceNamingStrategy
- Parameters:
joinedColumn
- joined column name (logical one) used to join withjoinedTable
- joined table name (ie the referenced table) used to join with
-
foreignKeyColumnName
public java.lang.String foreignKeyColumnName(java.lang.String propertyName, java.lang.String propertyEntityName, java.lang.String propertyTableName, java.lang.String referencedColumnName)
Description copied from interface:NamingStrategy
Return the foreign key column name for the given parameters- Specified by:
foreignKeyColumnName
in interfaceNamingStrategy
- Parameters:
propertyName
- the property name involvedpropertyTableName
- the property table name involved (logical one)referencedColumnName
- the referenced column name involved (logical one)
-
logicalColumnName
public java.lang.String logicalColumnName(java.lang.String columnName, java.lang.String propertyName)
Description copied from interface:NamingStrategy
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- Specified by:
logicalColumnName
in interfaceNamingStrategy
- Parameters:
columnName
- given column name if anypropertyName
- property name of this column
-
logicalCollectionTableName
public java.lang.String logicalCollectionTableName(java.lang.String tableName, java.lang.String ownerEntityTable, java.lang.String associatedEntityTable, java.lang.String propertyName)
Description copied from interface:NamingStrategy
Returns the logical collection table name used to refer to a table in the mapping metadata- Specified by:
logicalCollectionTableName
in interfaceNamingStrategy
- Parameters:
tableName
- the metadata explicit nameownerEntityTable
- owner table entity table name (logical one)associatedEntityTable
- reverse side table name if any (logical one)propertyName
- collection role
-
logicalCollectionColumnName
public java.lang.String logicalCollectionColumnName(java.lang.String columnName, java.lang.String propertyName, java.lang.String referencedColumn)
Description copied from interface:NamingStrategy
Returns the logical foreign key column name used to refer to this column in the mapping metadata- Specified by:
logicalCollectionColumnName
in interfaceNamingStrategy
- Parameters:
columnName
- given column name in the metadata if anypropertyName
- property namereferencedColumn
- referenced column name (logical one) in the join
-
-