Package org.apache.openjpa.lib.identifier

Interface IdentifierConfiguration

All Known Implementing Classes:

AbstractDB2Dictionary, AbstractSQLServerDictionary, AccessDictionary, CacheDictionary, DB2Dictionary, DBDictionary, DefaultIdentifierConfiguration, DerbyDictionary, EmpressDictionary, FirebirdDictionary, FoxProDictionary, H2Dictionary, HerdDBDictionary, HSQLDictionary, InformixDictionary, IngresDictionary, InterbaseDictionary, JDataStoreDictionary, MariaDBDictionary, MaxDBDictionary, MySQLDictionary, OracleDictionary, PointbaseDictionary, PostgresDictionary, SolidDBDictionary, SQLServerDictionary, SybaseDictionary

public interface IdentifierConfiguration

The IdentifierConfiguration interface. Implementers of this interface supply naming configuration information to consumers of names/identifiers.

Method Summary

Modifier and Type	Method	Description
boolean	delimitAll()	Returns true if global name delimiting is enabled.
java.lang.String	getConversionKey()	Returns a key that can be used to determine whether conversion should take place.
IdentifierRule	getDefaultIdentifierRule()	Gets the default naming rule
java.lang.String	getDelimitedCase()	Returns the case that is used when delimiting.
java.lang.String	getIdentifierConcatenator()	Returns the value used to concatenate multiple names together.
java.lang.String	getIdentifierDelimiter()	Returns the value used to delimit between individual names.
<T> IdentifierRule	getIdentifierRule(T t)	Returns a naming rule or null if the rule is not found.
<T> java.util.Map<T,IdentifierRule>	getIdentifierRules()	Returns all naming rules
java.lang.String	getLeadingDelimiter()	Returns the leading delimiter value to use when delimiting a name.
java.lang.String	getSchemaCase()	Returns the case that is used when delimiters are not used.
boolean	getSupportsDelimitedIdentifiers()	Returns true if delimiting is supported
java.lang.String	getTrailingDelimiter()	Returns the trailing delimiter value to use when delimiting a name.

Method Detail

getLeadingDelimiter

java.lang.String getLeadingDelimiter()

Returns the leading delimiter value to use when delimiting a name.

getTrailingDelimiter

java.lang.String getTrailingDelimiter()

Returns the trailing delimiter value to use when delimiting a name.

delimitAll

boolean delimitAll()

Returns true if global name delimiting is enabled.

getSupportsDelimitedIdentifiers

boolean getSupportsDelimitedIdentifiers()

Returns true if delimiting is supported

getIdentifierConcatenator

java.lang.String getIdentifierConcatenator()

Returns the value used to concatenate multiple names together. For example: "_" used in TABLE1_TABLE2

getIdentifierDelimiter

java.lang.String getIdentifierDelimiter()

Returns the value used to delimit between individual names. For example: "." used in MYSCHEMA.MYTABLE

getDefaultIdentifierRule

IdentifierRule getDefaultIdentifierRule()

Gets the default naming rule

getIdentifierRules

<T> java.util.Map<T,IdentifierRule> getIdentifierRules()

Returns all naming rules

getIdentifierRule

<T> IdentifierRule getIdentifierRule(T t)

Returns a naming rule or null if the rule is not found.

getDelimitedCase

java.lang.String getDelimitedCase()

Returns the case that is used when delimiting.

Returns:

upper, lower, or preserve

getSchemaCase

java.lang.String getSchemaCase()

Returns the case that is used when delimiters are not used.

Returns:

upper, lower, or preserve

getConversionKey

java.lang.String getConversionKey()

Returns a key that can be used to determine whether conversion should take place. Id configurations should create a key unique to their configuration. The typical key is: leading delimiter (") + name separator(.) + trailing delimiter(")