schemacrawler.schemacrawler

Class Identifiers

java.lang.Object

schemacrawler.schemacrawler.Identifiers

All Implemented Interfaces:

Serializable, Options

public final class Identifiers
extends Object
implements Options, Serializable

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.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Identifiers	STANDARD

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.
IdentifierQuotingStrategy	getIdentifierQuotingStrategy()
Collection<String>	getReservedWords() Get a list of reserved words, normalized to uppercase.
boolean	isQuotedName(String name) Checks if an identifier name is quoted using the identifier quote character.
boolean	isQuoteMixedCaseIdentifiers()
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	quoteFullName(DatabaseObject databaseObject)
<P extends DatabaseObject> String	quoteFullName(DependantObject<P> dependantObject)
String	quoteFullName(Schema schema)
String	quoteName(NamedObject namedObject) Quotes an identifier name using the identifier quote string.
String	quoteName(String name) Quotes an identifier name using the identifier quote string.
<P extends DatabaseObject> String	quoteShortName(DependantObject<P> dependantObject)
String	unquoteName(String name) Unquotes an identifier name using the identifier quote string.

Methods inherited from class java.lang.Object

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

Field Detail

STANDARD

public static final Identifiers STANDARD

Method Detail

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

getIdentifierQuotingStrategy

public IdentifierQuotingStrategy getIdentifierQuotingStrategy()

getReservedWords

public Collection<String> getReservedWords()

Get a list of reserved words, normalized to uppercase.

Returns:

Reserved words

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

isQuoteMixedCaseIdentifiers

public boolean isQuoteMixedCaseIdentifiers()

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

quoteFullName

public String quoteFullName(DatabaseObject databaseObject)

quoteFullName

public <P extends DatabaseObject> String quoteFullName(DependantObject<P> dependantObject)

quoteFullName

public String quoteFullName(Schema schema)

quoteName

public String quoteName(NamedObject namedObject)

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:

namedObject - Object name to quote

Returns:

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

quoteName

public String quoteName(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

quoteShortName

public <P extends DatabaseObject> String quoteShortName(DependantObject<P> dependantObject)

unquoteName

public String unquoteName(String name)

Unquotes an identifier name using the identifier quote string.

Parameters:

name - Identifier name to unquote

Returns:

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