org.hibernate.boot.model.naming

Interface NamingStrategyHelper

public interface NamingStrategyHelper

Helper contract for dealing with naming strategies.

Method Summary

Modifier and Type	Method and Description
Identifier	determineImplicitName(MetadataBuildingContext buildingContext) Called when the user supplied no explicit name/identifier for the given database object.
Identifier	handleExplicitName(String explicitName, MetadataBuildingContext buildingContext) Called when the user has supplied an explicit name for the database object.
Identifier	toPhysicalName(Identifier logicalName, MetadataBuildingContext buildingContext) Handle converting a logical name to a physical name <p/> Typically implementations will access the PhysicalNamingStrategy via MetadataBuildingContext.getBuildingOptions() → MetadataBuildingOptions.getPhysicalNamingStrategy() <p/> For proper quoting, Database.toIdentifier(String) should be used via MetadataBuildingContext.getMetadataCollector() → Metadata.getDatabase()

Method Detail

determineImplicitName

Identifier determineImplicitName(MetadataBuildingContext buildingContext)

Called when the user supplied no explicit name/identifier for the given database object. <p/> Typically implementations will access the ImplicitNamingStrategy via MetadataBuildingContext.getBuildingOptions() → MetadataBuildingOptions.getImplicitNamingStrategy() <p/> For proper quoting, Database.toIdentifier(String) should be used via MetadataBuildingContext.getMetadataCollector() → Metadata.getDatabase()

Parameters:

buildingContext - The building context in which this is called.

Returns:

The implicit name

handleExplicitName

Identifier handleExplicitName(String explicitName,
                              MetadataBuildingContext buildingContext)

Called when the user has supplied an explicit name for the database object. <p/> Typically implementations will access the ImplicitNamingStrategy via MetadataBuildingContext.getBuildingOptions() → MetadataBuildingOptions.getImplicitNamingStrategy() <p/> For proper quoting, Database.toIdentifier(String) should be used via MetadataBuildingContext.getMetadataCollector() → Metadata.getDatabase()

Parameters:

explicitName - The explicit object name.

buildingContext - The building context in which this is called.

Returns:

The strategy-handled name.

toPhysicalName

Identifier toPhysicalName(Identifier logicalName,
                          MetadataBuildingContext buildingContext)

Handle converting a logical name to a physical name <p/> Typically implementations will access the PhysicalNamingStrategy via MetadataBuildingContext.getBuildingOptions() → MetadataBuildingOptions.getPhysicalNamingStrategy() <p/> For proper quoting, Database.toIdentifier(String) should be used via MetadataBuildingContext.getMetadataCollector() → Metadata.getDatabase()

Parameters:

logicalName - The logical name to convert to a physical name

buildingContext - The building context in which this is called.

Returns:

The physical name