com.solarmetric.kodo.impl.jdbc.schema.dict
Class GenericDictionary

java.lang.Object
  |
  +--com.solarmetric.kodo.impl.jdbc.schema.dict.GenericDictionary

All Implemented Interfaces:

DBDictionary

Direct Known Subclasses:

CloudscapeDictionary, DB2Dictionary, HSQLDictionary, InstantDBDictionary, InterbaseDictionary, MySQLDictionary, OracleDictionary, PointbaseDictionary, PostgresDictionary, SQLServerDictionary, SybaseDictionary

public class GenericDictionary

extends Object

implements DBDictionary

Implementation of the DBDictionary interface for generic SQL.

Field Summary

protected static int	CENTI
protected static int	DECI
protected DBMetaData	meta
protected static int	MICRO
protected static int	MILLI
protected static int	NANO
static NumberFormat	NUMBER_FORMAT
protected static int	SEC

Constructor Summary

GenericDictionary()
Constructor.

Method Summary

BigDecimal	bigDecimalFromSQL(ResultSet rs, int column) Get the BigDecimal value of a particular column.
void	bigDecimalToPreparedParameter(PreparedStatement st, int index, BigDecimal val)
Object	bigDecimalToSQL(BigDecimal val)
BigInteger	bigIntegerFromSQL(ResultSet rs, int column)
void	bigIntegerToPreparedParameter(PreparedStatement st, int index, BigInteger val)
Object	bigIntegerToSQL(BigInteger val)
Object	blobFromSQL(ResultSet rs, int column)
void	blobToPreparedParameter(PreparedStatement st, int index, Object val)
Object	blobToSQL(Object val)
boolean	booleanFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
void	booleanToPreparedParameter(PreparedStatement st, int index, Boolean val)
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.
void	byteToPreparedParameter(PreparedStatement st, int index, Byte val)
Object	byteToSQL(byte val) Convert data into SQL for the current database platform.
void	characterToPreparedParameter(PreparedStatement st, int index, Character val)
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)
void	clobToPreparedParameter(PreparedStatement st, int index, String val)
Object	clobToSQL(Object val)
protected String	colsToString(String[] cols) Converts an array of column names to a comma-separated list of columns appropriate for use in a SELECT statement.
Date	dateFromSQL(ResultSet rs, int column)
void	dateToPreparedParameter(PreparedStatement st, int index, Date val)
Object	dateToSQL(Date val)
protected Timestamp	dateToTimestamp(Date val)
double	doubleFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
void	doubleToPreparedParameter(PreparedStatement st, int index, Double val)
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.
void	floatToPreparedParameter(PreparedStatement st, int index, Float val)
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.
String[]	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.
Class[]	getClassMappingCandidateClasses() Returns a list of possible ClassMapping classes for use with this DBDictionary.
protected String	getColumnDeclaration(Column column) This method can be overridden if the database does not support standard column declarations, which are in the form: <column-name> <sql-type> [NOT NULL].
ResultSet	getColumns(String tableName, Connection conn) Return a ResultSet with all the column names in the given table.
protected String	getCreateIndexSQL(Index index) Return the SQL to create an index.
String[]	getCreateTableSQL(Table table) Return a series of SQL statements to create the given table, including any indexes it has.
protected int	getDatePrecision() Return the precision to which dates are stored in this type of data store.
DBMetaData	getDBMetaData() Return the DBMetaData for this Dictionary.
String[]	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.
protected String	getDropIndexSQL(Index index) Return the SQL to drop an index.
String[]	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.
int	getMaxColumnNameLength()
int	getMaxIndexNameLength()
int	getMaxTableNameLength()
int	getNameTruncationVersion() Return the name truncation version to use.
String	getPlatform() Return the title of this database platform, used for display only.
boolean	getQuoteNumbers() Return whether number values should be quoted when being inserted.
String	getSchemaName() Return the schema to act on.
protected SQLTypeMap	getSQLTypeMap() Returns the type map setup in the setupSQLTypeMap(com.solarmetric.kodo.impl.jdbc.schema.dict.SQLTypeMap) method.
ResultSet	getTables(Connection conn) Return a ResultSet with all the tables in the database.
String	getValidColumnName(String name) Limits column names to getMaxTableNameLength()-1 plus an 'X' that is appended to the end of the given name to avoid SQL keyword conflicts.
String	getValidIndexName(String name) Limits index names to getMaxIndexNameLength()-1 plus an 'X' that is appended to the end of the given name to avoid SQL keyword conflicts.
String	getValidTableName(String name) Limits table names to getMaxTableNameLength()-1 plus an 'X' that is appended to the end of the given name to avoid SQL keyword conflicts.
int	intFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
void	intToPreparedParameter(PreparedStatement st, int index, Integer val)
Object	intToSQL(int val) Convert data into SQL for the current database platform.
Locale	localeFromSQL(ResultSet rs, int column)
void	localeToPreparedParameter(PreparedStatement st, int index, Locale val)
Object	localeToSQL(Locale val)
long	longFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
void	longToPreparedParameter(PreparedStatement st, int index, Long val)
Object	longToSQL(long val) Convert data into SQL for the current database platform.
Object	objectFromSQL(int type, ResultSet rs, int column) Catch-all responsible for converting any type not converted using one of the methods above.
void	objectToPreparedParameter(int type, PreparedStatement st, int index, Object val) Catch-all responsible for converting any type not converted using one of the methods above.
Object	objectToSQL(int type, Object val) Catch-all responsible for converting any type not converted using one of the methods above.
void	setDBMetaData(DBMetaData metadata) Set the DBMetaData for this dictionary.
void	setNameTruncationVersion(int version) Set the name truncation version to use.
void	setQuoteNumbers(boolean quoteNumbers) Sets whether number values should be quoted when being inserted.
void	setSchemaName(String schema) Set the schema to act on.
protected void	setupSQLTypeMap(SQLTypeMap map) This is the most commonly overridden method when porting to a new database.
short	shortFromSQL(ResultSet rs, int column) Convert the specified column of the SQL ResultSet to the proper java type.
void	shortToPreparedParameter(PreparedStatement st, int index, Short val)
Object	shortToSQL(short val) Convert data into SQL for the current database platform.
String	stringFromSQL(ResultSet rs, int column)
void	stringToPreparedParameter(PreparedStatement st, int index, String val)
String	stringToSQL(String string) Called from the toSQL method for Strings; by defualt escapes all single quote characters with another single quote.
protected String	tablesToString(String[] tables) Converts an array of table names to a comma-separated list of tables appropriate for use in a SELECT statement.
void	toPreparedParameter(int type, PreparedStatement st, int i, Object o) Set o as the i'th (base 1) element in st.
String	toSelect(String[] cols, String[] tables, String where, String order, boolean distinct, boolean update) Appends the given pieces using standard SQL.
String	toSelect(String cols, String tables, String where, String order, boolean distinct, boolean update) Deprecated. This method is no longer supported, and now throws an exception to that effect.
Object	toSQL(int type, Object val) Convert data into SQL for the current database platform.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NUMBER_FORMAT

public static final NumberFormat NUMBER_FORMAT

NANO

protected static final int NANO

MICRO

protected static final int MICRO

MILLI

protected static final int MILLI

CENTI

protected static final int CENTI

DECI

protected static final int DECI

SEC

protected static final int SEC

meta

protected DBMetaData meta

Constructor Detail

GenericDictionary

public GenericDictionary()

Constructor. Initializes mapping of DBDictionary constants to SQL types through the {#link setupSQLTypeMap} method.

Method Detail

setDBMetaData

public void setDBMetaData(DBMetaData metadata)

Description copied from interface: DBDictionary

Set the DBMetaData for this dictionary.

Specified by:

setDBMetaData in interface DBDictionary

toString

public String toString()

Overrides:

toString in class Object

getDBMetaData

public DBMetaData getDBMetaData()

Return the DBMetaData for this Dictionary.

Specified by:

getDBMetaData in interface DBDictionary

getSchemaName

public String getSchemaName()

Return the schema to act on.

setSchemaName

public void setSchemaName(String schema)

Set the schema to act on.

getNameTruncationVersion

public int getNameTruncationVersion()

Return the name truncation version to use.

setNameTruncationVersion

public void setNameTruncationVersion(int version)

Set the name truncation version to use.

getPlatform

public String getPlatform()

Return the title of this database platform, used for display only.

Specified by:

getPlatform in interface DBDictionary

getQuoteNumbers

public boolean getQuoteNumbers()

Return whether number values should be quoted when being inserted.

setQuoteNumbers

public void setQuoteNumbers(boolean quoteNumbers)

Sets whether number values should be quoted when being inserted. Some databases store perfect precision when number values are quoted.

toSQL

public final Object toSQL(int type,
                          Object val)

Description copied from interface: DBDictionary

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

Specified by:

toSQL in interface DBDictionary

stringToSQL

public String stringToSQL(String string)

Called from the toSQL method for Strings; by defualt escapes all single quote characters with another single quote.

dateToSQL

public Object dateToSQL(Date val)

dateToTimestamp

protected Timestamp dateToTimestamp(Date val)

booleanToSQL

public Object booleanToSQL(boolean val)

Description copied from interface: DBDictionary

Convert data into SQL for the current database platform.

Specified by:

booleanToSQL in interface DBDictionary

byteToSQL

public Object byteToSQL(byte val)

Description copied from interface: DBDictionary

Convert data into SQL for the current database platform.

Specified by:

byteToSQL in interface DBDictionary

charToSQL

public Object charToSQL(char val)

Description copied from interface: DBDictionary

Convert data into SQL for the current database platform.

Specified by:

charToSQL in interface DBDictionary

doubleToSQL

public Object doubleToSQL(double val)

Description copied from interface: DBDictionary

Convert data into SQL for the current database platform.

Specified by:

doubleToSQL in interface DBDictionary

floatToSQL

public Object floatToSQL(float val)

Description copied from interface: DBDictionary

Convert data into SQL for the current database platform.

Specified by:

floatToSQL in interface DBDictionary

intToSQL

public Object intToSQL(int val)

Description copied from interface: DBDictionary

Convert data into SQL for the current database platform.

Specified by:

intToSQL in interface DBDictionary

longToSQL

public Object longToSQL(long val)

Description copied from interface: DBDictionary

Convert data into SQL for the current database platform.

Specified by:

longToSQL in interface DBDictionary

shortToSQL

public Object shortToSQL(short val)

Description copied from interface: DBDictionary

Convert data into SQL for the current database platform.

Specified by:

shortToSQL in interface DBDictionary

localeToSQL

public Object localeToSQL(Locale val)

blobToSQL

public Object blobToSQL(Object val)

clobToSQL

public Object clobToSQL(Object val)

bigIntegerToSQL

public Object bigIntegerToSQL(BigInteger val)

bigDecimalToSQL

public Object bigDecimalToSQL(BigDecimal val)

objectToSQL

public Object objectToSQL(int type,
                          Object val)

Catch-all responsible for converting any type not converted using one of the methods above. This will become more important when we migrate to java.sql.Types instead of SQLTypes.

fromSQL

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

Description copied from interface: DBDictionary

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

Specified by:

fromSQL in interface DBDictionary

booleanFromSQL

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

Description copied from interface: DBDictionary

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

Specified by:

booleanFromSQL in interface DBDictionary

byteFromSQL

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

Description copied from interface: DBDictionary

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

Specified by:

byteFromSQL in interface DBDictionary

charFromSQL

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

Description copied from interface: DBDictionary

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

Specified by:

charFromSQL in interface DBDictionary

doubleFromSQL

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

Description copied from interface: DBDictionary

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

Specified by:

doubleFromSQL in interface DBDictionary

floatFromSQL

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

Description copied from interface: DBDictionary

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

Specified by:

floatFromSQL in interface DBDictionary

intFromSQL

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

Description copied from interface: DBDictionary

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

Specified by:

intFromSQL in interface DBDictionary

longFromSQL

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

Description copied from interface: DBDictionary

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

Specified by:

longFromSQL in interface DBDictionary

shortFromSQL

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

Description copied from interface: DBDictionary

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

Specified by:

shortFromSQL in interface DBDictionary

bigDecimalFromSQL

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

Get the BigDecimal value of a particular column. We need to check for the JDBC driver version, since getBigDecimal(column) only exists in JDBC2, whereas JDBC 1 has getBigDecimal(column,scale).

bigIntegerFromSQL

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

stringFromSQL

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

localeFromSQL

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

clobFromSQL

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

blobFromSQL

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

dateFromSQL

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

objectFromSQL

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

Catch-all responsible for converting any type not converted using one of the methods above. This will become more important when we migrate to java.sql.Types instead of SQLTypes.

toPreparedParameter

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

Set o as the i'th (base 1) element in st.

Specified by:

toPreparedParameter in interface DBDictionary

stringToPreparedParameter

public void stringToPreparedParameter(PreparedStatement st,
                                      int index,
                                      String val)
                               throws SQLException

dateToPreparedParameter

public void dateToPreparedParameter(PreparedStatement st,
                                    int index,
                                    Date val)
                             throws SQLException

booleanToPreparedParameter

public void booleanToPreparedParameter(PreparedStatement st,
                                       int index,
                                       Boolean val)
                                throws SQLException

byteToPreparedParameter

public void byteToPreparedParameter(PreparedStatement st,
                                    int index,
                                    Byte val)
                             throws SQLException

characterToPreparedParameter

public void characterToPreparedParameter(PreparedStatement st,
                                         int index,
                                         Character val)
                                  throws SQLException

doubleToPreparedParameter

public void doubleToPreparedParameter(PreparedStatement st,
                                      int index,
                                      Double val)
                               throws SQLException

floatToPreparedParameter

public void floatToPreparedParameter(PreparedStatement st,
                                     int index,
                                     Float val)
                              throws SQLException

intToPreparedParameter

public void intToPreparedParameter(PreparedStatement st,
                                   int index,
                                   Integer val)
                            throws SQLException

longToPreparedParameter

public void longToPreparedParameter(PreparedStatement st,
                                    int index,
                                    Long val)
                             throws SQLException

shortToPreparedParameter

public void shortToPreparedParameter(PreparedStatement st,
                                     int index,
                                     Short val)
                              throws SQLException

bigIntegerToPreparedParameter

public void bigIntegerToPreparedParameter(PreparedStatement st,
                                          int index,
                                          BigInteger val)
                                   throws SQLException

bigDecimalToPreparedParameter

public void bigDecimalToPreparedParameter(PreparedStatement st,
                                          int index,
                                          BigDecimal val)
                                   throws SQLException

localeToPreparedParameter

public void localeToPreparedParameter(PreparedStatement st,
                                      int index,
                                      Locale val)
                               throws SQLException

blobToPreparedParameter

public void blobToPreparedParameter(PreparedStatement st,
                                    int index,
                                    Object val)
                             throws SQLException

clobToPreparedParameter

public void clobToPreparedParameter(PreparedStatement st,
                                    int index,
                                    String val)
                             throws SQLException

objectToPreparedParameter

public void objectToPreparedParameter(int type,
                                      PreparedStatement st,
                                      int index,
                                      Object val)
                               throws SQLException

Catch-all responsible for converting any type not converted using one of the methods above. This will become more important when we migrate to java.sql.Types instead of SQLTypes.

toSelect

public final String toSelect(String cols,
                             String tables,
                             String where,
                             String order,
                             boolean distinct,
                             boolean update)

Deprecated. This method is no longer supported, and now throws an exception to that effect.

toSelect

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

Appends the given pieces using standard SQL.

Specified by:

toSelect in interface DBDictionary

Following copied from interface: com.solarmetric.kodo.impl.jdbc.schema.DBDictionary

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

colsToString

protected String colsToString(String[] cols)

Converts an array of column names to a comma-separated list of columns appropriate for use in a SELECT statement.

tablesToString

protected String tablesToString(String[] tables)

Converts an array of table names to a comma-separated list of tables appropriate for use in a SELECT statement.

getValidTableName

public String getValidTableName(String name)

Limits table names to getMaxTableNameLength()-1 plus an 'X' that is appended to the end of the given name to avoid SQL keyword conflicts.

Specified by:

getValidTableName in interface DBDictionary

getValidColumnName

public String getValidColumnName(String name)

Limits column names to getMaxTableNameLength()-1 plus an 'X' that is appended to the end of the given name to avoid SQL keyword conflicts.

Specified by:

getValidColumnName in interface DBDictionary

getValidIndexName

public String getValidIndexName(String name)

Limits index names to getMaxIndexNameLength()-1 plus an 'X' that is appended to the end of the given name to avoid SQL keyword conflicts.

Specified by:

getValidIndexName in interface DBDictionary

getMaxTableNameLength

public int getMaxTableNameLength()

Returns:

The maximum length of table names allowed in this database. Defaults to 30.

getMaxColumnNameLength

public int getMaxColumnNameLength()

Returns:

The maximum length of column names allowed in this database. Defaults to 30.

getMaxIndexNameLength

public int getMaxIndexNameLength()

Returns:

The maximum length of index names allowed in this database. Defaults to 30.

getCreateTableSQL

public String[] getCreateTableSQL(Table table)

Description copied from interface: DBDictionary

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

Specified by:

getCreateTableSQL in interface DBDictionary

getDropTableSQL

public String[] getDropTableSQL(Table table)

Description copied from interface: DBDictionary

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

Specified by:

getDropTableSQL in interface DBDictionary

getAddColumnSQL

public String[] getAddColumnSQL(Column column)

Description copied from interface: DBDictionary

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

Specified by:

getAddColumnSQL in interface DBDictionary

getDropColumnSQL

public String[] getDropColumnSQL(Column column)

Description copied from interface: DBDictionary

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

Specified by:

getDropColumnSQL in interface DBDictionary

getCreateIndexSQL

protected String getCreateIndexSQL(Index index)

Return the SQL to create an index. Defaults to: CREATE INDEX <index-name> ON <table-name> ( <column-name>)

getDropIndexSQL

protected String getDropIndexSQL(Index index)

Return the SQL to drop an index. Defaults to: DROP INDEX <index-name>

getColumnDeclaration

protected String getColumnDeclaration(Column column)

This method can be overridden if the database does not support standard column declarations, which are in the form: <column-name> <sql-type> [NOT NULL]. Where NOT NULL is appended if it is a primary key column.

getSQLTypeMap

protected SQLTypeMap getSQLTypeMap()

Returns the type map setup in the setupSQLTypeMap(com.solarmetric.kodo.impl.jdbc.schema.dict.SQLTypeMap) method.

setupSQLTypeMap

protected void setupSQLTypeMap(SQLTypeMap map)

This is the most commonly overridden method when porting to a new database. Most databases have different mappings between java and SQL types; this method can be used to setup the mappings for the database being ported.

getDatePrecision

protected int getDatePrecision()

Return the precision to which dates are stored in this type of data store. Returns MILLI by default, as java.util.Date is only precise to the nearest millisecond. This value is used when generating timestamps to store in the data store. It is important that we never generate SQL data with greater precision than what will be returned to us, as otherwise we can get into awkward situations in which we cannot use retrieved values in where clauses since the data is not sufficiently precise. SQLServer behaves strangely here. It returns values whose millis are not accurate, but allows SELECT, DELETE statements using these non-accurate milli values. It must perform some internal rounding. Oracle, MySQL return values precise to the second on select, but will select/delete all values in a particular second, not just those values with exactly 0 nanos.

getTables

public ResultSet getTables(Connection conn)
                    throws SQLException

Description copied from interface: DBDictionary

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

Specified by:

getTables in interface DBDictionary

getColumns

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

Description copied from interface: DBDictionary

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

Specified by:

getColumns in interface DBDictionary

getClassMappingCandidateClasses

public Class[] getClassMappingCandidateClasses()

Description copied from interface: DBDictionary

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

Specified by:

getClassMappingCandidateClasses in interface DBDictionary

getFieldMappingCandidateClasses

public Class[] getFieldMappingCandidateClasses()

Description copied from interface: DBDictionary

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

Specified by:

getFieldMappingCandidateClasses in interface DBDictionary