schemacrawler.utility

Class Identifiers

java.lang.Object

schemacrawler.utility.Identifiers

public final class Identifiers
extends java.lang.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

Field Summary

Fields

Modifier and Type	Field and Description
static Identifiers	STANDARD

Method Summary

Modifier and Type	Method and Description
java.lang.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()
java.util.Collection<java.lang.String>	getReservedWords() Get a list of reserved words, normalized to uppercase.
static Identifiers.Builder	identifiers()
boolean	isQuotedName(java.lang.String name) Checks if an identifier name is quoted using the identifier quote character.
boolean	isReservedWord(java.lang.String word) Checks if a given word is a reserved word.
boolean	isToBeQuoted(java.lang.String name) Checks if a given identifier name needs to be quoted.
java.lang.String	quoteFullName(DatabaseObject databaseObject)
java.lang.String	quoteFullName(DatabaseObject parent, java.lang.String name)
<P extends DatabaseObject> java.lang.String	quoteFullName(DependantObject<P> dependantObject)
java.lang.String	quoteFullName(Schema schema)
java.lang.String	quoteName(NamedObject namedObject) Quotes an identifier name using the identifier quote string.
java.lang.String	quoteName(java.lang.String name) Quotes an identifier name using the identifier quote string.
<P extends DatabaseObject> java.lang.String	quoteShortName(DependantObject<P> dependantObject)

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

identifiers

public static Identifiers.Builder identifiers()

getIdentifierQuoteString

public java.lang.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 java.util.Collection<java.lang.String> getReservedWords()

Get a list of reserved words, normalized to uppercase.

isQuotedName

public boolean isQuotedName(java.lang.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(java.lang.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(java.lang.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 java.lang.String quoteFullName(DatabaseObject databaseObject)

quoteFullName

public java.lang.String quoteFullName(DatabaseObject parent,
                                      java.lang.String name)

quoteFullName

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

quoteFullName

public java.lang.String quoteFullName(Schema schema)

quoteName

public java.lang.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:

name - Identifier name to quote

Returns:

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

quoteName

public java.lang.String quoteName(java.lang.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> java.lang.String quoteShortName(DependantObject<P> dependantObject)