org.hibernate.engine.jdbc.env.internal

Class NormalizingIdentifierHelperImpl

java.lang.Object

org.hibernate.engine.jdbc.env.internal.NormalizingIdentifierHelperImpl

All Implemented Interfaces:

IdentifierHelper

public class NormalizingIdentifierHelperImpl
extends Object
implements IdentifierHelper

Author:

Steve Ebersole

Constructor Summary

Constructors

Constructor and Description
NormalizingIdentifierHelperImpl(JdbcEnvironment jdbcEnvironment, NameQualifierSupport nameQualifierSupport, boolean globallyQuoteIdentifiers, boolean globallyQuoteIdentifiersSkipColumnDefinitions, boolean autoQuoteKeywords, Set<String> reservedWords, IdentifierCaseStrategy unquotedCaseStrategy, IdentifierCaseStrategy quotedCaseStrategy)

Method Summary

Modifier and Type	Method and Description
Identifier	applyGlobalQuoting(String text) Intended only for use in handling quoting requirements for column-definition as defined by Column.columnDefinition(), JoinColumn.columnDefinition(), etc.
boolean	isReservedWord(String word) Check whether the given word represents a reserved word.
Identifier	normalizeQuoting(Identifier identifier) Essentially quotes the identifier if it needs to be.
Identifier	toIdentifier(String text) Generate an Identifier instance from its simple name as obtained from mapping information.
Identifier	toIdentifier(String text, boolean quoted) Generate an Identifier instance from its simple name as obtained from mapping information.
String	toMetaDataCatalogName(Identifier identifier) Render the Identifier representation of a catalog name into the String form needed in DatabaseMetaData calls.
String	toMetaDataObjectName(Identifier identifier) Render the Identifier representation of an object name (table, sequence, etc) into the String form needed in DatabaseMetaData calls.
String	toMetaDataSchemaName(Identifier identifier) Render the Identifier representation of a schema name into the String form needed in DatabaseMetaData calls.

Methods inherited from class java.lang.Object

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

Constructor Detail

NormalizingIdentifierHelperImpl

public NormalizingIdentifierHelperImpl(JdbcEnvironment jdbcEnvironment,
                                       NameQualifierSupport nameQualifierSupport,
                                       boolean globallyQuoteIdentifiers,
                                       boolean globallyQuoteIdentifiersSkipColumnDefinitions,
                                       boolean autoQuoteKeywords,
                                       Set<String> reservedWords,
                                       IdentifierCaseStrategy unquotedCaseStrategy,
                                       IdentifierCaseStrategy quotedCaseStrategy)

Method Detail

normalizeQuoting

public Identifier normalizeQuoting(Identifier identifier)

Description copied from interface: IdentifierHelper

Essentially quotes the identifier if it needs to be. Useful to apply global quoting, as well as reserved word quoting after calls to naming strategies.

Specified by:

normalizeQuoting in interface IdentifierHelper

Parameters:

identifier - The identifier for which to normalize quoting.

Returns:

The quoting-normalized Identifier.

toIdentifier

public Identifier toIdentifier(String text)

Description copied from interface: IdentifierHelper

Generate an Identifier instance from its simple name as obtained from mapping information.

Note that Identifiers returned from here may be implicitly quoted based on 'globally quoted identifiers' or based on reserved words.

Specified by:

toIdentifier in interface IdentifierHelper

Parameters:

text - The text form of a name as obtained from mapping information.

Returns:

The identifier form of the name.

toIdentifier

public Identifier toIdentifier(String text,
                               boolean quoted)

Description copied from interface: IdentifierHelper

Generate an Identifier instance from its simple name as obtained from mapping information. Additionally, this form takes a boolean indicating whether to explicitly quote the Identifier.

Note that Identifiers returned from here may be implicitly quoted based on 'globally quoted identifiers' or based on reserved words.

Specified by:

toIdentifier in interface IdentifierHelper

Parameters:

text - The text form of a name as obtained from mapping information.

quoted - Is the identifier to be quoted explicitly.

Returns:

The identifier form of the name.

applyGlobalQuoting

public Identifier applyGlobalQuoting(String text)

Description copied from interface: IdentifierHelper

Intended only for use in handling quoting requirements for column-definition as defined by Column.columnDefinition(), JoinColumn.columnDefinition(), etc. This method should not be called in any other scenario.

This method is needed to account for that fact that the JPA spec says that column-definition should be quoted of global-identifier-quoting is requested. Again, this is needed for spec compliance. TBH, I can not think of a argument why column-definitions should ever be *globally* quoted, but the spec is the spec. In fact the default implementation allows applications to opt-out of global-identifier-quoting affecting column-definitions.

Specified by:

applyGlobalQuoting in interface IdentifierHelper

Parameters:

text - The text to be (possibly) quoted

Returns:

The identifier form

See Also:

AvailableSettings.GLOBALLY_QUOTED_IDENTIFIERS_SKIP_COLUMN_DEFINITIONS

isReservedWord

public boolean isReservedWord(String word)

Description copied from interface: IdentifierHelper

Check whether the given word represents a reserved word.

Specified by:

isReservedWord in interface IdentifierHelper

Parameters:

word - The word to check

Returns:

true if the given word represents a reserved word; false otherwise.

toMetaDataCatalogName

public String toMetaDataCatalogName(Identifier identifier)

Description copied from interface: IdentifierHelper

Render the Identifier representation of a catalog name into the String form needed in DatabaseMetaData calls.

Specified by:

toMetaDataCatalogName in interface IdentifierHelper

Parameters:

identifier - The Identifier representation of a catalog name

Returns:

The String representation of the given catalog name

toMetaDataSchemaName

public String toMetaDataSchemaName(Identifier identifier)

Description copied from interface: IdentifierHelper

Render the Identifier representation of a schema name into the String form needed in DatabaseMetaData calls.

Specified by:

toMetaDataSchemaName in interface IdentifierHelper

Parameters:

identifier - The Identifier representation of a schema name

Returns:

The String representation of the given schema name

toMetaDataObjectName

public String toMetaDataObjectName(Identifier identifier)

Description copied from interface: IdentifierHelper

Render the Identifier representation of an object name (table, sequence, etc) into the String form needed in DatabaseMetaData calls.

Specified by:

toMetaDataObjectName in interface IdentifierHelper

Parameters:

identifier - The Identifier representation of an object name

Returns:

The String representation of the given object name