Hibernate ORM - hibernate-core 5.6.15.Final · org.hibernate.boot.model.naming.ImplicitNamingStrategy

Pluggable strategy for applying implicit naming rules when an explicit name is not given.

Note

the method names here mostly favor the JPA naming (aka, secondary table rather than join)

Methods fall into 2 main categories:

Table naming
- Entity primary table - determinePrimaryTableName. Used when the primary table for an entity is not explicitly named in the metadata. See javax.persistence.Table for details.
- Join table - determineJoinTableName. See javax.persistence.JoinTable for details. Join table covers basically any entity association whether in the form of a collection of entities (one-to-many, many-to-many) or a singular entity association (many-to-one, and occasionally one-to-one).
- Collection table - determineCollectionTableName - Collection table refers to any non-entity collection (basic, component/embeddable, any). See javax.persistence.CollectionTable for details.
- Notice that secondary tables are not mentioned, since they must always be explicitly named
Column naming

Method Summary

Modifier and Type	Method and Description
public Identifier	Returns: The determined column name determineAnyDiscriminatorColumnName(ImplicitAnyDiscriminatorColumnNameSource The source information source) Determine the column name related to the discriminator portion of an ANY mapping when no explicit column name is given.
public Identifier	Returns: The determined identifier column name determineAnyKeyColumnName(ImplicitAnyKeyColumnNameSource The source information source) Determine the column name related to the key/id portion of an ANY mapping when no explicit column name is given.
public Identifier	Returns: The implicit column name. determineBasicColumnName(ImplicitBasicColumnNameSource The source information source) Determine the name of an attribute's column given the source naming information, when a name is not explicitly given.
public Identifier	Returns: The implicit table name. determineCollectionTableName(ImplicitCollectionTableNameSource The source information source) Determine the name of a collection join table given the source naming information, when a name is not explicitly given.
public Identifier	Returns: The implicit discriminator column name determineDiscriminatorColumnName(ImplicitDiscriminatorColumnNameSource The source information source) Determine the implicit name for the discriminator column for the given entity
public Identifier	determineForeignKeyName(ImplicitForeignKeyNameSource source)
public Identifier	Returns: The determined identifier column name determineIdentifierColumnName(ImplicitIdentifierColumnNameSource The source information source) Determine the implicit name for the identifier column for the given entity
public Identifier	determineIndexName(ImplicitIndexNameSource source)
public Identifier	Returns: The determined join column name determineJoinColumnName(ImplicitJoinColumnNameSource The source information source) Determine the column name related to `javax.persistence.JoinColumn`.
public Identifier	Returns: The implicit table name. determineJoinTableName(ImplicitJoinTableNameSource The source information source) Determine the name of an association join table given the source naming information, when a name is not explicitly given.
public Identifier	determineListIndexColumnName(ImplicitIndexColumnNameSource source)
public Identifier	determineMapKeyColumnName(ImplicitMapKeyColumnNameSource source)
public Identifier	Returns: The determined column name determinePrimaryKeyJoinColumnName(ImplicitPrimaryKeyJoinColumnNameSource The source information source) Determine the column name related to `javax.persistence.PrimaryKeyJoinColumn`.
public Identifier	Returns: The implicit table name. determinePrimaryTableName(ImplicitEntityNameSource The source information source) Determine the implicit name of an entity's primary table.
public Identifier	Returns: The determined tenant identifier column name determineTenantIdColumnName(ImplicitTenantIdColumnNameSource The source information source) Determine the implicit name for the tenant (multi-tenancy) identifier column for the given entity
public Identifier	determineUniqueKeyName(ImplicitUniqueKeyNameSource source)

Method Detail

determineAnyDiscriminatorColumnName	back to summary
public Identifier determineAnyDiscriminatorColumnName(ImplicitAnyDiscriminatorColumnNameSource source) Determine the column name related to the discriminator portion of an ANY mapping when no explicit column name is given. Parameters source:ImplicitAnyDiscriminatorColumnNameSource The source information Returns:Identifier The determined column name

determineAnyDiscriminatorColumnName

back to summary

public Identifier determineAnyDiscriminatorColumnName(ImplicitAnyDiscriminatorColumnNameSource source)

Determine the column name related to the discriminator portion of an ANY mapping when no explicit column name is given.

Parameters

source:ImplicitAnyDiscriminatorColumnNameSource: The source information

Returns:Identifier

The determined column name

determineAnyKeyColumnName	back to summary
public Identifier determineAnyKeyColumnName(ImplicitAnyKeyColumnNameSource source) Determine the column name related to the key/id portion of an ANY mapping when no explicit column name is given. Parameters source:ImplicitAnyKeyColumnNameSource The source information Returns:Identifier The determined identifier column name

determineAnyKeyColumnName

back to summary

public Identifier determineAnyKeyColumnName(ImplicitAnyKeyColumnNameSource source)

Determine the column name related to the key/id portion of an ANY mapping when no explicit column name is given.

Parameters

source:ImplicitAnyKeyColumnNameSource: The source information

Returns:Identifier

The determined identifier column name

determineBasicColumnName	back to summary
public Identifier determineBasicColumnName(ImplicitBasicColumnNameSource source) Determine the name of an attribute's column given the source naming information, when a name is not explicitly given. Parameters source:ImplicitBasicColumnNameSource The source information Returns:Identifier The implicit column name.

determineBasicColumnName

back to summary

public Identifier determineBasicColumnName(ImplicitBasicColumnNameSource source)

Determine the name of an attribute's column given the source naming information, when a name is not explicitly given.

Parameters

source:ImplicitBasicColumnNameSource: The source information

Returns:Identifier

The implicit column name.

determineCollectionTableName	back to summary
public Identifier determineCollectionTableName(ImplicitCollectionTableNameSource source) Determine the name of a collection join table given the source naming information, when a name is not explicitly given. Parameters source:ImplicitCollectionTableNameSource The source information Returns:Identifier The implicit table name.

determineCollectionTableName

back to summary

public Identifier determineCollectionTableName(ImplicitCollectionTableNameSource source)

Determine the name of a collection join table given the source naming information, when a name is not explicitly given.

Parameters

source:ImplicitCollectionTableNameSource: The source information

Returns:Identifier

The implicit table name.

determineDiscriminatorColumnName	back to summary
public Identifier determineDiscriminatorColumnName(ImplicitDiscriminatorColumnNameSource source) Determine the implicit name for the discriminator column for the given entity Parameters source:ImplicitDiscriminatorColumnNameSource The source information Returns:Identifier The implicit discriminator column name

determineDiscriminatorColumnName

back to summary

public Identifier determineDiscriminatorColumnName(ImplicitDiscriminatorColumnNameSource source)

Determine the implicit name for the discriminator column for the given entity

Parameters

source:ImplicitDiscriminatorColumnNameSource: The source information

Returns:Identifier

The implicit discriminator column name

determineForeignKeyName	back to summary
public Identifier determineForeignKeyName(ImplicitForeignKeyNameSource source)

determineIdentifierColumnName	back to summary
public Identifier determineIdentifierColumnName(ImplicitIdentifierColumnNameSource source) Determine the implicit name for the identifier column for the given entity Parameters source:ImplicitIdentifierColumnNameSource The source information Returns:Identifier The determined identifier column name

determineIdentifierColumnName

back to summary

public Identifier determineIdentifierColumnName(ImplicitIdentifierColumnNameSource source)

Determine the implicit name for the identifier column for the given entity

Parameters

source:ImplicitIdentifierColumnNameSource: The source information

Returns:Identifier

The determined identifier column name

determineIndexName	back to summary
public Identifier determineIndexName(ImplicitIndexNameSource source)

determineJoinColumnName back to summary

determineJoinColumnName	back to summary
public Identifier determineJoinColumnName(ImplicitJoinColumnNameSource source) Determine the column name related to `javax.persistence.JoinColumn`. In `hbm.xml` terms, this would be a `<key/>` defined for a collection or the column associated with a many-to-one. Parameters source:ImplicitJoinColumnNameSource The source information Returns:Identifier The determined join column name

public Identifier determineJoinColumnName(ImplicitJoinColumnNameSource source)

Determine the column name related to javax.persistence.JoinColumn. In hbm.xml terms, this would be a <key/> defined for a collection or the column associated with a many-to-one.

Parameters

source:ImplicitJoinColumnNameSource: The source information

Returns:Identifier

The determined join column name

determineJoinTableName	back to summary
public Identifier determineJoinTableName(ImplicitJoinTableNameSource source) Determine the name of an association join table given the source naming information, when a name is not explicitly given. Parameters source:ImplicitJoinTableNameSource The source information Returns:Identifier The implicit table name.

determineJoinTableName

back to summary

public Identifier determineJoinTableName(ImplicitJoinTableNameSource source)

Determine the name of an association join table given the source naming information, when a name is not explicitly given.

Parameters

source:ImplicitJoinTableNameSource: The source information

Returns:Identifier

The implicit table name.

determineListIndexColumnName	back to summary
public Identifier determineListIndexColumnName(ImplicitIndexColumnNameSource source)

determineMapKeyColumnName	back to summary
public Identifier determineMapKeyColumnName(ImplicitMapKeyColumnNameSource source)

determinePrimaryKeyJoinColumnName back to summary

determinePrimaryKeyJoinColumnName	back to summary
public Identifier determinePrimaryKeyJoinColumnName(ImplicitPrimaryKeyJoinColumnNameSource source) Determine the column name related to `javax.persistence.PrimaryKeyJoinColumn`. In `hbm.xml` terms, this would be a `<key/>` defined for a `<join/>` or a `<joined-subclass/>` (others?) Parameters source:ImplicitPrimaryKeyJoinColumnNameSource The source information Returns:Identifier The determined column name

public Identifier determinePrimaryKeyJoinColumnName(ImplicitPrimaryKeyJoinColumnNameSource source)

Determine the column name related to javax.persistence.PrimaryKeyJoinColumn. In hbm.xml terms, this would be a <key/> defined for a <join/> or a <joined-subclass/> (others?)

Parameters

source:ImplicitPrimaryKeyJoinColumnNameSource: The source information

Returns:Identifier

The determined column name

determinePrimaryTableName	back to summary
public Identifier determinePrimaryTableName(ImplicitEntityNameSource source) Determine the implicit name of an entity's primary table. Parameters source:ImplicitEntityNameSource The source information Returns:Identifier The implicit table name.

determinePrimaryTableName

back to summary

public Identifier determinePrimaryTableName(ImplicitEntityNameSource source)

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

Parameters

source:ImplicitEntityNameSource: The source information

Returns:Identifier

The implicit table name.

determineTenantIdColumnName	back to summary
public Identifier determineTenantIdColumnName(ImplicitTenantIdColumnNameSource source) Determine the implicit name for the tenant (multi-tenancy) identifier column for the given entity Parameters source:ImplicitTenantIdColumnNameSource The source information Returns:Identifier The determined tenant identifier column name

determineTenantIdColumnName

back to summary

public Identifier determineTenantIdColumnName(ImplicitTenantIdColumnNameSource source)

Determine the implicit name for the tenant (multi-tenancy) identifier column for the given entity

Parameters

source:ImplicitTenantIdColumnNameSource: The source information

Returns:Identifier

The determined tenant identifier column name

determineUniqueKeyName	back to summary
public Identifier determineUniqueKeyName(ImplicitUniqueKeyNameSource source)

public Interface ImplicitNamingStrategy

Method Summary

Method Detail