org.batoo.jpa.core.jdbc.adapter

Class JdbcAdaptor

java.lang.Object

org.batoo.jpa.core.impl.jdbc.AbstractJdbcAdaptor

org.batoo.jpa.core.jdbc.adapter.JdbcAdaptor

Direct Known Subclasses:

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

public abstract class JdbcAdaptor
extends AbstractJdbcAdaptor

Base class for JDBC Adapters.

Since:

$version

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	applyConcat(List<String> arguments) Applies the concat operation to the arguments.
abstract String	applyLikeEscape(String escapePattern) Appends the escape pattern.
abstract String	applyLock(String sql, LockModeType lockMode) Applies the lock to SQL string.
abstract String	applyPagination(String sql, int startPosition, int maxResult) Applies the pagination to SQL string.
String	applySubStr(String innerFragment, String startFragment, String endFragment) Returns the sub string function.
String	applyTrim(CriteriaBuilder.Trimspec trimspec, String trimChar, String argument) Applies the trim to argument
String	castBoolean(String sqlFragment) Casts the expression to boolean if necessary.
abstract String	createColumnDDL(AbstractColumn columnDefinition) Creates the BasicColumn Definition DDL For the column.
String	createCreateTableStatement(AbstractTable table, List<String> ddlColumns, List<String> pkColumns) Creates the create table statement
void	createForeignKey(DataSourceImpl datasource, ForeignKey foreignKey) Creates a foreign key on the table
protected void	createIndex(DataSourceImpl datasource, EntityTable table, String indexName, BasicColumn[] columns) Creates the index for the table.
void	createOrUpdateTable(AbstractTable table, DataSourceImpl datasource, DDLMode ddlMode) Creates or update the table.
abstract void	createSequenceIfNecessary(DataSource datasource, SequenceGenerator sequence) Creates the sequence if not exists.
void	createTableGeneratorIfNecessary(DataSourceImpl datasource, TableGenerator table) Creates the table generator if not exists.
void	dropAllForeignKeys(DataSourceImpl datasource, Set<AbstractTable> tables)
void	dropAllSequences(DataSourceImpl datasource, Collection<SequenceGenerator> sequences)
void	dropAllTables(DataSourceImpl datasource, Collection<AbstractTable> tables) Drops the tables in the database
protected void	dropSequence(QueryRunner runner, SequenceGenerator sequence) Drops the sequence.
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()
protected String	getDropForeignKeySql(String schema, String table, String foreignKey) Returns the SQL to drop the foreign key.
abstract long	getNextSequence(DataSourceImpl datasource, String sequenceName) Returns next sequence number from the database.
String	getNumericFunctionTemplate(NumericFunctionExpression.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.
abstract String	getSelectLastIdentitySql(PkColumn identityColumn) Returns the SQL to select the last identity generated.
boolean	isPmdBroken() Returns if the PMD is Broken for the adaptor.
protected void	logRelaxed(SQLException e, String message) Logs the message as warning and with exception as debug.
abstract boolean	paginationNeedsMaxResultsAlways() Returns if pagination always needs the max results paramater.
abstract boolean	paginationNeedsStartAlways() Returns if pagination always needs the start paramater.
protected String	qualified(String schema, String jdbcClassName) Returns the schema if it is set otherwise falls back to the default schema.
abstract IdType	supports(GenerationType type) Returns the id type supported.

Methods inherited from class org.batoo.jpa.core.impl.jdbc.AbstractJdbcAdaptor

getAdapter, 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:

$version

Method Detail

applyConcat

public abstract String applyConcat(List<String> arguments)

Applies the concat operation to the arguments.

Parameters:

arguments - the arguments

Returns:

the concat SQL fragment

Since:

$version

applyLikeEscape

public abstract String applyLikeEscape(String escapePattern)

Appends the escape pattern.

Parameters:

escapePattern - the escape pattern

Returns:

the sql fragment to escape

Since:

$version

applyLock

public abstract String applyLock(String sql,
               LockModeType lockMode)

Applies the lock to SQL string.

Parameters:

sql - the SQL to apply

lockMode - the lock mode

Returns:

the modified SQL

Since:

$version

applyPagination

public abstract String applyPagination(String sql,
                     int startPosition,
                     int maxResult)

Applies the pagination to SQL string.

Parameters:

sql - the SQL to apply

startPosition - the start position

maxResult - the max number of results

Returns:

the modified SQL

Since:

$version

applySubStr

public String applySubStr(String innerFragment,
                 String startFragment,
                 String endFragment)

Returns the sub string function.

Parameters:

innerFragment - the inner fragment

startFragment - the start fragment

endFragment - the end fragment

Returns:

the sub string function

Since:

$version

applyTrim

public String applyTrim(CriteriaBuilder.Trimspec trimspec,
               String trimChar,
               String argument)

Applies the trim to argument

Parameters:

trimspec - the trim spec

trimChar - the trim character

argument - the argument

Returns:

the trim SQL fragment

Since:

$version

castBoolean

public String castBoolean(String sqlFragment)

Casts the expression to boolean if necessary.

Parameters:

sqlFragment - the SQL Fragment

Returns:

the cast SQL fragment

createColumnDDL

public abstract String createColumnDDL(AbstractColumn columnDefinition)

Creates 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:

$version

createCreateTableStatement

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

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

Returns:

the generated column fragment

Since:

$version

createForeignKey

public void createForeignKey(DataSourceImpl datasource,
                    ForeignKey foreignKey)

Creates a foreign key on the table

Parameters:

datasource - the datasource

foreignKey - the foreign key

Since:

$version

createIndex

protected void createIndex(DataSourceImpl 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:

$version

createOrUpdateTable

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

Creates or update the table.

Parameters:

table - the table

datasource - the datasource

ddlMode - the ddl mode

Since:

$version

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:

$version

createTableGeneratorIfNecessary

public final void createTableGeneratorIfNecessary(DataSourceImpl datasource,
                                   TableGenerator table)

Creates the table generator if not exists.

Parameters:

datasource - the datasource to use

table - the table generator

Since:

$version

dropAllForeignKeys

public void dropAllForeignKeys(DataSourceImpl datasource,
                      Set<AbstractTable> tables)

Parameters:

datasource - the datasource

tables - the foreign keys

Since:

$version

dropAllSequences

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

Parameters:

datasource - the datasource

sequences - the sequences

Throws:

SQLException - thrown if the SQL fails

Since:

$version

dropAllTables

public void dropAllTables(DataSourceImpl 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:

$version

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:

$version

escape

public String escape(String name)

Escapes an SQL name

Parameters:

name - the original name

Returns:

the escaped name

Since:

$version

getColumns

protected Collection<AbstractColumn> getColumns(AbstractTable table)

Returns the sorted columns.

Parameters:

table - the table

Returns:

the sorted columns

Since:

$version

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:

$version

getCurrentDate

public String getCurrentDate()

Returns the current date literal

Returns:

the current date literal.

Since:

$version

getCurrentTime

public String getCurrentTime()

Returns the current time literal

Returns:

the current time literal.

Since:

$version

getCurrentTimeStamp

public String getCurrentTimeStamp()

Returns the current time stamp literal

Returns:

the current time stamp literal.

Since:

$version

getDatabaseName

protected abstract String getDatabaseName()

Returns:

Since:

$version

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:

$version

getNextSequence

public abstract long getNextSequence(DataSourceImpl 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:

$version

getNumericFunctionTemplate

public String getNumericFunctionTemplate(NumericFunctionExpression.NumericFunctionType type)

Returns the numeric function template.

Parameters:

type - the id type

Returns:

the IdType selected, the Id passed or null

Since:

$version

getPaginationParamsOrder

public abstract JdbcAdaptor.PaginationParamsOrder getPaginationParamsOrder()

Returns the pagination params order for the adaptor.

Returns:

the pagination params order for the adaptor

Since:

$version

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:

$version

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:

$version

getSelectLastIdentitySql

public abstract String getSelectLastIdentitySql(PkColumn 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:

$version

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:

$version

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:

$version

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:

$version

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:

$version

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:

$version

supports

public abstract IdType supports(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:

$version