org.apache.empire.dbms.sqlite

Class DBMSHandlerSQLite

java.lang.Object

org.apache.empire.dbms.DBMSHandlerBase

org.apache.empire.dbms.sqlite.DBMSHandlerSQLite

All Implemented Interfaces:

DBMSHandler

public class DBMSHandlerSQLite
extends DBMSHandlerBase

This class provides support for the SQLite database system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DBMSHandlerSQLite.DBCommandSQLite Defines the SQLite command type.

Nested classes/interfaces inherited from class org.apache.empire.dbms.DBMSHandlerBase

DBMSHandlerBase.DBMSCommand, DBMSHandlerBase.DBSeqTable

Nested classes/interfaces inherited from interface org.apache.empire.dbms.DBMSHandler

DBMSHandler.DBSetGenKeys

Field Summary

Fields inherited from class org.apache.empire.dbms.DBMSHandlerBase

GENERAL_SQL_KEYWORDS, ILLEGAL_NAME_CHARS, reservedSQLKeywords, SEQUENCE_NAME_SUFFIX

Constructor Summary

Constructors

Constructor and Description
DBMSHandlerSQLite() Constructor for the SQLite database dbms.

Method Summary

Modifier and Type	Method and Description
DBCommand	createCommand(boolean autoPrepareStmt) Creates a new SQLite command object.
int	executeSQL(String sqlCmd, Object[] sqlParams, Connection conn, DBMSHandler.DBSetGenKeys genKeys) Override since conn.prepareStatement(sqlCmd, Statement.RETURN_GENERATED_KEYS) is not supported by SQLLite dbms
String	getConvertPhrase(DataType destType, DataType srcType, Object format) Returns a data type convertion phrase template for this dbms The returned template must contain a '?'
void	getDDLScript(DBDDLGenerator.DDLActionType type, DBObject dbo, DBSQLScript script) Appends the required DLL commands to create, drop or alter an object to the supplied DBDQLScript.
Object	getNextSequenceValue(DBDatabase db, String SeqName, int minValue, Connection conn) Returns the next value of a named sequence The numbers are used for fields of type DBExpr.DT_AUTOINC.
DBColumnExpr	getNextSequenceValueExpr(DBTableColumn column) Returns an expression for creating a sequence value.
Object	getResultValue(ResultSet rset, int columnIndex, DataType dataType) Reads a single column value from the given JDBC ResultSet and returns a value object of desired data type.
String	getSQLPhrase(DBSqlPhrase phrase) Gets an sql phrase template for this database system.
Timestamp	getUpdateTimestamp(Connection conn) Overridden.
boolean	isSupported(DBMSFeature type) Returns whether or not a particular feature is supported by this dbms

Methods inherited from class org.apache.empire.dbms.DBMSHandlerBase

addStatementParam, appendEnableRelationStmt, appendObjectName, appendSQLTextValue, attachDatabase, checkExists, closeResultSet, closeStatement, createCombinedCommand, createModelChecker, createModelParser, detachDatabase, detectQuoteName, executeBatch, executeQuery, extractErrorMessage, getColumnAutoValue, getColumnSequenceName, getSQLDateTimeString, getSQLNumberString, getSQLTextString, getValueString, prepareStatement, querySingleValue, stringToBoolean

Methods inherited from class java.lang.Object

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

Constructor Detail

DBMSHandlerSQLite

public DBMSHandlerSQLite()

Constructor for the SQLite database dbms.

Method Detail

createCommand

public DBCommand createCommand(boolean autoPrepareStmt)

Creates a new SQLite command object.

Specified by:

createCommand in interface DBMSHandler

Overrides:

createCommand in class DBMSHandlerBase

Parameters:

autoPrepareStmt - whether or not the Command should automatically generate a prepared statement (using ?)

Returns:

the new DBCommandSQLite object

isSupported

public boolean isSupported(DBMSFeature type)

Returns whether or not a particular feature is supported by this dbms

Specified by:

isSupported in interface DBMSHandler

Specified by:

isSupported in class DBMSHandlerBase

Parameters:

type - type of requested feature. @see DBMSFeature

Returns:

true if the features is supported or false otherwise

getSQLPhrase

public String getSQLPhrase(DBSqlPhrase phrase)

Gets an sql phrase template for this database system.

Parameters:

phrase - the identifier of the phrase

Returns:

the phrase template

See Also:

DBMSHandler#getSQLPhrase(int)

getConvertPhrase

public String getConvertPhrase(DataType destType,
                               DataType srcType,
                               Object format)

Description copied from interface: DBMSHandler

Returns a data type convertion phrase template for this dbms
The returned template must contain a '?' which will be replaced by a column expression.

Parameters:

destType - the target data type

srcType - the source data type

format - additional formatting information (optional)

Returns:

the data conversion phrase template

See Also:

DBMSHandler.getConvertPhrase(DataType, DataType, Object)

executeSQL

public int executeSQL(String sqlCmd,
                      Object[] sqlParams,
                      Connection conn,
                      DBMSHandler.DBSetGenKeys genKeys)
               throws SQLException

Override since conn.prepareStatement(sqlCmd, Statement.RETURN_GENERATED_KEYS) is not supported by SQLLite dbms

Specified by:

executeSQL in interface DBMSHandler

Overrides:

executeSQL in class DBMSHandlerBase

Parameters:

sqlCmd - the SQL-Command

sqlParams - array of sql command parameters used for prepared statements (Optional).

conn - a valid connection to the database.

genKeys - allows to set the auto generated key of a record (INSERT statements only)

Returns:

the row count for insert, update or delete or 0 for SQL statements that return nothing

Throws:

SQLException - if a database access error occurs

getResultValue

public Object getResultValue(ResultSet rset,
                             int columnIndex,
                             DataType dataType)
                      throws SQLException

Description copied from class: DBMSHandlerBase

Reads a single column value from the given JDBC ResultSet and returns a value object of desired data type.
See DBExpr#getValueClass(DataType) for java class type mapping.

This gives the dbms the opportunity to change the value i.e. to simulate missing data types with other types.

Specified by:

getResultValue in interface DBMSHandler

Overrides:

getResultValue in class DBMSHandlerBase

Parameters:

rset - the sql Resultset with the current data row

columnIndex - one based column Index of the desired column

dataType - the required data type

Returns:

the value of the Column

Throws:

SQLException - if a database access error occurs

getUpdateTimestamp

public Timestamp getUpdateTimestamp(Connection conn)

Overridden. Returns a timestamp that is used for record updates created by the database server.

Specified by:

getUpdateTimestamp in interface DBMSHandler

Overrides:

getUpdateTimestamp in class DBMSHandlerBase

Parameters:

conn - the connection that might be used

Returns:

the current date and time of the database server.

getDDLScript

public void getDDLScript(DBDDLGenerator.DDLActionType type,
                         DBObject dbo,
                         DBSQLScript script)

Description copied from interface: DBMSHandler

Appends the required DLL commands to create, drop or alter an object to the supplied DBDQLScript.

Parameters:

type - operation to perform (CREATE, DROP, ALTER)

dbo - the object for which to perform the operation (DBDatabase, DBTable, DBView, DBColumn, DBRelation)

script - the script to which to add the DDL command(s)

See Also:

DBMSHandler#getDDLScript(DDLActionType, DBObject, DBSQLScript)

getNextSequenceValue

public Object getNextSequenceValue(DBDatabase db,
                                   String SeqName,
                                   int minValue,
                                   Connection conn)

Description copied from class: DBMSHandlerBase

Returns the next value of a named sequence The numbers are used for fields of type DBExpr.DT_AUTOINC.
If a dbms supports this function it must return true for isSupported(DBMSFeature.SEQUENCES).

Specified by:

getNextSequenceValue in class DBMSHandlerBase

Parameters:

db - the database

SeqName - the name of the sequence

minValue - the minimum value of the sequence

conn - a valid database connection

Returns:

a new unique sequence value or null if an error occurred

getNextSequenceValueExpr

public DBColumnExpr getNextSequenceValueExpr(DBTableColumn column)

Description copied from class: DBMSHandlerBase

Returns an expression for creating a sequence value. This is intended for the use with INSERT INTO statements where many records are affected.

Specified by:

getNextSequenceValueExpr in class DBMSHandlerBase

Returns:

an expression for the next sequence value

See Also:

DBMSHandler#getNextSequenceValueExpr(DBTableColumn col)