schemacrawler.utility

Class Identifiers

java.lang.Object

schemacrawler.utility.Identifiers

public final class Identifiers
extends Object

Allows working with database object identifiers. All SQL 2003 keywords are considered identifiers. If a live connection is provided, a list of valid identifiers is obtained from the database server as well. Several utility methods for looking up and quoting and unquoting identifiers are provided.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Identifiers.Builder

Method Summary

Modifier and Type	Method and Description
String	getIdentifierQuoteString() Gets the string used to quote database object identifiers, as provided by the database server, or as overridden by the caller.
Collection<String>	getReservedWords() Get a list of reserved words, normalized to uppercase.
static Identifiers.Builder	identifiers()
boolean	isQuotedName(String name) Checks if an identifier name is quoted using the identifier quote character.
boolean	isReservedWord(String word) Checks if a given word is a reserved word.
boolean	isToBeQuoted(String name) Checks if a given identifier name needs to be quoted.
String	quotedName(String name) Quotes an identifier name using the identifier quote string.
String	unquotedName(String name) Remove quotes from an identifier name using the identifier quote string.

Methods inherited from class java.lang.Object

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

Method Detail

identifiers

public static Identifiers.Builder identifiers()

getIdentifierQuoteString

public String getIdentifierQuoteString()

Gets the string used to quote database object identifiers, as provided by the database server, or as overridden by the caller.

Returns:

Identifier quote string

getReservedWords

public Collection<String> getReservedWords()

Get a list of reserved words, normalized to uppercase.

isQuotedName

public boolean isQuotedName(String name)

Checks if an identifier name is quoted using the identifier quote character.

Parameters:

name - Identifier name to check

Returns:

Whether the identifier name is quoted

isReservedWord

public boolean isReservedWord(String word)

Checks if a given word is a reserved word. Searches are case-insensitive.

Parameters:

word - Word to check

Returns:

Whether the given word is reserved

isToBeQuoted

public boolean isToBeQuoted(String name)

Checks if a given identifier name needs to be quoted. It uses generalized rules which are common across the majority of databases.

Parameters:

name - Identifier name to check

Returns:

Whether the given name needs to be quoted

quotedName

public String quotedName(String name)

Quotes an identifier name using the identifier quote string. Does not quote the identifier name if quoting is not required, per generalized database rules.

Parameters:

name - Identifier name to quote

Returns:

Identifier name after quoting it, or the original name if quoting is not required

unquotedName

public String unquotedName(String name)

Remove quotes from an identifier name using the identifier quote string. Returns the original name if it was not quoted.

Parameters:

name - Identifier name to remove quotes from

Returns:

Identifier name after quoting it, or the original name if quoting is not required