Class HSQLDBAdapter

java.lang.Object

org.apache.cayenne.dba.JdbcAdapter

org.apache.cayenne.dba.hsqldb.HSQLDBAdapter

All Implemented Interfaces:

DbAdapter

Direct Known Subclasses:

HSQLDBNoSchemaAdapter

public class HSQLDBAdapter
extends JdbcAdapter

DbAdapter implementation for the HSQLDB RDBMS . Sample connection settings to use with HSQLDB are shown below:

       test-hsqldb.jdbc.username = test
       test-hsqldb.jdbc.password = secret
       test-hsqldb.jdbc.url = jdbc:hsqldb:hsql://serverhostname
       test-hsqldb.jdbc.driver = org.hsqldb.jdbcDriver

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TRIM_FUNCTION

Fields inherited from class JdbcAdapter

caseInsensitiveCollations, ejbqlTranslatorFactory, extendedTypes, logger, quotingStrategy, resourceLocator, supportsBatchUpdates, supportsGeneratedKeys, supportsUniqueConstraints, typesHandler

Modifier and Type	Field	Description
protected boolean	caseInsensitiveCollations
protected EJBQLTranslatorFactory	ejbqlTranslatorFactory
protected ExtendedTypeMap	extendedTypes
protected JdbcEventLogger	logger
protected QuotingStrategy	quotingStrategy
protected ResourceLocator	resourceLocator
protected boolean	supportsBatchUpdates
protected boolean	supportsGeneratedKeys
protected boolean	supportsUniqueConstraints
protected TypesHandler	typesHandler

Constructor Summary

Constructors

Constructor	Description
HSQLDBAdapter(RuntimeProperties runtimeProperties, List<ExtendedType> defaultExtendedTypes, List<ExtendedType> userExtendedTypes, List<ExtendedTypeFactory> extendedTypeFactories, ResourceLocator resourceLocator, ValueObjectTypeRegistry valueObjectTypeRegistry)

Method Summary

Modifier and Type	Method	Description
protected void	configureExtendedTypes(ExtendedTypeMap map)	Called from JdbcAdapter.initExtendedTypes(List, List, List, ValueObjectTypeRegistry) to load adapter-specific types into the ExtendedTypeMap right after the default types are loaded, but before the DI overrides are.
protected EJBQLTranslatorFactory	createEJBQLTranslatorFactory()	Creates and returns an EJBQLTranslatorFactory used to generate visitors for EJBQL to SQL translations.
String	createFkConstraint(DbRelationship rel)	Adds an ADD CONSTRAINT clause to a relationship constraint.
String	createTable(DbEntity ent)	Uses "CREATE CACHED TABLE" instead of "CREATE TABLE".
void	createTableAppendColumn(StringBuffer sqlBuffer, DbAttribute column)	Appends SQL for column creation to CREATE TABLE buffer.
String	createUniqueConstraint(DbEntity source, Collection<DbAttribute> columns)	Returns a DDL string to create a unique constraint over a set of columns.
SQLAction	getAction(Query query, DataNode node)	Uses special action builder to create the right action.
protected String	getSchemaName(DbEntity entity)	Returns DbEntity schema name for 1.8 and on.
SQLTreeProcessor	getSqlTreeProcessor()
protected String	getTableName(DbEntity entity)	Generate fully-qualified name for 1.8 and on.

Methods inherited from class JdbcAdapter

bindParameter, buildAttribute, createQuotingStrategy, createTableAppendPKClause, dropTableStatements, externalTypesForJdbcType, findResource, getBatchTerminator, getEjbqlTranslatorFactory, getExtendedTypes, getJdbcEventLogger, getPkGenerator, getQuotingStrategy, getSelectTranslator, getSystemCatalogs, getSystemSchemas, getType, initExtendedTypes, setEjbqlTranslatorFactory, setPkGenerator, setSupportsBatchUpdates, setSupportsGeneratedKeys, setSupportsUniqueConstraints, sizeAndPrecision, supportsBatchUpdates, supportsCatalogsOnReverseEngineering, supportsGeneratedKeys, supportsUniqueConstraints, tableTypeForTable, tableTypeForView, typeSupportsLength, typeSupportsScale, unwrap

Modifier and Type	Method	Description
void	bindParameter(PreparedStatement statement, ParameterBinding binding)	Binds an object value to PreparedStatement's parameter.
DbAttribute	buildAttribute(String name, String typeName, int type, int size, int scale, boolean allowNulls)	Creates and returns a DbAttribute based on supplied parameters (usually obtained from database meta data).
protected QuotingStrategy	createQuotingStrategy()
protected void	createTableAppendPKClause(StringBuffer sqlBuffer, DbEntity entity)
Collection<String>	dropTableStatements(DbEntity table)	Returns a collection of SQL statements needed to drop a database table.
String[]	externalTypesForJdbcType(int type)	Returns an array of RDBMS types that can be used with JDBC type.
protected URL	findResource(String name)	Locates and returns a named adapter resource.
String	getBatchTerminator()	Returns default separator - a semicolon.
EJBQLTranslatorFactory	getEjbqlTranslatorFactory()	Returns a translator factory for EJBQL to SQL translation.
ExtendedTypeMap	getExtendedTypes()	Returns a map of ExtendedTypes that is used to translate values between Java and JDBC layer.
JdbcEventLogger	getJdbcEventLogger()
PkGenerator	getPkGenerator()	Returns primary key generator associated with this DbAdapter.
QuotingStrategy	getQuotingStrategy()	Returns SQL identifier quoting strategy object
SelectTranslator	getSelectTranslator(FluentSelect<?,?> query, EntityResolver entityResolver)
List<String>	getSystemCatalogs()
List<String>	getSystemSchemas()
static String	getType(DbAdapter adapter, DbAttribute column)
protected void	initExtendedTypes(List<ExtendedType> defaultExtendedTypes, List<ExtendedType> userExtendedTypes, List<ExtendedTypeFactory> extendedTypeFactories, ValueObjectTypeRegistry valueObjectTypeRegistry)
void	setEjbqlTranslatorFactory(EJBQLTranslatorFactory ejbqlTranslatorFactory)	Sets a translator factory for EJBQL to SQL translation.
void	setPkGenerator(PkGenerator pkGenerator)	Sets new primary key generator.
void	setSupportsBatchUpdates(boolean flag)
void	setSupportsGeneratedKeys(boolean flag)
void	setSupportsUniqueConstraints(boolean flag)
static String	sizeAndPrecision(DbAdapter adapter, DbAttribute column)
boolean	supportsBatchUpdates()	Returns true if the target database supports batch updates.
boolean	supportsCatalogsOnReverseEngineering()	Returns true.
boolean	supportsGeneratedKeys()	Returns true if a target database supports key autogeneration.
boolean	supportsUniqueConstraints()	Returns true.
String	tableTypeForTable()	Returns the name of the table type (as returned by DatabaseMetaData.getTableTypes) for a simple user table.
String	tableTypeForView()	Returns the name of the table type (as returned by DatabaseMetaData.getTableTypes) for a view table.
boolean	typeSupportsLength(int type)	Returns true if supplied type can have a length attribute as a part of column definition
boolean	typeSupportsScale(int type)	Returns true if supplied type can have a scale attribute as a part of column definition.
DbAdapter	unwrap()	Simply returns this, as JdbcAdapter is not a wrapper.

Methods inherited from class Object

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

Methods inherited from interface DbAdapter

supportsGeneratedKeysForBatchInserts

Modifier and Type	Method	Description
default boolean	supportsGeneratedKeysForBatchInserts()	Returns true if a target database supports key autogeneration in a batch insert.

Field Details

TRIM_FUNCTION

public static final String TRIM_FUNCTION

See Also:

• Constant Field Values

Constructor Details

HSQLDBAdapter

public HSQLDBAdapter(RuntimeProperties runtimeProperties,
 List<ExtendedType> defaultExtendedTypes,
 List<ExtendedType> userExtendedTypes,
 List<ExtendedTypeFactory> extendedTypeFactories,
 ResourceLocator resourceLocator,
 ValueObjectTypeRegistry valueObjectTypeRegistry)

Method Details

configureExtendedTypes

protected void configureExtendedTypes(ExtendedTypeMap map)

Description copied from class: JdbcAdapter

Called from JdbcAdapter.initExtendedTypes(List, List, List, ValueObjectTypeRegistry) to load adapter-specific types into the ExtendedTypeMap right after the default types are loaded, but before the DI overrides are. This method has specific implementations in JdbcAdapter subclasses.

Overrides:

configureExtendedTypes in class JdbcAdapter

Since:

4.0

getSqlTreeProcessor

public SQLTreeProcessor getSqlTreeProcessor()

Specified by:

getSqlTreeProcessor in interface DbAdapter

Overrides:

getSqlTreeProcessor in class JdbcAdapter

Returns:

SQLTreeProcessor that can adjust SQL tree to specific database flavour

Since:

4.2

createEJBQLTranslatorFactory

protected EJBQLTranslatorFactory createEJBQLTranslatorFactory()

Description copied from class: JdbcAdapter

Creates and returns an EJBQLTranslatorFactory used to generate visitors for EJBQL to SQL translations. This method should be overriden by subclasses that need to customize EJBQL generation.

Overrides:

createEJBQLTranslatorFactory in class JdbcAdapter

Since:

4.0

getTableName

protected String getTableName(DbEntity entity)

Generate fully-qualified name for 1.8 and on. Subclass generates unqualified name.

Since:

1.2

getSchemaName

protected String getSchemaName(DbEntity entity)

Returns DbEntity schema name for 1.8 and on. Subclass generates unqualified name.

Since:

1.2

getAction

public SQLAction getAction(Query query,
 DataNode node)

Uses special action builder to create the right action.

Specified by:

getAction in interface DbAdapter

Overrides:

getAction in class JdbcAdapter

Since:

1.2

createUniqueConstraint

public String createUniqueConstraint(DbEntity source,
 Collection<DbAttribute> columns)

Returns a DDL string to create a unique constraint over a set of columns.

Specified by:

createUniqueConstraint in interface DbAdapter

Overrides:

createUniqueConstraint in class JdbcAdapter

Since:

1.1

createFkConstraint

public String createFkConstraint(DbRelationship rel)

Adds an ADD CONSTRAINT clause to a relationship constraint.

Specified by:

createFkConstraint in interface DbAdapter

Overrides:

createFkConstraint in class JdbcAdapter

See Also:

• JdbcAdapter.createFkConstraint(DbRelationship)

createTable

public String createTable(DbEntity ent)

Uses "CREATE CACHED TABLE" instead of "CREATE TABLE".

Specified by:

createTable in interface DbAdapter

Overrides:

createTable in class JdbcAdapter

Since:

1.2

createTableAppendColumn

public void createTableAppendColumn(StringBuffer sqlBuffer,
 DbAttribute column)

Description copied from class: JdbcAdapter

Appends SQL for column creation to CREATE TABLE buffer.

Specified by:

createTableAppendColumn in interface DbAdapter

Overrides:

createTableAppendColumn in class JdbcAdapter

Parameters:

sqlBuffer - the StringBuffer to append the column type to

column - the DbAttribute defining the column to append type for