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

Field Summary

Fields inherited from class JdbcAdapter

caseInsensitiveCollations, defaultCharColumnLength, ejbqlTranslator, extendedTypes, logger, nativeColumnTypes, quotingStrategy, supportsBatchUpdates, supportsGeneratedKeys, supportsUniqueConstraints

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	bind(PreparedStatement statement, Object value, int psPosition, int psType, int psScale, ExtendedType binder)	Binds a raw value to a statement parameter.
protected void	configureExtendedTypes(ExtendedTypeMap map)	Installs appropriate ExtendedTypes as converters for passing values between JDBC and Java layers.
protected EJBQLTranslator	createEJBQLTranslator()	Creates and returns an EJBQLTranslator used to generate visitors for EJBQL to SQL translations.
protected NativeColumnType[]	createNativeTypes()	Returns the database-native types supported by this adapter.
PkGenerator	createPkGenerator()	Returns a DerbyPkGenerator.
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()
int	preferredBindingType(int jdbcType)	Returns the JDBC type that this adapter prefers to bind for a given mapped JDBC type.
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

bindParameter, bindParameter, buildAttribute, createFkConstraint, createQuotingStrategy, createTable, createTableAppendPKClause, createUniqueConstraint, defaultCharColumnLength, dropTableStatements, externalTypesForJdbcType, getBatchTerminator, getEjbqlTranslator, getExtendedTypes, getProcedureTranslator, getQuotingStrategy, getQuotingStrategy, getSelectTranslator, getSQLLogger, getSystemCatalogs, getSystemSchemas, getType, initExtendedTypes, nativeColumnTypes, setEjbqlTranslator, setEjbqlTranslatorFactory, setSupportsBatchUpdates, setSupportsGeneratedKeys, setSupportsUniqueConstraints, sizeAndPrecision, sizeAndScale, supportsBatchUpdates, supportsCatalogsOnReverseEngineering, supportsGeneratedKeys, supportsUniqueConstraints, tableTypeForTable, tableTypeForView, unwrap

Methods inherited from class Object

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

Methods inherited from interface DbAdapter

getEjbqlTranslatorFactory, preferredNativeColumnType

Constructor Details

DerbyAdapter

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

Method Details

createNativeTypes

protected NativeColumnType[] createNativeTypes()

Description copied from class: JdbcAdapter

Returns the database-native types supported by this adapter.

Overrides:

createNativeTypes in class JdbcAdapter

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

createPkGenerator

public PkGenerator createPkGenerator()

Returns a DerbyPkGenerator.

Specified by:

createPkGenerator in interface DbAdapter

Overrides:

createPkGenerator in class JdbcAdapter

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

createEJBQLTranslator

protected EJBQLTranslator createEJBQLTranslator()

Description copied from class: JdbcAdapter

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

Overrides:

createEJBQLTranslator in class JdbcAdapter

Since:

3.1

bind

protected void bind(PreparedStatement statement,
 Object value,
 int psPosition,
 int psType,
 int psScale,
 ExtendedType binder)
             throws Exception

Description copied from class: JdbcAdapter

Binds a raw value to a statement parameter. This is the single extension point shared by both bindParameter overloads; adapters that need database-specific handling (e.g. of NULLs) should override this method rather than the public overloads.

Overrides:

bind in class JdbcAdapter

Throws:

Exception

preferredBindingType

public int preferredBindingType(int jdbcType)

Description copied from interface: DbAdapter

Returns the JDBC type that this adapter prefers to bind for a given mapped JDBC type. The default implementation is an identity function; adapters whose drivers require a different type (e.g. remapping the N* character types to their non-national counterparts) override this. The returned type is resolved into the PSParameter at binding creation time, so it matches the type actually sent to the PreparedStatement.

Since:

5.0