Package org.apache.cayenne.dba
Class JdbcAdapter
- java.lang.Object
-
- org.apache.cayenne.dba.JdbcAdapter
-
- All Implemented Interfaces:
DbAdapter
- Direct Known Subclasses:
DB2Adapter,DerbyAdapter,FirebirdAdapter,FrontBaseAdapter,H2Adapter,HSQLDBAdapter,IngresAdapter,MySQLAdapter,OpenBaseAdapter,OracleAdapter,PostgresAdapter,SQLiteAdapter,SybaseAdapter
public class JdbcAdapter extends Object implements DbAdapter
A generic DbAdapter implementation. Can be used as a default adapter or as a superclass of a concrete adapter implementation.
-
-
Field Summary
Fields Modifier and Type Field Description protected BatchTranslatorFactorybatchQueryBuilderFactoryDeprecated.since 4.0 BatchQueryBuilderfactory is attached to the DataNode.protected booleancaseInsensitiveCollationsprotected EJBQLTranslatorFactoryejbqlTranslatorFactoryprotected ExtendedTypeMapextendedTypesprotected JdbcEventLoggerloggerprotected QuotingStrategyquotingStrategyprotected ResourceLocatorresourceLocatorprotected booleansupportsBatchUpdatesprotected booleansupportsGeneratedKeysprotected booleansupportsUniqueConstraintsprotected TypesHandlertypesHandler
-
Constructor Summary
Constructors Constructor Description JdbcAdapter(RuntimeProperties runtimeProperties, List<ExtendedType> defaultExtendedTypes, List<ExtendedType> userExtendedTypes, List<ExtendedTypeFactory> extendedTypeFactories, ResourceLocator resourceLocator, ValueObjectTypeRegistry valueObjectTypeRegistry)Creates new JdbcAdapter with a set of default parameters.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidbindParameter(PreparedStatement statement, ParameterBinding binding)Binds an object value to PreparedStatement's parameter.DbAttributebuildAttribute(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 voidconfigureExtendedTypes(ExtendedTypeMap map)Called frominitExtendedTypes(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 EJBQLTranslatorFactorycreateEJBQLTranslatorFactory()Creates and returns anEJBQLTranslatorFactoryused to generate visitors for EJBQL to SQL translations.StringcreateFkConstraint(DbRelationship rel)Returns a SQL string that can be used to create a foreign key constraint for the relationship.protected PkGeneratorcreatePkGenerator()Deprecated.protected QuotingStrategycreateQuotingStrategy()StringcreateTable(DbEntity entity)Returns a SQL string that can be used to create database table corresponding toentparameter.voidcreateTableAppendColumn(StringBuffer sqlBuffer, DbAttribute column)Appends SQL for column creation to CREATE TABLE buffer.protected voidcreateTableAppendPKClause(StringBuffer sqlBuffer, DbEntity entity)StringcreateUniqueConstraint(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 JDBCtype.protected URLfindResource(String name)Locates and returns a named adapter resource.SQLActiongetAction(Query query, DataNode node)Uses JdbcActionBuilder to create the right action.StringgetBatchTerminator()Returns default separator - a semicolon.EJBQLTranslatorFactorygetEjbqlTranslatorFactory()Returns a translator factory for EJBQL to SQL translation.ExtendedTypeMapgetExtendedTypes()Returns a map of ExtendedTypes that is used to translate values between Java and JDBC layer.JdbcEventLoggergetJdbcEventLogger()PkGeneratorgetPkGenerator()Returns primary key generator associated with this DbAdapter.QualifierTranslatorgetQualifierTranslator(QueryAssembler queryAssembler)Creates and returns a default implementation of a qualifier translator.QuotingStrategygetQuotingStrategy()Returns SQL identifier quoting strategy objectSelectTranslatorgetSelectTranslator(SelectQuery<?> query, EntityResolver entityResolver)Returns a SelectTranslator that works with the adapter target database.List<String>getSystemCatalogs()List<String>getSystemSchemas()static StringgetType(DbAdapter adapter, DbAttribute column)protected voidinitExtendedTypes(List<ExtendedType> defaultExtendedTypes, List<ExtendedType> userExtendedTypes, List<ExtendedTypeFactory> extendedTypeFactories, ValueObjectTypeRegistry valueObjectTypeRegistry)voidsetEjbqlTranslatorFactory(EJBQLTranslatorFactory ejbqlTranslatorFactory)Sets a translator factory for EJBQL to SQL translation.voidsetPkGenerator(PkGenerator pkGenerator)Sets new primary key generator.voidsetSupportsBatchUpdates(boolean flag)voidsetSupportsGeneratedKeys(boolean flag)voidsetSupportsUniqueConstraints(boolean flag)static StringsizeAndPrecision(DbAdapter adapter, DbAttribute column)booleansupportsBatchUpdates()Returnstrueif the target database supports batch updates.booleansupportsCatalogsOnReverseEngineering()Returns true.booleansupportsGeneratedKeys()Returns true if a target database supports key autogeneration.booleansupportsUniqueConstraints()Returns true.StringtableTypeForTable()Returns the name of the table type (as returned byDatabaseMetaData.getTableTypes) for a simple user table.StringtableTypeForView()Returns the name of the table type (as returned byDatabaseMetaData.getTableTypes) for a view table.booleantypeSupportsLength(int type)Returns true if supplied type can have a length attribute as a part of column definitionDbAdapterunwrap()Simply returns this, as JdbcAdapter is not a wrapper.
-
-
-
Field Detail
-
quotingStrategy
protected QuotingStrategy quotingStrategy
-
typesHandler
protected TypesHandler typesHandler
-
extendedTypes
protected ExtendedTypeMap extendedTypes
-
supportsBatchUpdates
protected boolean supportsBatchUpdates
-
supportsUniqueConstraints
protected boolean supportsUniqueConstraints
-
supportsGeneratedKeys
protected boolean supportsGeneratedKeys
-
ejbqlTranslatorFactory
protected EJBQLTranslatorFactory ejbqlTranslatorFactory
-
resourceLocator
protected ResourceLocator resourceLocator
-
caseInsensitiveCollations
protected boolean caseInsensitiveCollations
-
batchQueryBuilderFactory
protected BatchTranslatorFactory batchQueryBuilderFactory
Deprecated.since 4.0 BatchQueryBuilderfactory is attached to the DataNode.- Since:
- 3.1
-
logger
protected JdbcEventLogger logger
-
-
Constructor Detail
-
JdbcAdapter
public JdbcAdapter(RuntimeProperties runtimeProperties, List<ExtendedType> defaultExtendedTypes, List<ExtendedType> userExtendedTypes, List<ExtendedTypeFactory> extendedTypeFactories, ResourceLocator resourceLocator, ValueObjectTypeRegistry valueObjectTypeRegistry)
Creates new JdbcAdapter with a set of default parameters.
-
-
Method Detail
-
getBatchTerminator
public String getBatchTerminator()
Returns default separator - a semicolon.- Specified by:
getBatchTerminatorin interfaceDbAdapter- Since:
- 1.0.4
-
getJdbcEventLogger
public JdbcEventLogger getJdbcEventLogger()
- Since:
- 3.1
-
findResource
protected URL findResource(String name)
Locates and returns a named adapter resource. A resource can be an XML file, etc.This implementation is based on the premise that each adapter is located in its own Java package and all resources are in the same package as well. Resource lookup is recursive, so that if DbAdapter is a subclass of another adapter, parent adapter package is searched as a failover.
- Since:
- 3.0
-
configureExtendedTypes
protected void configureExtendedTypes(ExtendedTypeMap map)
Called frominitExtendedTypes(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.
-
initExtendedTypes
protected void initExtendedTypes(List<ExtendedType> defaultExtendedTypes, List<ExtendedType> userExtendedTypes, List<ExtendedTypeFactory> extendedTypeFactories, ValueObjectTypeRegistry valueObjectTypeRegistry)
- Since:
- 3.1
-
createPkGenerator
@Deprecated protected PkGenerator createPkGenerator()
Deprecated.Creates and returns a primary key generator. This factory method should be overriden by JdbcAdapter subclasses to provide custom implementations of PKGenerator.
-
createEJBQLTranslatorFactory
protected EJBQLTranslatorFactory createEJBQLTranslatorFactory()
Creates and returns anEJBQLTranslatorFactoryused to generate visitors for EJBQL to SQL translations. This method should be overriden by subclasses that need to customize EJBQL generation.- Since:
- 3.0
-
getPkGenerator
public PkGenerator getPkGenerator()
Returns primary key generator associated with this DbAdapter.- Specified by:
getPkGeneratorin interfaceDbAdapter
-
setPkGenerator
public void setPkGenerator(PkGenerator pkGenerator)
Sets new primary key generator.- Specified by:
setPkGeneratorin interfaceDbAdapter- Parameters:
pkGenerator- to set- Since:
- 1.1
-
supportsUniqueConstraints
public boolean supportsUniqueConstraints()
Returns true.- Specified by:
supportsUniqueConstraintsin interfaceDbAdapter- Since:
- 1.1
-
supportsCatalogsOnReverseEngineering
public boolean supportsCatalogsOnReverseEngineering()
Returns true.- Specified by:
supportsCatalogsOnReverseEngineeringin interfaceDbAdapter- Since:
- 4.0
-
setSupportsUniqueConstraints
public void setSupportsUniqueConstraints(boolean flag)
- Since:
- 1.1
-
typeSupportsLength
public boolean typeSupportsLength(int type)
Returns true if supplied type can have a length attribute as a part of column definition- Specified by:
typeSupportsLengthin interfaceDbAdapter- Since:
- 4.0
-
dropTableStatements
public Collection<String> dropTableStatements(DbEntity table)
Description copied from interface:DbAdapterReturns a collection of SQL statements needed to drop a database table.- Specified by:
dropTableStatementsin interfaceDbAdapter- Since:
- 3.0
-
createTable
public String createTable(DbEntity entity)
Returns a SQL string that can be used to create database table corresponding toentparameter.- Specified by:
createTablein interfaceDbAdapter
-
createTableAppendPKClause
protected void createTableAppendPKClause(StringBuffer sqlBuffer, DbEntity entity)
- Since:
- 1.2
-
createTableAppendColumn
public void createTableAppendColumn(StringBuffer sqlBuffer, DbAttribute column)
Appends SQL for column creation to CREATE TABLE buffer.- Specified by:
createTableAppendColumnin interfaceDbAdapter- Parameters:
sqlBuffer- theStringBufferto append the column type tocolumn- theDbAttributedefining the column to append type for- Since:
- 1.2
-
sizeAndPrecision
public static String sizeAndPrecision(DbAdapter adapter, DbAttribute column)
-
getType
public static String getType(DbAdapter adapter, DbAttribute column)
-
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:
createUniqueConstraintin interfaceDbAdapter- Since:
- 1.1
-
createFkConstraint
public String createFkConstraint(DbRelationship rel)
Returns a SQL string that can be used to create a foreign key constraint for the relationship.- Specified by:
createFkConstraintin interfaceDbAdapter
-
externalTypesForJdbcType
public String[] externalTypesForJdbcType(int type)
Description copied from interface:DbAdapterReturns an array of RDBMS types that can be used with JDBCtype. Valid JDBC types are defined in java.sql.Types.- Specified by:
externalTypesForJdbcTypein interfaceDbAdapter
-
getExtendedTypes
public ExtendedTypeMap getExtendedTypes()
Description copied from interface:DbAdapterReturns a map of ExtendedTypes that is used to translate values between Java and JDBC layer.- Specified by:
getExtendedTypesin interfaceDbAdapter
-
buildAttribute
public DbAttribute buildAttribute(String name, String typeName, int type, int size, int scale, boolean allowNulls)
Description copied from interface:DbAdapterCreates and returns a DbAttribute based on supplied parameters (usually obtained from database meta data).- Specified by:
buildAttributein interfaceDbAdapter- Parameters:
name- database column nametypeName- database specific type name, may be used as a hint to determine the right JDBC type.type- JDBC column typesize- database column size (ignored if less than zero)scale- database column scale, i.e. the number of decimal digits (ignored if less than zero)allowNulls- database column nullable parameter
-
tableTypeForTable
public String tableTypeForTable()
Description copied from interface:DbAdapterReturns the name of the table type (as returned byDatabaseMetaData.getTableTypes) for a simple user table.- Specified by:
tableTypeForTablein interfaceDbAdapter
-
tableTypeForView
public String tableTypeForView()
Description copied from interface:DbAdapterReturns the name of the table type (as returned byDatabaseMetaData.getTableTypes) for a view table.- Specified by:
tableTypeForViewin interfaceDbAdapter
-
getQualifierTranslator
public QualifierTranslator getQualifierTranslator(QueryAssembler queryAssembler)
Creates and returns a default implementation of a qualifier translator.- Specified by:
getQualifierTranslatorin interfaceDbAdapter
-
getAction
public SQLAction getAction(Query query, DataNode node)
Uses JdbcActionBuilder to create the right action.
-
getSelectTranslator
public SelectTranslator getSelectTranslator(SelectQuery<?> query, EntityResolver entityResolver)
Description copied from interface:DbAdapterReturns a SelectTranslator that works with the adapter target database.- Specified by:
getSelectTranslatorin interfaceDbAdapter
-
bindParameter
public void bindParameter(PreparedStatement statement, ParameterBinding binding) throws SQLException, Exception
Description copied from interface:DbAdapterBinds an object value to PreparedStatement's parameter.- Specified by:
bindParameterin interfaceDbAdapter- Throws:
SQLExceptionException
-
supportsBatchUpdates
public boolean supportsBatchUpdates()
Description copied from interface:DbAdapterReturnstrueif the target database supports batch updates.- Specified by:
supportsBatchUpdatesin interfaceDbAdapter
-
setSupportsBatchUpdates
public void setSupportsBatchUpdates(boolean flag)
-
supportsGeneratedKeys
public boolean supportsGeneratedKeys()
Description copied from interface:DbAdapterReturns true if a target database supports key autogeneration. This feature also requires JDBC3-compliant driver.- Specified by:
supportsGeneratedKeysin interfaceDbAdapter- Since:
- 1.2
-
setSupportsGeneratedKeys
public void setSupportsGeneratedKeys(boolean flag)
- Since:
- 1.2
-
getEjbqlTranslatorFactory
public EJBQLTranslatorFactory getEjbqlTranslatorFactory()
Returns a translator factory for EJBQL to SQL translation. The factory is normally initialized in constructor by callingcreateEJBQLTranslatorFactory(), and can be changed later by callingsetEjbqlTranslatorFactory(EJBQLTranslatorFactory).- Specified by:
getEjbqlTranslatorFactoryin interfaceDbAdapter- Since:
- 3.0
-
getSystemCatalogs
public List<String> getSystemCatalogs()
- Specified by:
getSystemCatalogsin interfaceDbAdapter- Returns:
- list of system catalogs
-
getSystemSchemas
public List<String> getSystemSchemas()
- Specified by:
getSystemSchemasin interfaceDbAdapter- Returns:
- list of system schemas
-
setEjbqlTranslatorFactory
public void setEjbqlTranslatorFactory(EJBQLTranslatorFactory ejbqlTranslatorFactory)
Sets a translator factory for EJBQL to SQL translation. This property is normally initialized in constructor by callingcreateEJBQLTranslatorFactory(), so users would only override it if they need to customize EJBQL translation.- Since:
- 3.0
-
createQuotingStrategy
protected QuotingStrategy createQuotingStrategy()
- Since:
- 4.0
-
getQuotingStrategy
public QuotingStrategy getQuotingStrategy()
Description copied from interface:DbAdapterReturns SQL identifier quoting strategy object- Specified by:
getQuotingStrategyin interfaceDbAdapter- Since:
- 4.0
-
-