|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface DBIdentifierUtil
An interface for DB identifier utility-style operations. This interface extends the basic operations provided by IdentifierUtil with additional operations those specific to DBIdentifiers and identifier conversion.
| Field Summary | |
|---|---|
static int |
ANY
|
static int |
COLUMN
|
static int |
SEQUENCE
|
static int |
TABLE
|
| Fields inherited from interface org.apache.openjpa.lib.identifier.IdentifierUtil |
|---|
BAR, CASE_LOWER, CASE_PRESERVE, CASE_UPPER, DOLLAR_CHAR, DOT, DOUBLE_QUOTE, EMPTY, PERCENT, SPACE, UNDERSCORE, UNDERSCORE_CHAR |
| Method Summary | |
|---|---|
DBIdentifier |
append(DBIdentifier.DBIdentifierType resultId,
DBIdentifier... names)
Appends multiple names together using the appropriate name delimiter. |
String |
appendColumns(Column[] columns)
Appends multiple columns names together into comma delimited string. |
String |
convertAlias(String alias)
Converts a provided alias to a format specified in the configuration. |
DBIdentifier |
convertSchemaCase(DBIdentifier schema)
Converts the name of the specified delimiter to the appropriate case as defined by the configuration. |
DBIdentifier |
fromDBName(String name,
DBIdentifier.DBIdentifierType id)
Converts the name returned by the database to an identifier of the specified type. |
DBIdentifier |
getGeneratedKeySequenceName(Column col,
int maxLen)
Returns a generated key sequence identifier for the column. |
DBIdentifier |
getValidColumnIdentifier(DBIdentifier name,
Table table,
int maxLen,
boolean checkForUniqueness)
Returns a valid column name/identifier, based upon the configuration and provided parameters. |
DBIdentifier |
getValidForeignKeyIdentifier(DBIdentifier name,
Table table,
Table toTable,
int maxLen)
Returns a valid foreign key identifier, based upon the configuration and provided parameters. |
DBIdentifier |
getValidIndexIdentifier(DBIdentifier name,
Table table,
int maxLen)
Returns a valid index identifier, based upon the configuration and provided parameters. |
DBIdentifier |
getValidSequenceIdentifier(DBIdentifier name,
Schema schema,
int maxLen)
Returns a valid index identifier, based upon the configuration and provided parameters. |
DBIdentifier |
getValidTableIdentifier(DBIdentifier name,
Schema schema,
int maxLen)
Returns a valid table identifier, based upon the configuration and provided parameters. |
DBIdentifier |
getValidUniqueIdentifier(DBIdentifier name,
Table table,
int maxLen)
Returns a valid unique constraint identifier, based upon the configuration and provided parameters. |
DBIdentifier |
makeIdentifierValid(DBIdentifier sname,
NameSet set,
int maxLen,
boolean checkForUniqueness)
Shortens the given name to the given maximum length, then checks that it is not a reserved word. |
DBIdentifier |
makeNameValid(String name,
NameSet set,
int maxLen,
int nameType,
boolean checkForUniqueness)
Shortens the given name to the given maximum length, then checks that it is not a reserved word. |
String |
toDBName(DBIdentifier name)
Converts the specified identifier to a format required by the database. |
String |
toDBName(DBIdentifier name,
boolean delimit)
Converts the specified identifier to a format required by the database, optionally delimiting the name. |
String |
toDBName(String name)
Converts the specified string to a format required by the database. |
String |
toDBName(String name,
boolean delimit)
Converts the specified string to a format required by the database, optionally delimiting the name. |
| Methods inherited from interface org.apache.openjpa.lib.identifier.IdentifierUtil |
|---|
appendNames, appendNames, canSplit, canSplit, canSplit, canSplit, combineNames, combineNames, combineNames, combineNames, combineNames, combineNames, convert, convertFull, delimit, delimit, delimit, delimit, getIdentifierConfiguration, isDelimited, isDelimited, isReservedWord, isReservedWord, joinNames, joinNames, joinNames, joinNames, joinNames, joinNames, removeDelimiters, removeDelimiters, removeDelimiters, removeHungarianNotation, removeHungarianNotation, requiresDelimiters, requiresDelimiters, setIdentifierConfiguration, splitName, splitName, splitName, splitName, truncateName, truncateName |
| Field Detail |
|---|
static final int ANY
static final int TABLE
static final int SEQUENCE
static final int COLUMN
| Method Detail |
|---|
DBIdentifier makeIdentifierValid(DBIdentifier sname,
NameSet set,
int maxLen,
boolean checkForUniqueness)
DBIdentifier makeNameValid(String name,
NameSet set,
int maxLen,
int nameType,
boolean checkForUniqueness)
DBIdentifier getValidColumnIdentifier(DBIdentifier name,
Table table,
int maxLen,
boolean checkForUniqueness)
name - table - maxLen - checkForUniqueness -
DBIdentifier getValidIndexIdentifier(DBIdentifier name,
Table table,
int maxLen)
name - table - maxLen - checkForUniqueness -
DBIdentifier getValidSequenceIdentifier(DBIdentifier name,
Schema schema,
int maxLen)
name - table - maxLen - checkForUniqueness -
DBIdentifier getValidTableIdentifier(DBIdentifier name,
Schema schema,
int maxLen)
name - schema - maxLen -
DBIdentifier getValidUniqueIdentifier(DBIdentifier name,
Table table,
int maxLen)
name - table - maxLen -
DBIdentifier getValidForeignKeyIdentifier(DBIdentifier name,
Table table,
Table toTable,
int maxLen)
name - table - toTable - maxLen -
String toDBName(DBIdentifier name)
name -
String toDBName(DBIdentifier name,
boolean delimit)
name - delimit -
String toDBName(String name)
name -
String toDBName(String name,
boolean delimit)
name -
DBIdentifier fromDBName(String name,
DBIdentifier.DBIdentifierType id)
name -
String appendColumns(Column[] columns)
columns -
DBIdentifier convertSchemaCase(DBIdentifier schema)
columns -
DBIdentifier append(DBIdentifier.DBIdentifierType resultId,
DBIdentifier... names)
resultId - names -
DBIdentifier getGeneratedKeySequenceName(Column col,
int maxLen)
col - maxLen -
String convertAlias(String alias)
alias -
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||