Top Description Fields Constructors Methods
org.hibernate.engine.jdbc.env.spi

public Class IdentifierHelperBuilder

extends Object
Class Inheritance
Imports
java.sql.DatabaseMetaData, .SQLException, java.util.Arrays, .Collection, .List, .Set, .TreeSet, org.hibernate.engine.jdbc.env.internal.NormalizingIdentifierHelperImpl, org.hibernate.internal.util.StringHelper, org.hibernate.internal.util.collections.ArrayHelper, org.jboss.logging.Logger
Builder for IdentifierHelper instances. Mainly here to allow progressive building of the immutable (after instantiation) IdentifierHelper.
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private boolean
autoQuoteInitialUnderscore

private boolean
autoQuoteKeywords

private boolean
globallyQuoteIdentifiers

private final JdbcEnvironment
jdbcEnvironment

private static final Logger
log

private NameQualifierSupport
nameQualifierSupport

private IdentifierCaseStrategy
quotedCaseStrategy

private final TreeSet<String>
reservedWords

private boolean
skipGlobalQuotingForColumnDefinitions

private IdentifierCaseStrategy
unquotedCaseStrategy

Constructor Summary

AccessConstructor and Description
private
IdentifierHelperBuilder(JdbcEnvironment jdbcEnvironment)

Method Summary

Modifier and TypeMethod and Description
public void
applyIdentifierCasing(DatabaseMetaData metaData)

public void
applyReservedWords(DatabaseMetaData
The metadata to get reserved words from
metaData)

Applies any reserved words reported via DatabaseMetaData#getSQLKeywords()

public void
applyReservedWords(String... words)

public void
applyReservedWords(Collection<String> words)

public void
applyReservedWords(Set<String> words)

public IdentifierHelper
build()

public void
clearReservedWords()

public static IdentifierHelperBuilder
from(JdbcEnvironment jdbcEnvironment)

public NameQualifierSupport
getNameQualifierSupport()

public IdentifierCaseStrategy
getQuotedCaseStrategy()

public IdentifierCaseStrategy
getUnquotedCaseStrategy()

public boolean
isGloballyQuoteIdentifiers()

public boolean
isSkipGlobalQuotingForColumnDefinitions()

private static List<String>
parseKeywords(String extraKeywordsString)

public void
setAutoQuoteInitialUnderscore(boolean autoQuoteInitialUnderscore)

public void
setAutoQuoteKeywords(boolean autoQuoteKeywords)

public void
setGloballyQuoteIdentifiers(boolean globallyQuoteIdentifiers)

public void
setNameQualifierSupport(NameQualifierSupport nameQualifierSupport)

public void
setQuotedCaseStrategy(IdentifierCaseStrategy quotedCaseStrategy)

public void
setReservedWords(Set<String> words)

public void
setSkipGlobalQuotingForColumnDefinitions(boolean skipGlobalQuotingForColumnDefinitions)

public void
setUnquotedCaseStrategy(IdentifierCaseStrategy unquotedCaseStrategy)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

autoQuoteInitialUnderscoreback to summary
private boolean autoQuoteInitialUnderscore
autoQuoteKeywordsback to summary
private boolean autoQuoteKeywords
globallyQuoteIdentifiersback to summary
private boolean globallyQuoteIdentifiers
jdbcEnvironmentback to summary
private final JdbcEnvironment jdbcEnvironment
logback to summary
private static final Logger log
nameQualifierSupportback to summary
private NameQualifierSupport nameQualifierSupport
quotedCaseStrategyback to summary
private IdentifierCaseStrategy quotedCaseStrategy
reservedWordsback to summary
private final TreeSet<String> reservedWords
skipGlobalQuotingForColumnDefinitionsback to summary
private boolean skipGlobalQuotingForColumnDefinitions
unquotedCaseStrategyback to summary
private IdentifierCaseStrategy unquotedCaseStrategy

Constructor Detail

IdentifierHelperBuilderback to summary
private IdentifierHelperBuilder(JdbcEnvironment jdbcEnvironment)

Method Detail

applyIdentifierCasingback to summary
public void applyIdentifierCasing(DatabaseMetaData metaData) throws SQLException
applyReservedWordsback to summary
public void applyReservedWords(DatabaseMetaData metaData) throws SQLException

Applies any reserved words reported via DatabaseMetaData#getSQLKeywords()

Parameters
metaData:DatabaseMetaData

The metadata to get reserved words from

Exceptions
SQLException:
Any access to DatabaseMetaData can case SQLException; just re-throw.
applyReservedWordsback to summary
public void applyReservedWords(String... words)
applyReservedWordsback to summary
public void applyReservedWords(Collection<String> words)
applyReservedWordsback to summary
public void applyReservedWords(Set<String> words)
buildback to summary
public IdentifierHelper build()
clearReservedWordsback to summary
public void clearReservedWords()
fromback to summary
public static IdentifierHelperBuilder from(JdbcEnvironment jdbcEnvironment)
getNameQualifierSupportback to summary
public NameQualifierSupport getNameQualifierSupport()
getQuotedCaseStrategyback to summary
public IdentifierCaseStrategy getQuotedCaseStrategy()
getUnquotedCaseStrategyback to summary
public IdentifierCaseStrategy getUnquotedCaseStrategy()
isGloballyQuoteIdentifiersback to summary
public boolean isGloballyQuoteIdentifiers()
isSkipGlobalQuotingForColumnDefinitionsback to summary
public boolean isSkipGlobalQuotingForColumnDefinitions()
parseKeywordsback to summary
private static List<String> parseKeywords(String extraKeywordsString)
setAutoQuoteInitialUnderscoreback to summary
public void setAutoQuoteInitialUnderscore(boolean autoQuoteInitialUnderscore)
setAutoQuoteKeywordsback to summary
public void setAutoQuoteKeywords(boolean autoQuoteKeywords)
setGloballyQuoteIdentifiersback to summary
public void setGloballyQuoteIdentifiers(boolean globallyQuoteIdentifiers)
setNameQualifierSupportback to summary
public void setNameQualifierSupport(NameQualifierSupport nameQualifierSupport)
setQuotedCaseStrategyback to summary
public void setQuotedCaseStrategy(IdentifierCaseStrategy quotedCaseStrategy)
setReservedWordsback to summary
public void setReservedWords(Set<String> words)
setSkipGlobalQuotingForColumnDefinitionsback to summary
public void setSkipGlobalQuotingForColumnDefinitions(boolean skipGlobalQuotingForColumnDefinitions)
setUnquotedCaseStrategyback to summary
public void setUnquotedCaseStrategy(IdentifierCaseStrategy unquotedCaseStrategy)