Package org.hibernate.boot.model.naming

Class ImplicitNamingStrategyJpaCompliantImpl

java.lang.Object

org.hibernate.boot.model.naming.ImplicitNamingStrategyJpaCompliantImpl

All Implemented Interfaces:

Serializable, ImplicitNamingStrategy

Direct Known Subclasses:

ImplicitNamingStrategyComponentPathImpl, ImplicitNamingStrategyLegacyHbmImpl, ImplicitNamingStrategyLegacyJpaImpl

public class ImplicitNamingStrategyJpaCompliantImpl
extends Object
implements ImplicitNamingStrategy, Serializable

Implementation of the ImplicitNamingStrategy contract, generally preferring to conform to JPA standards.

For the legacy JPA-based naming standards initially implemented by Hibernate, see/use ImplicitNamingStrategyLegacyJpaImpl.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final ImplicitNamingStrategy	INSTANCE

Constructor Summary

Constructors

Constructor	Description
ImplicitNamingStrategyJpaCompliantImpl()

Method Summary

Modifier and Type	Method	Description
Identifier	determineAnyDiscriminatorColumnName(ImplicitAnyDiscriminatorColumnNameSource source)	Determine the column name related to the discriminator portion of an Any mapping when no explicit column name is given using Column.name().
Identifier	determineAnyKeyColumnName(ImplicitAnyKeyColumnNameSource source)	Determine the join column name related to the key/id portion of an Any mapping when no explicit join column name is given using JoinColumn.name().
Identifier	determineBasicColumnName(ImplicitBasicColumnNameSource source)	JPA states we should use the following as default: The property or field name That is, the unqualified attribute path.
Identifier	determineCollectionTableName(ImplicitCollectionTableNameSource source)	JPA states we should use the following as default: The concatenation of the name of the containing entity and the name of the collection attribute, separated by an underscore. That is, if owning entity has a JPA entity name:
Identifier	determineDiscriminatorColumnName(ImplicitDiscriminatorColumnNameSource source)	Determine the discriminator column name for the given entity when it is not explicitly specified using DiscriminatorColumn.name().
Identifier	determineForeignKeyName(ImplicitForeignKeyNameSource source)	Determine the foreign key name when it is not explicitly specified using ForeignKey.name().
Identifier	determineIdentifierColumnName(ImplicitIdentifierColumnNameSource source)	Determine the name if the identifier column belonging to the given entity when it is not explicitly specified using Column.name().
Identifier	determineIndexName(ImplicitIndexNameSource source)	Determine the index name when it is not explicitly specified using Index.name().
Identifier	determineJoinColumnName(ImplicitJoinColumnNameSource source)	JPA states we should use the following as default: If there is a "referencing relationship property": The concatenation of the following: the name of the referencing relationship property or field of the referencing entity or embeddable class; _; the name of the referenced primary key column. If there is no such "referencing relationship property", or if the association is an element collection: The concatenation of the following: the name of the entity; _; the name of the referenced primary key column
Identifier	determineJoinTableName(ImplicitJoinTableNameSource source)	JPA states we should use the following as default: The concatenated names of the two associated primary entity tables (owning side first), separated by an underscore. That is:
Identifier	determineListIndexColumnName(ImplicitIndexColumnNameSource source)	Determine the list index column name when it is not explicitly specified using OrderColumn.name().
Identifier	determineMapKeyColumnName(ImplicitMapKeyColumnNameSource source)	Determine the map key column name when it is not explicitly specified using MapKeyColumn.name().
Identifier	determinePrimaryKeyJoinColumnName(ImplicitPrimaryKeyJoinColumnNameSource source)	JPA states we should use the following as default: the same name as the primary key column [of the referenced table]
Identifier	determinePrimaryTableName(ImplicitEntityNameSource source)	Determine the implicit name of an entity's primary table.
Identifier	determineTenantIdColumnName(ImplicitTenantIdColumnNameSource source)	Determine the implicit name of the tenant identifier column belonging to a given entity when it is not explicitly specified using Column.name().
Identifier	determineUniqueKeyName(ImplicitUniqueKeyNameSource source)	Determine the unique key name when it is not explicitly specified using UniqueConstraint.name().
protected Identifier	toIdentifier(String stringForm, MetadataBuildingContext buildingContext)	Easy hook to build an Identifier using the keyword safe IdentifierHelper.
protected String	transformAttributePath(AttributePath attributePath)	For JPA standards we typically need the unqualified name.
protected String	transformEntityName(EntityNaming entityNaming)

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final ImplicitNamingStrategy INSTANCE

Constructor Details

ImplicitNamingStrategyJpaCompliantImpl

public ImplicitNamingStrategyJpaCompliantImpl()

Method Details

determinePrimaryTableName

public Identifier determinePrimaryTableName(ImplicitEntityNameSource source)

Description copied from interface: ImplicitNamingStrategy

Determine the implicit name of an entity's primary table.

Specified by:

determinePrimaryTableName in interface ImplicitNamingStrategy

Parameters:

source - The source information

Returns:

The implicit table name.

transformEntityName

protected String transformEntityName(EntityNaming entityNaming)

determineJoinTableName

public Identifier determineJoinTableName(ImplicitJoinTableNameSource source)

JPA states we should use the following as default:

The concatenated names of the two associated primary entity tables (owning side first), separated by an underscore.

That is:

{OWNING SIDE PRIMARY TABLE NAME}_{NON-OWNING SIDE PRIMARY TABLE NAME}

Specified by:

determineJoinTableName in interface ImplicitNamingStrategy

Parameters:

source - The source information

Returns:

The implicit table name.

determineCollectionTableName

public Identifier determineCollectionTableName(ImplicitCollectionTableNameSource source)

JPA states we should use the following as default:

The concatenation of the name of the containing entity and the name of the collection attribute, separated by an underscore.

That is, if owning entity has a JPA entity name:

{OWNER JPA ENTITY NAME}_{COLLECTION ATTRIBUTE NAME}

otherwise:

{OWNER ENTITY NAME}_{COLLECTION ATTRIBUTE NAME}

Specified by:

determineCollectionTableName in interface ImplicitNamingStrategy

Parameters:

source - The source information

Returns:

The implicit table name.

determineIdentifierColumnName

public Identifier determineIdentifierColumnName(ImplicitIdentifierColumnNameSource source)

Description copied from interface: ImplicitNamingStrategy

Determine the name if the identifier column belonging to the given entity when it is not explicitly specified using Column.name().

Specified by:

determineIdentifierColumnName in interface ImplicitNamingStrategy

Parameters:

source - The source information

Returns:

The determined identifier column name

determineDiscriminatorColumnName

public Identifier determineDiscriminatorColumnName(ImplicitDiscriminatorColumnNameSource source)

Description copied from interface: ImplicitNamingStrategy

Determine the discriminator column name for the given entity when it is not explicitly specified using DiscriminatorColumn.name().

Specified by:

determineDiscriminatorColumnName in interface ImplicitNamingStrategy

Parameters:

source - The source information

Returns:

The implicit discriminator column name

determineTenantIdColumnName

public Identifier determineTenantIdColumnName(ImplicitTenantIdColumnNameSource source)

Description copied from interface: ImplicitNamingStrategy

Determine the implicit name of the tenant identifier column belonging to a given entity when it is not explicitly specified using Column.name().

Specified by:

determineTenantIdColumnName in interface ImplicitNamingStrategy

Parameters:

source - The source information

Returns:

The determined tenant identifier column name

determineBasicColumnName

public Identifier determineBasicColumnName(ImplicitBasicColumnNameSource source)

JPA states we should use the following as default:

The property or field name

That is, the unqualified attribute path.

Specified by:

determineBasicColumnName in interface ImplicitNamingStrategy

Parameters:

source - The source information

Returns:

The implicit column name.

determineJoinColumnName

public Identifier determineJoinColumnName(ImplicitJoinColumnNameSource source)

JPA states we should use the following as default:

• If there is a "referencing relationship property":

  The concatenation of the following: the name of the referencing relationship property or field of the referencing entity or embeddable class; _; the name of the referenced primary key column.

• If there is no such "referencing relationship property", or if the association is an element collection:

  The concatenation of the following: the name of the entity; _; the name of the referenced primary key column

Specified by:

determineJoinColumnName in interface ImplicitNamingStrategy

Parameters:

source - The source information

Returns:

The determined join column name

determinePrimaryKeyJoinColumnName

public Identifier determinePrimaryKeyJoinColumnName(ImplicitPrimaryKeyJoinColumnNameSource source)

JPA states we should use the following as default:

the same name as the primary key column [of the referenced table]

Specified by:

determinePrimaryKeyJoinColumnName in interface ImplicitNamingStrategy

Parameters:

source - The source information

Returns:

The determined column name

determineAnyDiscriminatorColumnName

public Identifier determineAnyDiscriminatorColumnName(ImplicitAnyDiscriminatorColumnNameSource source)

Description copied from interface: ImplicitNamingStrategy

Determine the column name related to the discriminator portion of an Any mapping when no explicit column name is given using Column.name().

Specified by:

determineAnyDiscriminatorColumnName in interface ImplicitNamingStrategy

Parameters:

source - The source information

Returns:

The determined column name

determineAnyKeyColumnName

public Identifier determineAnyKeyColumnName(ImplicitAnyKeyColumnNameSource source)

Description copied from interface: ImplicitNamingStrategy

Determine the join column name related to the key/id portion of an Any mapping when no explicit join column name is given using JoinColumn.name().

Specified by:

determineAnyKeyColumnName in interface ImplicitNamingStrategy

Parameters:

source - The source information

Returns:

The determined identifier column name

determineMapKeyColumnName

public Identifier determineMapKeyColumnName(ImplicitMapKeyColumnNameSource source)

Description copied from interface: ImplicitNamingStrategy

Determine the map key column name when it is not explicitly specified using MapKeyColumn.name().

Specified by:

determineMapKeyColumnName in interface ImplicitNamingStrategy

Parameters:

source - The source information

Returns:

The implicit column name.

determineListIndexColumnName

public Identifier determineListIndexColumnName(ImplicitIndexColumnNameSource source)

Description copied from interface: ImplicitNamingStrategy

Determine the list index column name when it is not explicitly specified using OrderColumn.name().

Specified by:

determineListIndexColumnName in interface ImplicitNamingStrategy

Parameters:

source - The source information

Returns:

The implicit column name.

determineForeignKeyName

public Identifier determineForeignKeyName(ImplicitForeignKeyNameSource source)

Description copied from interface: ImplicitNamingStrategy

Determine the foreign key name when it is not explicitly specified using ForeignKey.name().

Specified by:

determineForeignKeyName in interface ImplicitNamingStrategy

Parameters:

source - The source information

Returns:

The determined foreign key name

determineUniqueKeyName

public Identifier determineUniqueKeyName(ImplicitUniqueKeyNameSource source)

Description copied from interface: ImplicitNamingStrategy

Determine the unique key name when it is not explicitly specified using UniqueConstraint.name().

Specified by:

determineUniqueKeyName in interface ImplicitNamingStrategy

Parameters:

source - The source information

Returns:

The determined foreign key name

determineIndexName

public Identifier determineIndexName(ImplicitIndexNameSource source)

Description copied from interface: ImplicitNamingStrategy

Determine the index name when it is not explicitly specified using Index.name().

Specified by:

determineIndexName in interface ImplicitNamingStrategy

Parameters:

source - The source information

Returns:

The determined foreign key name

transformAttributePath

protected String transformAttributePath(AttributePath attributePath)

For JPA standards we typically need the unqualified name. However, a more usable impl tends to use the whole path. This method provides an easy hook for subclasses to accomplish that

Parameters:

attributePath - The attribute path

Returns:

The extracted name

toIdentifier

protected Identifier toIdentifier(String stringForm,
 MetadataBuildingContext buildingContext)

Easy hook to build an Identifier using the keyword safe IdentifierHelper.

Parameters:

stringForm - The String form of the name

buildingContext - Access to the IdentifierHelper

Returns:

The identifier