org.batoo.jpa.jdbc.adapter

Class JdbcAdaptor

java.lang.Object

org.batoo.jpa.jdbc.adapter.AbstractJdbcAdaptor

org.batoo.jpa.jdbc.adapter.JdbcAdaptor

Direct Known Subclasses:

DerbyAdaptor, H2Adaptor, HsqlAdaptor, MsSqlAdaptor, MySqlAdaptor, OracleAdaptor, PostgreSqlAdaptor, SawSqlAdaptor

public abstract class JdbcAdaptor
extends AbstractJdbcAdaptor

Base class for JDBC Adapters.

Since:

2.0.0

Author:

hceylan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JdbcAdaptor.PaginationParamsOrder The order of pagination paramaters embedded into the SQL.

Constructor Summary

Constructors

Constructor and Description
JdbcAdaptor()

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	createColumnDDL(AbstractColumn columnDefinition) Creates(generates) the BasicColumn Definition DDL for the column.
String	createCreateTableStatement(AbstractTable table, Collection<String> ddlColumns, List<String> pkColumns, List<String> uniqueColumns) Creates the create table statement
void	createForeignKey(DataSource datasource, ForeignKey foreignKey) Creates a foreign key on the table
protected void	createIndex(DataSource datasource, EntityTable table, String indexName, BasicColumn[] columns) Creates the index for the table.
void	createOrUpdateTable(AbstractTable table, DataSource datasource, DDLMode ddlMode) Creates or update the table.
abstract void	createSequenceIfNecessary(DataSource datasource, SequenceGenerator sequence) Creates the sequence if not exists.
void	createTableGeneratorIfNecessary(DataSource datasource, TableGenerator table) Creates the table generator if not exists.
void	dropAllForeignKeys(DataSource datasource, Set<AbstractTable> tableSet)
void	dropAllSequences(DataSource datasource, Collection<SequenceGenerator> sequences)
void	dropAllTables(DataSource datasource, Collection<AbstractTable> tables) Drops the tables in the database
protected void	dropSequence(QueryRunner runner, SequenceGenerator sequence) Drops the sequence.
protected void	dropTable(QueryRunner runner, AbstractTable table) Drops the table
String	escape(String name) Escapes an SQL name
protected Collection<AbstractColumn>	getColumns(AbstractTable table) Returns the sorted columns.
protected String	getColumnType(AbstractColumn cd, int sqlType) Returns the data type of the column.
String	getCurrentDate() Returns the current date literal
String	getCurrentTime() Returns the current time literal
String	getCurrentTimeStamp() Returns the current time stamp literal
protected abstract String	getDatabaseName() Returns the name of the database.
String	getDateTimeFunctionTemplate(DateTimeFunctionType type) Returns the date time function template for the type type.
protected String	getDropForeignKeySql(String schema, String table, String foreignKey) Returns the SQL to drop the foreign key.
int	getInsertBatchSize() Returns the insertBatchSize of the JdbcAdaptor.
abstract long	getNextSequence(DataSource datasource, String sequenceName) Returns next sequence number from the database.
String	getNumericFunctionTemplate(NumericFunctionType type) Returns the numeric function template.
abstract JdbcAdaptor.PaginationParamsOrder	getPaginationParamsOrder() Returns the pagination params order for the adaptor.
protected String	getPkCreateSql(String schema, String table, Set<String> pkColumns) Returns the priary key drop SQL.
protected String	getPkDropSql(String schema, String table, String pkName) Returns the priary key drop SQL.
int	getRemoveBatchSize() Returns the removeBatchSize of the JdbcAdaptor.
abstract String	getSelectLastIdentitySql(BasicColumn identityColumn) Returns the SQL to select the last identity generated.
void	importSql(ClassLoader classLoader, DataSource dataSource, String importSqlFileName) Executes the initial import sql.
protected abstract boolean	isForeignKeyHasDefaultIndex() Underlining DB creates an index for foreign Keys
boolean	isPmdBroken() Returns if the PMD is Broken for the adaptor.
protected boolean	isTableRequiredPrimaryKey() DB forces a primary key or not
protected void	logRelaxed(SQLException e, String message) Logs the message as warning and with exception as debug.
boolean	modifiesParameters() Returns if the JDBC adaptor modifies parameters.
void	modifyParameters(ParameterMetaData pmd, Object[] params) Modifies the parameters.
abstract boolean	paginationNeedsMaxResultsAlways() Returns if pagination always needs the max results paramater.
abstract boolean	paginationNeedsStartAlways() Returns if pagination always needs the start paramater.
boolean	parameterizedPagination() Returns if the paginated sql uses parameters instead of hard coded pagination variables.
protected String	qualified(String schema, String jdbcClassName) Returns the schema if it is set otherwise falls back to the default schema.
void	setInsertBatchSize(int insertBatchSize) Sets the insertBatchSize of the JdbcAdaptor.
void	setRemoveBatchSize(int removeBatchSize) Sets the removeBatchSize of the JdbcAdaptor.
abstract IdType	supports(javax.persistence.GenerationType type) Returns the id type supported.
boolean	supportsNamedParams() Returns if the database supports named params i.e.: select * from mytable field = :p1.
boolean	supportsOrdinalParams() Returns if the database supports ordinal params i.e.: select * from mytable field = ?1.

Methods inherited from class org.batoo.jpa.jdbc.adapter.AbstractJdbcAdaptor

applyCast, applyConcat, applyLikeEscape, applyLock, applyPagination, applySubStr, applyTrim, castBoolean, getAdapter, getCastClassName, getProductNames

Methods inherited from class java.lang.Object

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

Constructor Detail

JdbcAdaptor

public JdbcAdaptor()

Since:

2.0.0

Method Detail

createColumnDDL

public abstract String createColumnDDL(AbstractColumn columnDefinition)

Creates(generates) the BasicColumn Definition DDL for the column.

Parameters:

columnDefinition - the column definition to create the DDL from

Returns:

the BasicColumn Definition DDL For the column

Since:

2.0.0

createCreateTableStatement

public String createCreateTableStatement(AbstractTable table,
                                Collection<String> ddlColumns,
                                List<String> pkColumns,
                                List<String> uniqueColumns)

Creates the create table statement

Parameters:

table - the definition of the table

ddlColumns - the DDL for the columns

pkColumns - the list of primary key column names

uniqueColumns - the list of columns that are unique

Returns:

the generated column fragment

Since:

2.0.0

createForeignKey

public void createForeignKey(DataSource datasource,
                    ForeignKey foreignKey)

Creates a foreign key on the table

Parameters:

datasource - the datasource

foreignKey - the foreign key

Since:

2.0.0

createIndex

protected void createIndex(DataSource datasource,
               EntityTable table,
               String indexName,
               BasicColumn[] columns)
                    throws SQLException

Creates the index for the table.

Parameters:

datasource - the datasource

table - the table

indexName - the name of the index

columns - the columns

Throws:

SQLException - throw in case index creation fails

Since:

2.0.0

createOrUpdateTable

public void createOrUpdateTable(AbstractTable table,
                       DataSource datasource,
                       DDLMode ddlMode)

Creates or update the table.

Parameters:

table - the table

datasource - the datasource

ddlMode - the ddl mode

Since:

2.0.0

createSequenceIfNecessary

public abstract void createSequenceIfNecessary(DataSource datasource,
                             SequenceGenerator sequence)

Creates the sequence if not exists.

Parameters:

datasource - the datasource to use

sequence - the sequence to create

Since:

2.0.0

createTableGeneratorIfNecessary

public final void createTableGeneratorIfNecessary(DataSource datasource,
                                   TableGenerator table)

Creates the table generator if not exists.

Parameters:

datasource - the datasource to use

table - the table generator

Since:

2.0.0

dropAllForeignKeys

public void dropAllForeignKeys(DataSource datasource,
                      Set<AbstractTable> tableSet)

Parameters:

datasource - the datasource

tableSet - the foreign keys

Since:

2.0.0

dropAllSequences

public void dropAllSequences(DataSource datasource,
                    Collection<SequenceGenerator> sequences)
                      throws SQLException

Parameters:

datasource - the datasource

sequences - the sequences

Throws:

SQLException - thrown if the SQL fails

Since:

2.0.0

dropAllTables

public void dropAllTables(DataSource datasource,
                 Collection<AbstractTable> tables)
                   throws SQLException

Drops the tables in the database

Parameters:

datasource - the datasource

tables - the set of tables to drop

Throws:

SQLException - thrown if the SQL fails

Since:

2.0.0

dropSequence

protected void dropSequence(QueryRunner runner,
                SequenceGenerator sequence)
                     throws SQLException

Drops the sequence.

Parameters:

runner - the runner

sequence - the sequence

Throws:

SQLException - thrown if SQL fails

Since:

2.0.0

dropTable

protected void dropTable(QueryRunner runner,
             AbstractTable table)
                  throws SQLException

Drops the table

Parameters:

runner - the runner

table - the table

Throws:

SQLException

Since:

2.0.0

escape

public String escape(String name)

Escapes an SQL name

Parameters:

name - the original name

Returns:

the escaped name

Since:

2.0.0

getColumns

protected Collection<AbstractColumn> getColumns(AbstractTable table)

Returns the sorted columns.

Parameters:

table - the table

Returns:

the sorted columns

Since:

2.0.0

getColumnType

protected String getColumnType(AbstractColumn cd,
                   int sqlType)

Returns the data type of the column.

Parameters:

cd - the column definition

sqlType - the sql type

Returns:

the data type

Since:

2.0.0

getCurrentDate

public String getCurrentDate()

Returns the current date literal

Returns:

the current date literal.

Since:

2.0.0

getCurrentTime

public String getCurrentTime()

Returns the current time literal

Returns:

the current time literal.

Since:

2.0.0

getCurrentTimeStamp

public String getCurrentTimeStamp()

Returns the current time stamp literal

Returns:

the current time stamp literal.

Since:

2.0.0

getDatabaseName

protected abstract String getDatabaseName()

Returns the name of the database.

Returns:

the name of the database

Since:

2.0.0

getDateTimeFunctionTemplate

public String getDateTimeFunctionTemplate(DateTimeFunctionType type)

Returns the date time function template for the type type.

Parameters:

type - the type of the function

Returns:

the date time function template for the type type

Since:

2.0.0

getDropForeignKeySql

protected String getDropForeignKeySql(String schema,
                          String table,
                          String foreignKey)

Returns the SQL to drop the foreign key.

Parameters:

schema - the name of the schema

table - the name of the table

foreignKey - the name of the foreign key

Returns:

the SQL to drop the foreign key

Since:

2.0.0

getInsertBatchSize

public int getInsertBatchSize()

Returns the insertBatchSize of the JdbcAdaptor.

Returns:

the insertBatchSize of the JdbcAdaptor

Since:

2.0.0

getNextSequence

public abstract long getNextSequence(DataSource datasource,
                   String sequenceName)
                              throws SQLException

Returns next sequence number from the database.

Parameters:

datasource - the datasource to use

sequenceName - the name of the sequence

Returns:

the next sequence number

Throws:

SQLException - thrown in case of an SQL error

Since:

2.0.0

getNumericFunctionTemplate

public String getNumericFunctionTemplate(NumericFunctionType type)

Returns the numeric function template.

Parameters:

type - the id type

Returns:

the IdType selected, the Id passed or null

Since:

2.0.0

getPaginationParamsOrder

public abstract JdbcAdaptor.PaginationParamsOrder getPaginationParamsOrder()

Returns the pagination params order for the adaptor.

Returns:

the pagination params order for the adaptor

Since:

2.0.0

getPkCreateSql

protected String getPkCreateSql(String schema,
                    String table,
                    Set<String> pkColumns)

Returns the priary key drop SQL.

Parameters:

schema - the name of the schema

table - the name of the table

pkColumns - the set of the primary key column names

Returns:

the priary key drop SQL

Since:

2.0.0

getPkDropSql

protected String getPkDropSql(String schema,
                  String table,
                  String pkName)

Returns the priary key drop SQL.

Parameters:

schema - the name of the schema

table - the name of the table

pkName - the name of the primary key

Returns:

the priary key drop SQL

Since:

2.0.0

getRemoveBatchSize

public int getRemoveBatchSize()

Returns the removeBatchSize of the JdbcAdaptor.

Returns:

the removeBatchSize of the JdbcAdaptor

Since:

2.0.0

getSelectLastIdentitySql

public abstract String getSelectLastIdentitySql(BasicColumn identityColumn)

Returns the SQL to select the last identity generated.

Parameters:

identityColumn - the identity column

Returns:

the SQL to select the last identity generated

Since:

2.0.0

importSql

public void importSql(ClassLoader classLoader,
             DataSource dataSource,
             String importSqlFileName)

Executes the initial import sql.

Parameters:

classLoader - the class loader

dataSource - the datasource

importSqlFileName - the name of the import sql

Since:

2.0.0

isForeignKeyHasDefaultIndex

protected abstract boolean isForeignKeyHasDefaultIndex()

Underlining DB creates an index for foreign Keys

Returns:

db creates index

Since:

2.0.1

isPmdBroken

public boolean isPmdBroken()

Returns if the PMD is Broken for the adaptor.

Returns:

true if the PMD is Broken for the adaptor, false otherwise

Since:

2.0.0

isTableRequiredPrimaryKey

protected boolean isTableRequiredPrimaryKey()

DB forces a primary key or not

Returns:

is Primary Key required

Since:

2.0.1

logRelaxed

protected void logRelaxed(SQLException e,
              String message)

Logs the message as warning and with exception as debug.

Parameters:

e - the sql exception

message - the message

Since:

2.0.0

modifiesParameters

public boolean modifiesParameters()

Returns if the JDBC adaptor modifies parameters.

Returns:

true if the JDBC adaptor modifies parameters, false otherwise

Since:

2.0.1

modifyParameters

public void modifyParameters(ParameterMetaData pmd,
                    Object[] params)

Modifies the parameters.

The default implementation does nothing.

Individual adaptors are free to modify.

Parameters:

pmd - the statement's parameter metadata

params - the parameters to modify

Since:

2.0.1

paginationNeedsMaxResultsAlways

public abstract boolean paginationNeedsMaxResultsAlways()

Returns if pagination always needs the max results paramater.

Returns:

true if pagination always needs the max results paramater, false otherwise

Since:

2.0.0

paginationNeedsStartAlways

public abstract boolean paginationNeedsStartAlways()

Returns if pagination always needs the start paramater.

Returns:

true if pagination always needs the start paramater, false otherwise

Since:

2.0.0

parameterizedPagination

public boolean parameterizedPagination()

Returns if the paginated sql uses parameters instead of hard coded pagination variables.

Returns:

true if the paginated sql uses parameters instead of hard coded pagination variables, false otherwise

Since:

2.0.0

qualified

protected String qualified(String schema,
               String jdbcClassName)

Returns the schema if it is set otherwise falls back to the default schema.

Parameters:

schema - the schema name

jdbcClassName - the name of the table or sequence

Returns:

the proper schema name

Throws:

SQLException - thrown in case of an SQL error

Since:

2.0.0

setInsertBatchSize

public void setInsertBatchSize(int insertBatchSize)

Sets the insertBatchSize of the JdbcAdaptor.

Parameters:

insertBatchSize - the insertBatchSize to set for JdbcAdaptor

Since:

2.0.0

setRemoveBatchSize

public void setRemoveBatchSize(int removeBatchSize)

Sets the removeBatchSize of the JdbcAdaptor.

Parameters:

removeBatchSize - the removeBatchSize to set for JdbcAdaptor

Since:

2.0.0

supports

public abstract IdType supports(javax.persistence.GenerationType type)

Returns the id type supported.

If the idType is null, the adapter should suggest an IdType in return.

If the idType is some other value than null then the adapter should either return the same IdType if supported or null value in case the adapter does not support the specified IdType.

Parameters:

type - the id type

Returns:

the IdType selected, the Id passed or null

Since:

2.0.0

supportsNamedParams

public boolean supportsNamedParams()

Returns if the database supports named params i.e.: select * from mytable field = :p1.

Returns:

true if the database supports named params, false otherwise

Since:

2.0.1

supportsOrdinalParams

public boolean supportsOrdinalParams()

Returns if the database supports ordinal params i.e.: select * from mytable field = ?1.

Returns:

true if the database supports ordinal params, false otherwise

Since:

2.0.1