org.kepler.util.sql

Class HSQL

java.lang.Object

org.kepler.util.sql.DatabaseType

org.kepler.util.sql.HSQL

public class HSQL
extends DatabaseType

An implementation of DatabaseType for HSQL.

Author:

Daniel Crawl

Field Summary

Fields inherited from class org.kepler.util.sql.DatabaseType

_connection, _createIndexes, VERSION_TABLE_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HSQL() Only this package (DatabaseFactory) can instantiate.

Method Summary

Modifier and Type	Method and Description
protected boolean	_areForeignKeysIndexed() Returns true if foreign keys are automatically indexed.
protected boolean	_arePrimaryKeysIndexed() Returns true if primary keys are automatically indexed.
protected static void	_deletePortFile(java.lang.String dbName) Delete the port file for a database.
protected void	_executeSQL(java.lang.String sqlStr, java.sql.Connection connection) Execute an SQL statement for a Connection.
protected java.sql.Connection	_getConnection(java.lang.String jdbcURL) Get a connection to the database.
protected java.sql.Connection	_getConnection(java.lang.String dbURL, java.lang.String dbPort, java.lang.String databaseName, java.lang.String userName, java.lang.String passwd) Get a connection to the database.
protected java.lang.String	_getDriverName() Get the driver class name.
protected java.lang.String	_getJDBCUrl(java.lang.String hostName, java.lang.String port, java.lang.String databaseName) Get a JDBC URL.
protected java.lang.String	_getPort(java.lang.String dbPort, java.lang.String dbName, java.lang.String hostName) Get the port for a database name.
protected java.lang.String	_getTypeString(Column column) Get the SQL string of a column type.
protected boolean	_hasCatalog() Returns true if database uses a catalog.
protected boolean	_hasGeneratedKeys() Returns true if database supports auto-generated keys in its prepared statements.
protected boolean	_isTableCached() Returns true if table is cached.
protected boolean	_needCapitalColumnNames() Returns true if column names should be capitalized.
protected boolean	_needCapitalTableNames() Returns true if table names should be capitalized.
static void	checkpointAllServers() Checkpoint any servers to compact their size.
void	disconnect() Close a JDBC connection.
java.lang.String	getColumnAlterStr() Get the string used in SQL statements to modify the data type of a column.
java.lang.String	getColumnName(java.lang.String columnName) Adjust the name of a column.
java.lang.String	getDefaultTimeStr() Get a string representing the default time.
java.lang.String	getFalseValue() Get a string representation of the false value for a boolean column.
java.lang.String	getName() Get the name of the type.
java.lang.String	getPrimaryFileExtension() Get the primary file extension of the database.
java.lang.String	getTrueValue() Get a string representation of the true value for a boolean column.
boolean	needAbsolutePathForName() Returns true if database name should be an absolute path in the file system.
boolean	needHostForConnect() Returns true if need host name for connect.
boolean	needPasswordForConnect() Returns true if need password for connect.
boolean	needUserForConnect() Returns true if need user name for connect.
void	renameColumn(java.lang.String oldName, Column newColumn, java.lang.String tableName) Rename a column.
void	setColumnNotNull(Column column, java.lang.String tableName) Set not null constraint to a column.
void	setColumnNull(Column column, java.lang.String tableName) Change a column to allow null values.
static void	setForkServers(boolean fork) Set whether HSQL servers are run in a separate process.
static void	shutdownServers() Stop any running servers.

Methods inherited from class org.kepler.util.sql.DatabaseType

_combineHostAndPort, _connectInitialize, _executeSQL, _getCreateTableSuffix, _isAutoIncResultReferencedByName, _isIdentifierTooLong, _needIdentityForAutoInc, _needSequencesForAutoInc, addMinorVersion, changeColumnType, commit, connect, copyColumn, createColumn, createColumn, createColumn, createIndex, createIndex, createTables, createTables, createVersionTable, deleteColumn, getColumnDefinition, getColumnDefinition, getColumnNames, getColumnSize, getConnection, getMajorVersion, getMinorVersion, getPrepStatement, getSQLDelete, getSQLInsert, getSQLInsert, getSQLSelect, getSQLSelect, getSQLUpdate, getStatement, getTableName, getVersionString, hasNewerSchema, hasOlderSchema, insert, procedureExists, rollback, setAutoCommit, tableExists, tableExists, updateMinorVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

HSQL

protected HSQL()

Only this package (DatabaseFactory) can instantiate.

Method Detail

disconnect

public void disconnect()
                throws java.sql.SQLException

Close a JDBC connection.

Overrides:

disconnect in class DatabaseType

Throws:

java.sql.SQLException

_getPort

protected java.lang.String _getPort(java.lang.String dbPort,
                                    java.lang.String dbName,
                                    java.lang.String hostName)
                             throws java.io.IOException

Get the port for a database name. If dbPort is outside the range of ports previously used for Kepler (9001-9010), then dbPort is returned. If the port file exists in the database directory, then the port in this file is returned. Otherwise, this method chooses a random port, writes it to the port file, and returns the value. The port file is removed when the server is shut down either in shutdownServers(), or disconnect().

Overrides:

_getPort in class DatabaseType

Throws:

java.io.IOException

getColumnAlterStr

public java.lang.String getColumnAlterStr()

Get the string used in SQL statements to modify the data type of a column.

Overrides:

getColumnAlterStr in class DatabaseType

getColumnName

public java.lang.String getColumnName(java.lang.String columnName)

Adjust the name of a column.

Overrides:

getColumnName in class DatabaseType

getDefaultTimeStr

public java.lang.String getDefaultTimeStr()

Get a string representing the default time.

Overrides:

getDefaultTimeStr in class DatabaseType

getFalseValue

public java.lang.String getFalseValue()

Get a string representation of the false value for a boolean column.

Overrides:

getFalseValue in class DatabaseType

getName

public java.lang.String getName()

Get the name of the type.

Specified by:

getName in class DatabaseType

getPrimaryFileExtension

public java.lang.String getPrimaryFileExtension()

Get the primary file extension of the database. If the database is not file-based, this returns null.

Overrides:

getPrimaryFileExtension in class DatabaseType

getTrueValue

public java.lang.String getTrueValue()

Get a string representation of the true value for a boolean column.

Overrides:

getTrueValue in class DatabaseType

needAbsolutePathForName

public boolean needAbsolutePathForName()

Returns true if database name should be an absolute path in the file system.

Overrides:

needAbsolutePathForName in class DatabaseType

needHostForConnect

public boolean needHostForConnect()

Returns true if need host name for connect.

Overrides:

needHostForConnect in class DatabaseType

needPasswordForConnect

public boolean needPasswordForConnect()

Returns true if need password for connect.

Overrides:

needPasswordForConnect in class DatabaseType

needUserForConnect

public boolean needUserForConnect()

Returns true if need user name for connect.

Overrides:

needUserForConnect in class DatabaseType

renameColumn

public void renameColumn(java.lang.String oldName,
                         Column newColumn,
                         java.lang.String tableName)
                  throws java.sql.SQLException

Rename a column.

Specified by:

renameColumn in class DatabaseType

Throws:

java.sql.SQLException

setColumnNull

public void setColumnNull(Column column,
                          java.lang.String tableName)
                   throws java.sql.SQLException

Change a column to allow null values.

Specified by:

setColumnNull in class DatabaseType

Throws:

java.sql.SQLException

setColumnNotNull

public void setColumnNotNull(Column column,
                             java.lang.String tableName)
                      throws java.sql.SQLException

Set not null constraint to a column.

Specified by:

setColumnNotNull in class DatabaseType

Throws:

java.sql.SQLException

setForkServers

public static void setForkServers(boolean fork)

Set whether HSQL servers are run in a separate process.

shutdownServers

public static void shutdownServers()

Stop any running servers.

_areForeignKeysIndexed

protected boolean _areForeignKeysIndexed()

Returns true if foreign keys are automatically indexed.

Overrides:

_areForeignKeysIndexed in class DatabaseType

_arePrimaryKeysIndexed

protected boolean _arePrimaryKeysIndexed()

Returns true if primary keys are automatically indexed.

Overrides:

_arePrimaryKeysIndexed in class DatabaseType

_getDriverName

protected java.lang.String _getDriverName()

Get the driver class name.

Specified by:

_getDriverName in class DatabaseType

_getJDBCUrl

protected java.lang.String _getJDBCUrl(java.lang.String hostName,
                                       java.lang.String port,
                                       java.lang.String databaseName)
                                throws java.sql.SQLException

Get a JDBC URL.

Specified by:

_getJDBCUrl in class DatabaseType

Throws:

java.sql.SQLException

_getTypeString

protected java.lang.String _getTypeString(Column column)

Get the SQL string of a column type.

Specified by:

_getTypeString in class DatabaseType

_hasCatalog

protected boolean _hasCatalog()

Returns true if database uses a catalog.

Overrides:

_hasCatalog in class DatabaseType

_hasGeneratedKeys

protected boolean _hasGeneratedKeys()

Returns true if database supports auto-generated keys in its prepared statements.

Specified by:

_hasGeneratedKeys in class DatabaseType

_isTableCached

protected boolean _isTableCached()

Returns true if table is cached.

Overrides:

_isTableCached in class DatabaseType

_needCapitalColumnNames

protected boolean _needCapitalColumnNames()

Returns true if column names should be capitalized.

Overrides:

_needCapitalColumnNames in class DatabaseType

_needCapitalTableNames

protected boolean _needCapitalTableNames()

Returns true if table names should be capitalized.

Overrides:

_needCapitalTableNames in class DatabaseType

_getConnection

protected java.sql.Connection _getConnection(java.lang.String jdbcURL)
                                      throws java.sql.SQLException

Get a connection to the database.

Overrides:

_getConnection in class DatabaseType

Throws:

java.sql.SQLException

_getConnection

protected java.sql.Connection _getConnection(java.lang.String dbURL,
                                             java.lang.String dbPort,
                                             java.lang.String databaseName,
                                             java.lang.String userName,
                                             java.lang.String passwd)
                                      throws java.sql.SQLException

Get a connection to the database.

Overrides:

_getConnection in class DatabaseType

Throws:

java.sql.SQLException

checkpointAllServers

public static void checkpointAllServers()

Checkpoint any servers to compact their size. This rewrites the backing files for the databases.

_executeSQL

protected void _executeSQL(java.lang.String sqlStr,
                           java.sql.Connection connection)
                    throws java.sql.SQLException

Execute an SQL statement for a Connection. TODO move to parent class

Throws:

java.sql.SQLException

_deletePortFile

protected static void _deletePortFile(java.lang.String dbName)

Delete the port file for a database.