Class DerbyAdapter

java.lang.Object

org.apache.cayenne.dba.JdbcAdapter

org.apache.cayenne.dba.derby.DerbyAdapter

All Implemented Interfaces:

DbAdapter

public class DerbyAdapter
extends JdbcAdapter

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

Embedded

 test-derby.jdbc.url = jdbc:derby:testdb;create=true
 test-derby.jdbc.driver = org.apache.derby.jdbc.EmbeddedDriver

Network Server

 derbynet.jdbc.url = jdbc:derby://localhost/cayenne
 derbynet.jdbc.driver = org.apache.derby.jdbc.ClientDriver
 derbynet.jdbc.username = someuser
 derbynet.jdbc.password = secret;

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
DerbyAdapter(RuntimeProperties runtimeProperties, List<ExtendedType> defaultExtendedTypes, List<ExtendedType> userExtendedTypes, List<ExtendedTypeFactory> extendedTypeFactories, ResourceLocator resourceLocator, ValueObjectTypeRegistry valueObjectTypeRegistry)

Method Summary

Modifier and Type	Method	Description
void	bindParameter(PreparedStatement statement, ParameterBinding binding)	Binds an object value to PreparedStatement's parameter.
protected void	configureExtendedTypes(ExtendedTypeMap map)	Installs appropriate ExtendedTypes as converters for passing values between JDBC and Java layers.
protected EJBQLTranslatorFactory	createEJBQLTranslatorFactory()	Creates and returns an EJBQLTranslatorFactory used to generate visitors for EJBQL to SQL translations.
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.
SQLTreeProcessor	getSqlTreeProcessor()
boolean	supportsGeneratedKeysForBatchInserts()	Not supported, see: DERBY-3609
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.

Methods inherited from class JdbcAdapter

buildAttribute, createFkConstraint, createQuotingStrategy, createTable, createTableAppendPKClause, createUniqueConstraint, 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, unwrap

Modifier and Type	Method	Description
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).
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.
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.
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

Constructor Details

DerbyAdapter

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

Method Details

supportsGeneratedKeysForBatchInserts

public boolean supportsGeneratedKeysForBatchInserts()

Not supported, see: DERBY-3609

See Also:

• DbAdapter.supportsGeneratedKeys()

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

configureExtendedTypes

protected void configureExtendedTypes(ExtendedTypeMap map)

Installs appropriate ExtendedTypes as converters for passing values between JDBC and Java layers.

Overrides:

configureExtendedTypes in class JdbcAdapter

createTableAppendColumn

public void createTableAppendColumn(StringBuffer sqlBuffer,
 DbAttribute column)

Appends SQL for column creation to CREATE TABLE buffer. Only change for Derby is that " NULL" is not supported.

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

Since:

1.2

typeSupportsLength

public boolean typeSupportsLength(int type)

Description copied from class: JdbcAdapter

Returns true if supplied type can have a length attribute as a part of column definition

Specified by:

typeSupportsLength in interface DbAdapter

Overrides:

typeSupportsLength in class JdbcAdapter

typeSupportsScale

public boolean typeSupportsScale(int type)

Description copied from class: JdbcAdapter

Returns true if supplied type can have a scale attribute as a part of column definition.

Specified by:

typeSupportsScale in interface DbAdapter

Overrides:

typeSupportsScale in class JdbcAdapter

Parameters:

type - sql type code

Returns:

true if a given type supports scale

Since:

5.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:

3.1

bindParameter

public void bindParameter(PreparedStatement statement,
 ParameterBinding binding)
                   throws SQLException,
Exception

Description copied from interface: DbAdapter

Binds an object value to PreparedStatement's parameter.

Specified by:

bindParameter in interface DbAdapter

Overrides:

bindParameter in class JdbcAdapter

Throws:

SQLException

Exception