Class FirebirdAdapter

java.lang.Object

org.apache.cayenne.dba.JdbcAdapter

org.apache.cayenne.dba.firebird.FirebirdAdapter

All Implemented Interfaces:

DbAdapter

public class FirebirdAdapter
extends JdbcAdapter

DbAdapter implementation for FirebirdSQL RDBMS . Sample connection settings to use with Firebird are shown below:

     firebird.cayenne.adapter = org.apache.cayenne.dba.firebird.FirebirdAdapter
     firebird.jdbc.username = test
     firebird.jdbc.password = secret
     firebird.jdbc.url = jdbc:firebirdsql:localhost:/home/firebird/test.fdb  
     firebird.jdbc.driver = org.firebirdsql.jdbc.FBDriver

Field Summary

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
FirebirdAdapter(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.
void	createTableAppendColumn(StringBuffer sqlBuffer, DbAttribute column)	Appends SQL for column creation to CREATE TABLE buffer.
SQLAction	getAction(Query query, DataNode node)	Uses JdbcActionBuilder to create the right action.
EJBQLTranslatorFactory	getEjbqlTranslatorFactory()	Returns a translator factory for EJBQL to SQL translation.
SQLTreeProcessor	getSqlTreeProcessor()

Methods inherited from class JdbcAdapter

bindParameter, buildAttribute, createEJBQLTranslatorFactory, createFkConstraint, createQuotingStrategy, createTable, createTableAppendPKClause, createUniqueConstraint, dropTableStatements, externalTypesForJdbcType, findResource, getBatchTerminator, 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 EJBQLTranslatorFactory	createEJBQLTranslatorFactory()	Creates and returns an EJBQLTranslatorFactory used to generate visitors for EJBQL to SQL translations.
String	createFkConstraint(DbRelationship rel)	Returns a SQL string that can be used to create a foreign key constraint for the relationship.
protected QuotingStrategy	createQuotingStrategy()
String	createTable(DbEntity entity)	Returns a SQL string that can be used to create database table corresponding to ent parameter.
protected void	createTableAppendPKClause(StringBuffer sqlBuffer, DbEntity entity)
String	createUniqueConstraint(DbEntity source, Collection<DbAttribute> columns)	Returns a DDL string to create a unique constraint over a set of columns.
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.
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.

Constructor Details

FirebirdAdapter

public FirebirdAdapter(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

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

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

getEjbqlTranslatorFactory

public EJBQLTranslatorFactory getEjbqlTranslatorFactory()

Description copied from class: JdbcAdapter

Returns a translator factory for EJBQL to SQL translation. The factory is normally initialized in constructor by calling JdbcAdapter.createEJBQLTranslatorFactory(), and can be changed later by calling JdbcAdapter.setEjbqlTranslatorFactory(EJBQLTranslatorFactory).

Specified by:

getEjbqlTranslatorFactory in interface DbAdapter

Overrides:

getEjbqlTranslatorFactory in class JdbcAdapter

getAction

public SQLAction getAction(Query query,
 DataNode node)

Description copied from class: JdbcAdapter

Uses JdbcActionBuilder to create the right action.

Specified by:

getAction in interface DbAdapter

Overrides:

getAction in class JdbcAdapter