Package org.apache.empire.dbms.hsql

Class DBMSHandlerHSql

java.lang.Object

org.apache.empire.dbms.DBMSHandlerBase

org.apache.empire.dbms.hsql.DBMSHandlerHSql

All Implemented Interfaces:

DBMSHandler

public class DBMSHandlerHSql
extends DBMSHandlerBase

This class provides support for the HSQLDB database system.

Nested Class Summary

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

DBMSHandlerBase.DBMSBuilder, DBMSHandlerBase.DBMSCommand, DBMSHandlerBase.DBSeqTable

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

DBMSHandler.DBSetGenKeys

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String[]	HSQL_KEYWORDS

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

GENERAL_SQL_KEYWORDS, ILLEGAL_NAME_CHARS, reservedSQLKeywords, SEQUENCE_NAME_SUFFIX

Constructor Summary

Constructors

Constructor	Description
DBMSHandlerHSql()	Constructor for the HSQLDB database dbms.

Method Summary

Modifier and Type	Method	Description
DBCommand	createCommand(boolean autoPrepareStmt)	Override standard command
DBModelChecker	createModelChecker(DBDatabase db)	Creates a DBModelChecker instance of this DBMSHandler
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. If a dbms supports this function it must return true for isSupported(DBMSFeature.SEQUENCES).
DBColumnExpr	getNextSequenceValueExpr(DBTableColumn column)	Returns an expression for creating a sequence value.
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

addSQLKeyword, addStatementParam, appendEnableRelationStmt, appendObjectName, attachDatabase, checkExists, closeResultSet, closeStatement, createCombinedCommand, createModelParser, createSQLBuilder, detachDatabase, detectQuoteName, executeBatch, executeQuery, executeSQL, extractErrorMessage, getColumnAutoValue, getColumnSequenceName, getIgnoreCaseExpr, getResultValue, prepareStatement, querySingleValue

Methods inherited from class java.lang.Object

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

Field Details

HSQL_KEYWORDS

protected static final String[] HSQL_KEYWORDS

Constructor Details

DBMSHandlerHSql

public DBMSHandlerHSql()

Constructor for the HSQLDB database dbms.

Method Details

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

createCommand

public DBCommand createCommand(boolean autoPrepareStmt)

Override standard command

Specified by:

createCommand in interface DBMSHandler

Overrides:

createCommand in class DBMSHandlerBase

Parameters:

autoPrepareStmt - flag whether to automatically provide literal values as prepared statement params

Returns:

a DBCommand object

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(DBSqlPhrase)

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)

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

See Also:

• DBMSHandlerBase.getNextSequenceValue(DBDatabase, String, int, Connection)

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

Parameters:

column - the column for which to obtain an expression providing the next sequence value

Returns:

an expression for the next sequence value

See Also:

• DBMSHandlerBase.getNextSequenceValueExpr(DBTableColumn col)

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)

createModelChecker

public DBModelChecker createModelChecker(DBDatabase db)

Creates a DBModelChecker instance of this DBMSHandler

Specified by:

createModelChecker in interface DBMSHandler

Overrides:

createModelChecker in class DBMSHandlerBase

Parameters:

db - the database

Returns:

the DBModelChecker