|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.cayenne.dba.JdbcAdapter
public class JdbcAdapter
A generic DbAdapter implementation. Can be used as a default adapter or as a superclass of a concrete adapter implementation.
| Field Summary | |
|---|---|
protected BatchQueryBuilderFactory |
batchQueryBuilderFactory
|
protected boolean |
caseInsensitiveCollations
|
static java.lang.String |
CI_PROPERTY
|
protected EJBQLTranslatorFactory |
ejbqlTranslatorFactory
|
protected ExtendedTypeMap |
extendedTypes
|
protected java.lang.String |
identifiersEndQuote
|
protected java.lang.String |
identifiersStartQuote
|
protected JdbcEventLogger |
logger
|
protected ResourceLocator |
resourceLocator
|
protected boolean |
supportsBatchUpdates
|
protected boolean |
supportsGeneratedKeys
|
protected boolean |
supportsUniqueConstraints
|
protected TypesHandler |
typesHandler
|
| Constructor Summary | |
|---|---|
JdbcAdapter(RuntimeProperties runtimeProperties,
java.util.List<ExtendedType> defaultExtendedTypes,
java.util.List<ExtendedType> userExtendedTypes,
java.util.List<ExtendedTypeFactory> extendedTypeFactories)
Creates new JdbcAdapter with a set of default parameters. |
|
| Method Summary | |
|---|---|
void |
bindParameter(java.sql.PreparedStatement statement,
java.lang.Object object,
int pos,
int sqlType,
int scale)
Binds an object value to PreparedStatement's numbered parameter. |
DbAttribute |
buildAttribute(java.lang.String name,
java.lang.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 void |
configureExtendedTypes(ExtendedTypeMap map)
Called from initExtendedTypes(List, List, List) 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. |
java.lang.String |
createFkConstraint(DbRelationship rel)
Returns a SQL string that can be used to create a foreign key constraint for the relationship. |
protected PkGenerator |
createPkGenerator()
Creates and returns a primary key generator. |
java.lang.String |
createTable(DbEntity entity)
Returns a SQL string that can be used to create database table corresponding to ent parameter. |
void |
createTableAppendColumn(java.lang.StringBuffer sqlBuffer,
DbAttribute column)
Appends SQL for column creation to CREATE TABLE buffer. |
protected void |
createTableAppendPKClause(java.lang.StringBuffer sqlBuffer,
DbEntity entity)
|
java.lang.String |
createUniqueConstraint(DbEntity source,
java.util.Collection<DbAttribute> columns)
Returns a DDL string to create a unique constraint over a set of columns. |
java.util.Collection<java.lang.String> |
dropTableStatements(DbEntity table)
Returns a collection of SQL statements needed to drop a database table. |
java.lang.String[] |
externalTypesForJdbcType(int type)
Returns an array of RDBMS types that can be used with JDBC type. |
protected java.net.URL |
findResource(java.lang.String name)
Locates and returns a named adapter resource. |
SQLAction |
getAction(Query query,
DataNode node)
Uses JdbcActionBuilder to create the right action. |
BatchQueryBuilderFactory |
getBatchQueryBuilderFactory()
|
java.lang.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. |
java.lang.String |
getIdentifiersEndQuote()
|
java.lang.String |
getIdentifiersStartQuote()
|
JdbcEventLogger |
getJdbcEventLogger()
|
PkGenerator |
getPkGenerator()
Returns primary key generator associated with this DbAdapter. |
QualifierTranslator |
getQualifierTranslator(QueryAssembler queryAssembler)
Creates and returns a default implementation of a qualifier translator. |
QuotingStrategy |
getQuotingStrategy(boolean needQuotes)
|
protected void |
initExtendedTypes(java.util.List<ExtendedType> defaultExtendedTypes,
java.util.List<ExtendedType> userExtendedTypes,
java.util.List<ExtendedTypeFactory> extendedTypeFactories)
|
protected void |
initIdentifiersQuotes()
|
MergerFactory |
mergerFactory()
|
void |
setBatchQueryBuilderFactory(BatchQueryBuilderFactory batchQueryBuilderFactory)
|
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)
|
boolean |
supportsBatchUpdates()
Returns true if the target database supports batch updates. |
boolean |
supportsGeneratedKeys()
Returns true if a target database supports key autogeneration. |
boolean |
supportsUniqueConstraints()
Returns true. |
java.lang.String |
tableTypeForTable()
Returns the name of the table type (as returned by DatabaseMetaData.getTableTypes) for a simple user table. |
java.lang.String |
tableTypeForView()
Returns the name of the table type (as returned by DatabaseMetaData.getTableTypes) for a view table. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String CI_PROPERTY
protected TypesHandler typesHandler
protected ExtendedTypeMap extendedTypes
protected boolean supportsBatchUpdates
protected boolean supportsUniqueConstraints
protected boolean supportsGeneratedKeys
protected EJBQLTranslatorFactory ejbqlTranslatorFactory
protected java.lang.String identifiersStartQuote
protected java.lang.String identifiersEndQuote
protected ResourceLocator resourceLocator
protected boolean caseInsensitiveCollations
protected BatchQueryBuilderFactory batchQueryBuilderFactory
protected JdbcEventLogger logger
| Constructor Detail |
|---|
public JdbcAdapter(RuntimeProperties runtimeProperties,
java.util.List<ExtendedType> defaultExtendedTypes,
java.util.List<ExtendedType> userExtendedTypes,
java.util.List<ExtendedTypeFactory> extendedTypeFactories)
| Method Detail |
|---|
public java.lang.String getIdentifiersStartQuote()
public java.lang.String getIdentifiersEndQuote()
public java.lang.String getBatchTerminator()
getBatchTerminator in interface DbAdapterpublic JdbcEventLogger getJdbcEventLogger()
protected java.net.URL findResource(java.lang.String name)
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.
protected void configureExtendedTypes(ExtendedTypeMap map)
initExtendedTypes(List, List, List) 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.
protected void initExtendedTypes(java.util.List<ExtendedType> defaultExtendedTypes,
java.util.List<ExtendedType> userExtendedTypes,
java.util.List<ExtendedTypeFactory> extendedTypeFactories)
protected PkGenerator createPkGenerator()
protected EJBQLTranslatorFactory createEJBQLTranslatorFactory()
EJBQLTranslatorFactory used to generate visitors for
EJBQL to SQL translations. This method should be overriden by subclasses that need
to customize EJBQL generation.
public PkGenerator getPkGenerator()
getPkGenerator in interface DbAdapterpublic void setPkGenerator(PkGenerator pkGenerator)
public boolean supportsUniqueConstraints()
supportsUniqueConstraints in interface DbAdapterpublic void setSupportsUniqueConstraints(boolean flag)
public java.util.Collection<java.lang.String> dropTableStatements(DbEntity table)
DbAdapter
dropTableStatements in interface DbAdapterpublic java.lang.String createTable(DbEntity entity)
ent parameter.
createTable in interface DbAdapter
protected void createTableAppendPKClause(java.lang.StringBuffer sqlBuffer,
DbEntity entity)
public void createTableAppendColumn(java.lang.StringBuffer sqlBuffer,
DbAttribute column)
createTableAppendColumn in interface DbAdaptersqlBuffer - the StringBuffer to append the column type tocolumn - the DbAttribute defining the column to append type for
public java.lang.String createUniqueConstraint(DbEntity source,
java.util.Collection<DbAttribute> columns)
createUniqueConstraint in interface DbAdapterpublic java.lang.String createFkConstraint(DbRelationship rel)
createFkConstraint in interface DbAdapterpublic java.lang.String[] externalTypesForJdbcType(int type)
DbAdaptertype. Valid
JDBC types are defined in java.sql.Types.
externalTypesForJdbcType in interface DbAdapterpublic ExtendedTypeMap getExtendedTypes()
DbAdapter
getExtendedTypes in interface DbAdapter
public DbAttribute buildAttribute(java.lang.String name,
java.lang.String typeName,
int type,
int size,
int scale,
boolean allowNulls)
DbAdapter
buildAttribute in interface DbAdaptername - 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 parameterpublic java.lang.String tableTypeForTable()
DbAdapterDatabaseMetaData.getTableTypes) for a simple user table.
tableTypeForTable in interface DbAdapterpublic java.lang.String tableTypeForView()
DbAdapterDatabaseMetaData.getTableTypes) for a view table.
tableTypeForView in interface DbAdapterpublic QualifierTranslator getQualifierTranslator(QueryAssembler queryAssembler)
getQualifierTranslator in interface DbAdapter
public SQLAction getAction(Query query,
DataNode node)
getAction in interface DbAdapter
public void bindParameter(java.sql.PreparedStatement statement,
java.lang.Object object,
int pos,
int sqlType,
int scale)
throws java.sql.SQLException,
java.lang.Exception
DbAdapter
bindParameter in interface DbAdapterjava.sql.SQLException
java.lang.Exceptionpublic boolean supportsBatchUpdates()
DbAdaptertrue if the target database supports batch updates.
supportsBatchUpdates in interface DbAdapterpublic void setSupportsBatchUpdates(boolean flag)
public boolean supportsGeneratedKeys()
DbAdapter
supportsGeneratedKeys in interface DbAdapterpublic void setSupportsGeneratedKeys(boolean flag)
public EJBQLTranslatorFactory getEjbqlTranslatorFactory()
createEJBQLTranslatorFactory(), and can be overridden by calling
setEjbqlTranslatorFactory(EJBQLTranslatorFactory).
public void setEjbqlTranslatorFactory(EJBQLTranslatorFactory ejbqlTranslatorFactory)
createEJBQLTranslatorFactory(), so
users would only override it if they need to customize EJBQL translation.
public MergerFactory mergerFactory()
mergerFactory in interface DbAdapterprotected void initIdentifiersQuotes()
public QuotingStrategy getQuotingStrategy(boolean needQuotes)
getQuotingStrategy in interface DbAdapterpublic BatchQueryBuilderFactory getBatchQueryBuilderFactory()
public void setBatchQueryBuilderFactory(BatchQueryBuilderFactory batchQueryBuilderFactory)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||