org.hibernate.cfg

Class DefaultNamingStrategy

java.lang.Object

org.hibernate.cfg.DefaultNamingStrategy

All Implemented Interfaces:

java.io.Serializable, NamingStrategy

public class DefaultNamingStrategy
extends java.lang.Object
implements NamingStrategy, java.io.Serializable

The default NamingStrategy

Author:

Gavin King

See Also:

a better alternative, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static NamingStrategy	INSTANCE The singleton instance

Constructor Summary

Constructors

Constructor and Description
DefaultNamingStrategy()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	classToTableName(java.lang.String className) Return the unqualified class 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) Return the unqualified property name, not the best strategy but a backward compatible one
java.lang.String	columnName(java.lang.String columnName) Return the argument
java.lang.String	foreignKeyColumnName(java.lang.String propertyName, java.lang.String propertyEntityName, java.lang.String propertyTableName, java.lang.String referencedColumnName) Return the property name or propertyTableName
java.lang.String	joinKeyColumnName(java.lang.String joinedColumn, java.lang.String joinedTable) Return the argument
java.lang.String	logicalCollectionColumnName(java.lang.String columnName, java.lang.String propertyName, java.lang.String referencedColumn) Return the column name if explicit or the concatenation of the property name and the referenced column
java.lang.String	logicalCollectionTableName(java.lang.String tableName, java.lang.String ownerEntityTable, java.lang.String associatedEntityTable, java.lang.String propertyName) Returns either the table name if explicit or if there is an associated table, the concatenation of owner entity table and associated table otherwise the concatenation of owner entity table and the unqualified property name
java.lang.String	logicalColumnName(java.lang.String columnName, java.lang.String propertyName) Return the column name or the unqualified property name
java.lang.String	propertyToColumnName(java.lang.String propertyName) Return the unqualified property name
java.lang.String	tableName(java.lang.String tableName) Return the argument

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final NamingStrategy INSTANCE

The singleton instance

Constructor Detail

DefaultNamingStrategy

public DefaultNamingStrategy()

Method Detail

classToTableName

public java.lang.String classToTableName(java.lang.String className)

Return the unqualified class name

Specified by:

classToTableName in interface NamingStrategy

Parameters:

className - the fully-qualified class name

Returns:

a table name

propertyToColumnName

public java.lang.String propertyToColumnName(java.lang.String propertyName)

Return the unqualified property name

Specified by:

propertyToColumnName in interface NamingStrategy

Parameters:

propertyName - a property path

Returns:

a column name

tableName

public java.lang.String tableName(java.lang.String tableName)

Return the argument

Specified by:

tableName in interface NamingStrategy

Parameters:

tableName - a table name

Returns:

a table name

columnName

public java.lang.String columnName(java.lang.String columnName)

Return the argument

Specified by:

columnName in interface NamingStrategy

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)

Return the unqualified property name, not the best strategy but a backward compatible one

Specified by:

collectionTableName in interface NamingStrategy

ownerEntityTable - owner side table name

associatedEntityTable - reverse side table name if any

propertyName - collection role

joinKeyColumnName

public java.lang.String joinKeyColumnName(java.lang.String joinedColumn,
                                 java.lang.String joinedTable)

Return the argument

Specified by:

joinKeyColumnName in interface NamingStrategy

Parameters:

joinedColumn - joined column name (logical one) used to join with

joinedTable - 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)

Return the property name or propertyTableName

Specified by:

foreignKeyColumnName in interface NamingStrategy

Parameters:

propertyName - the property name involved

propertyTableName - 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)

Return the column name or the unqualified property name

Specified by:

logicalColumnName in interface NamingStrategy

Parameters:

columnName - given column name if any

propertyName - 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)

Returns either the table name if explicit or if there is an associated table, the concatenation of owner entity table and associated table otherwise the concatenation of owner entity table and the unqualified property name

Specified by:

logicalCollectionTableName in interface NamingStrategy

Parameters:

tableName - the metadata explicit name

ownerEntityTable - 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)

Return the column name if explicit or the concatenation of the property name and the referenced column

Specified by:

logicalCollectionColumnName in interface NamingStrategy

Parameters:

columnName - given column name in the metadata if any

propertyName - property name

referencedColumn - referenced column name (logical one) in the join