com.solarmetric.kodo.impl.jdbc.schema
Interface DBDictionary

All Known Implementing Classes:

AbstractDictionary

public interface DBDictionary

Interface which allows the creation of SQL dynamically, in a database agnostic fashion.

Method Summary

BigDecimal	bigDecimalFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
Object	bigDecimalToSQL(BigDecimal val) Convert data into SQL for the current database platform.
BigInteger	bigIntegerFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
Object	bigIntegerToSQL(BigInteger val) Convert data into SQL for the current database platform.
Object	blobFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
Object	blobToSQL(Object val) Convert data into SQL for the current database platform.
boolean	booleanFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
Object	booleanToSQL(boolean val) Convert data into SQL for the current database platform.
byte	byteFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
Object	byteToSQL(byte val) Convert data into SQL for the current database platform.
char	charFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
Object	charToSQL(char val) Convert data into SQL for the current database platform.
String	clobFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
Object	clobToSQL(Object val) Convert data into SQL for the current database platform.
void	createdSQLExecutionManager(SQLExecutionManager manager) Perform any necessary configuration of the newly created SQLExecutionManager.
Date	dateFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
Object	dateToSQL(Date val) Convert data into SQL for the current database platform.
double	doubleFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
Object	doubleToSQL(double val) Convert data into SQL for the current database platform.
float	floatFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
Object	floatToSQL(float val) Convert data into SQL for the current database platform.
Object	fromSQL(int type, ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
SQLBuffer[]	getAddColumnSQL(Column column) Return a series of SQL statements to add the given column to its table, including the addition of any indexes on the column.
ResultSet	getColumns(String tableName, Connection conn) Return a ResultSet with all the column names in the given table.
SQLBuffer[]	getCreateTableSQL(Table table) Return a series of SQL statements to create the given table, including any indexes it has.
DBMetaData	getDBMetaData() Get the DBMetaData for this dictionary.
SQLBuffer[]	getDropColumnSQL(Column column) Return a series of SQL statements to drop the given column from its table, including the deletion of any indices from the column.
SQLBuffer[]	getDropTableSQL(Table table) Return a series of SQL statements to drop the given table, including any indexes it may have.
Class[]	getFieldMappingCandidateClasses() Returns a list of possible FieldMapping classes for use with this DBDictionary.
long	getNextAutoIncrementValue(Table table, SQLExecutionManager sqlem) Returns the next auto-increment value for a given table.
String	getNonSQL92LeftOuterJoin(String fromTableAlias, Column[] fromCols, String toTableAlias, Column[] toCols) Return the SQL to join the given columns together with a left outer join.
String	getPlatform() Return the name of the platform for the DB type handled; for example, Oracle
ResultSet	getTables(Connection conn) Return a ResultSet with all the tables in the database.
String	getValidColumnName(String name) Make any necessary changes to the given column name to make it valid for the current DB.
String	getValidIndexName(String name) Make any necessary changes to the given index name to make it valid for the current DB.
String	getValidTableName(String name) Make any necessary changes to the given table name to make it valid for the current DB.
int	intFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
Object	intToSQL(int val) Convert data into SQL for the current database platform.
boolean	isClosed(Connection conn) Some JDBC drivers do not validate the state of the Connection when Connection.isClosed() is invoked.
Locale	localeFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
long	longFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
Object	longToSQL(long val) Convert data into SQL for the current database platform.
Object	objectFromSQL(int type, ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
Object	objectToSQL(int type, Object val) Convert data into SQL for the current database platform.
PreparedStatement	prepareStatement(Connection conn, SQLBuffer buffer, SQLExecutionManager manager, int type, int concur) Create a new PreparedStatement for the specified Connection with the SQL in the SQLBuffer.
void	setColumnNameGenerator(NameGenerator generator) Set the NameGenerator to use for generating column names.
void	setDBMetaData(DBMetaData meta) Set the DBMetaData for this dictionary.
void	setIndexNameGenerator(NameGenerator generator) Set the NameGenerator to use for generating index names.
void	setTableNameGenerator(NameGenerator generator) Set the NameGenerator to use for generating table names.
void	setTransactionIsolation(Connection conn, JDBCConfiguration config) Setup the transaction isolation level on the Connection.
short	shortFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
Object	shortToSQL(short val) Convert data into SQL for the current database platform.
String	stringFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
String	stringToSQL(String val) Convert data into SQL for the current database platform.
boolean	supportsAutoIncrement() Returns true if this dictionary / database combination supports auto-incrementing primary-key columns.
boolean	supportsLocking() Returns whether or not this database supports locking (e.g., FOR UPDATE clause in SELECT).
boolean	supportsNonSQL92LeftOuterJoins() Return true if this database supports a non-SQL92 style of left outer joins.
boolean	supportsUpdateCountsForBatch() Returns true if the JDBC driver supports correct update counts in the return value from Statement.executeBatch().
void	toPreparedParameter(int type, PreparedStatement st, int i, Object val) Set val as the i'th (base 1) element in st.
SQLBuffer	toSelect(String[] cols, String[] tables, SQLBuffer where, SQLBuffer order, boolean distinct, boolean update) Create a SELECT statement for this databse from the given parts.
Object	toSQL(int type, Object obj) Convert data into SQL for the current database platform.
void	validateConfiguration(JDBCConfiguration config, DBMetaData meta) Allow the dictionary to perform any validations of the configuration parameters.

Method Detail

getDBMetaData

public DBMetaData getDBMetaData()

Get the DBMetaData for this dictionary.

setDBMetaData

public void setDBMetaData(DBMetaData meta)

Set the DBMetaData for this dictionary.

isClosed

public boolean isClosed(Connection conn)

Some JDBC drivers do not validate the state of the Connection when Connection.isClosed() is invoked. This method will issue a small SQL statement to validate that the Connection is actually in a usable state.

Returns:

true if the Connection is not valid

getPlatform

public String getPlatform()

Return the name of the platform for the DB type handled; for example, Oracle

toSQL

public Object toSQL(int type,
                    Object obj)

Convert data into SQL for the current database platform. The given type constant will be from the constants of SQLTypes.

booleanToSQL

public Object booleanToSQL(boolean val)

Convert data into SQL for the current database platform.

byteToSQL

public Object byteToSQL(byte val)

Convert data into SQL for the current database platform.

charToSQL

public Object charToSQL(char val)

Convert data into SQL for the current database platform.

doubleToSQL

public Object doubleToSQL(double val)

Convert data into SQL for the current database platform.

floatToSQL

public Object floatToSQL(float val)

Convert data into SQL for the current database platform.

intToSQL

public Object intToSQL(int val)

Convert data into SQL for the current database platform.

longToSQL

public Object longToSQL(long val)

Convert data into SQL for the current database platform.

shortToSQL

public Object shortToSQL(short val)

Convert data into SQL for the current database platform.

bigDecimalToSQL

public Object bigDecimalToSQL(BigDecimal val)

Convert data into SQL for the current database platform.

bigIntegerToSQL

public Object bigIntegerToSQL(BigInteger val)

Convert data into SQL for the current database platform.

stringToSQL

public String stringToSQL(String val)

Convert data into SQL for the current database platform.

dateToSQL

public Object dateToSQL(Date val)

Convert data into SQL for the current database platform.

clobToSQL

public Object clobToSQL(Object val)

Convert data into SQL for the current database platform.

blobToSQL

public Object blobToSQL(Object val)

Convert data into SQL for the current database platform.

objectToSQL

public Object objectToSQL(int type,
                          Object val)

Convert data into SQL for the current database platform.

fromSQL

public Object fromSQL(int type,
                      ResultSet rs,
                      int column)
               throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type. The type will be from the constants of SQLTypes.

booleanFromSQL

public boolean booleanFromSQL(ResultSet rs,
                              int column)
                       throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type.

byteFromSQL

public byte byteFromSQL(ResultSet rs,
                        int column)
                 throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type.

charFromSQL

public char charFromSQL(ResultSet rs,
                        int column)
                 throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type.

doubleFromSQL

public double doubleFromSQL(ResultSet rs,
                            int column)
                     throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type.

floatFromSQL

public float floatFromSQL(ResultSet rs,
                          int column)
                   throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type.

intFromSQL

public int intFromSQL(ResultSet rs,
                      int column)
               throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type.

longFromSQL

public long longFromSQL(ResultSet rs,
                        int column)
                 throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type.

shortFromSQL

public short shortFromSQL(ResultSet rs,
                          int column)
                   throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type.

bigDecimalFromSQL

public BigDecimal bigDecimalFromSQL(ResultSet rs,
                                    int column)
                             throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type.

bigIntegerFromSQL

public BigInteger bigIntegerFromSQL(ResultSet rs,
                                    int column)
                             throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type.

stringFromSQL

public String stringFromSQL(ResultSet rs,
                            int column)
                     throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type.

dateFromSQL

public Date dateFromSQL(ResultSet rs,
                        int column)
                 throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type.

localeFromSQL

public Locale localeFromSQL(ResultSet rs,
                            int column)
                     throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type.

clobFromSQL

public String clobFromSQL(ResultSet rs,
                          int column)
                   throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type.

blobFromSQL

public Object blobFromSQL(ResultSet rs,
                          int column)
                   throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type.

objectFromSQL

public Object objectFromSQL(int type,
                            ResultSet rs,
                            int column)
                     throws SQLException

Convert the specified column of the SQL ResultSet to the proper java type.

toPreparedParameter

public void toPreparedParameter(int type,
                                PreparedStatement st,
                                int i,
                                Object val)
                         throws SQLException

Set val as the i'th (base 1) element in st. The given type will be from SQLTypes.

supportsNonSQL92LeftOuterJoins

public boolean supportsNonSQL92LeftOuterJoins()

Return true if this database supports a non-SQL92 style of left outer joins.

getNonSQL92LeftOuterJoin

public String getNonSQL92LeftOuterJoin(String fromTableAlias,
                                       Column[] fromCols,
                                       String toTableAlias,
                                       Column[] toCols)

Return the SQL to join the given columns together with a left outer join. Column names in the returned SQL should be of the form <table alias>.<column name>. This method is only used for dictionaries that return true from supportsNonSQL92LeftOuterJoins().

toSelect

public SQLBuffer toSelect(String[] cols,
                          String[] tables,
                          SQLBuffer where,
                          SQLBuffer order,
                          boolean distinct,
                          boolean update)

Create a SELECT statement for this databse from the given parts. Many databases use alternate syntaxes for complex queries; this method can be used to create a query from its basic parts.

Parameters:

cols - list of values the columns to select

tables - list of the tables to select from

where - the WHERE conditions; may be null if none

order - the ORDER BY conditions; may be null if none

distinct - if true, this should be a SELECT DISTINCT-equivalent query

update - if true this should be a SELECT FOR UPDATE-equivalent query

getValidTableName

public String getValidTableName(String name)

Make any necessary changes to the given table name to make it valid for the current DB.

getValidColumnName

public String getValidColumnName(String name)

Make any necessary changes to the given column name to make it valid for the current DB.

getValidIndexName

public String getValidIndexName(String name)

Make any necessary changes to the given index name to make it valid for the current DB.

getCreateTableSQL

public SQLBuffer[] getCreateTableSQL(Table table)

Return a series of SQL statements to create the given table, including any indexes it has.

getDropTableSQL

public SQLBuffer[] getDropTableSQL(Table table)

Return a series of SQL statements to drop the given table, including any indexes it may have.

getAddColumnSQL

public SQLBuffer[] getAddColumnSQL(Column column)

Return a series of SQL statements to add the given column to its table, including the addition of any indexes on the column.

getDropColumnSQL

public SQLBuffer[] getDropColumnSQL(Column column)

Return a series of SQL statements to drop the given column from its table, including the deletion of any indices from the column.

getTables

public ResultSet getTables(Connection conn)
                    throws SQLException

Return a ResultSet with all the tables in the database. Used when determining what tables need to be updated during schema manipulation.

getColumns

public ResultSet getColumns(String tableName,
                            Connection conn)
                     throws SQLException

Return a ResultSet with all the column names in the given table. Used when determining what tables need to be updated during schema manipulation. This is typically just a result of a DatabaseMetaData.getColumns(String,String,String,String) invocation, but the actual dictionary can choose to implement this however they like, provided that the ResultSet that is returned contains the following columns:

• TABLE_NAME
• COLUMN_NAME

getFieldMappingCandidateClasses

public Class[] getFieldMappingCandidateClasses()

Returns a list of possible FieldMapping classes for use with this DBDictionary.

supportsLocking

public boolean supportsLocking()

Returns whether or not this database supports locking (e.g., FOR UPDATE clause in SELECT).

setIndexNameGenerator

public void setIndexNameGenerator(NameGenerator generator)

Set the NameGenerator to use for generating index names.

setColumnNameGenerator

public void setColumnNameGenerator(NameGenerator generator)

Set the NameGenerator to use for generating column names.

setTableNameGenerator

public void setTableNameGenerator(NameGenerator generator)

Set the NameGenerator to use for generating table names.

supportsUpdateCountsForBatch

public boolean supportsUpdateCountsForBatch()

Returns true if the JDBC driver supports correct update counts in the return value from Statement.executeBatch().

setTransactionIsolation

public void setTransactionIsolation(Connection conn,
                                    JDBCConfiguration config)
                             throws SQLException

Setup the transaction isolation level on the Connection. This will typically use the value of JDBCConfiguration.getTransactionIsolationLevel(), but the dictionary implementation retains the option of overriding the default transaction level.

Since:

2.4.1

createdSQLExecutionManager

public void createdSQLExecutionManager(SQLExecutionManager manager)

Perform any necessary configuration of the newly created SQLExecutionManager. Typically, this involves installing database-specific SQLExecutionListeners.

Since:

2.5.0

supportsAutoIncrement

public boolean supportsAutoIncrement()

Returns true if this dictionary / database combination supports auto-incrementing primary-key columns.

Since:

2.5.0

getNextAutoIncrementValue

public long getNextAutoIncrementValue(Table table,
                                      SQLExecutionManager sqlem)
                               throws SQLException

Returns the next auto-increment value for a given table.

Since:

2.5.0

prepareStatement

public PreparedStatement prepareStatement(Connection conn,
                                          SQLBuffer buffer,
                                          SQLExecutionManager manager,
                                          int type,
                                          int concur)
                                   throws SQLException

Create a new PreparedStatement for the specified Connection with the SQL in the SQLBuffer.

Returns:

the newly prepared statement

Since:

2.5.0

validateConfiguration

public void validateConfiguration(JDBCConfiguration config,
                                  DBMetaData meta)

Allow the dictionary to perform any validations of the configuration parameters.

Since:

2.5.0