org.seasar.doma.jdbc.dialect

Class StandardDialect

java.lang.Object

org.seasar.doma.jdbc.dialect.StandardDialect

All Implemented Interfaces:

Dialect

Direct Known Subclasses:

Db2Dialect, H212126Dialect, HsqldbDialect, Mssql2008Dialect, MysqlDialect, Oracle11Dialect, PostgresDialect, SqliteDialect

public class StandardDialect
extends java.lang.Object
implements Dialect

A standard implementation of Dialect.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StandardDialect.StandardCriteriaBuilder
static class	StandardDialect.StandardExpressionFunctions A standard implementation of ExpressionFunctions.
static class	StandardDialect.StandardJdbcMappingVisitor
static class	StandardDialect.StandardScriptBlockContext A standard implementation of ScriptBlockContext.
static class	StandardDialect.StandardSqlLogFormattingVisitor

Field Summary

Fields

Modifier and Type	Field and Description
protected static char	CLOSE_QUOTE the quotation mark of the end
protected ExpressionFunctions	expressionFunctions the aggregation of expression functions
protected JdbcMappingVisitor	jdbcMappingVisitor the visitor that maps Wrapper to JdbcType
protected static char	OPEN_QUOTE the quotation mark of the start
protected SqlLogFormattingVisitor	sqlLogFormattingVisitor the visitor that maps Wrapper to SqlLogFormatter
protected static java.util.Set<java.lang.String>	UNIQUE_CONSTRAINT_VIOLATION_STATE_CODES the set of SQLState code that represents unique violation

Constructor Summary

Constructors

Constructor and Description
StandardDialect()
StandardDialect(ExpressionFunctions expressionFunctions)
StandardDialect(JdbcMappingVisitor jdbcMappingVisitor)
StandardDialect(JdbcMappingVisitor jdbcMappingVisitor, SqlLogFormattingVisitor sqlLogFormattingVisitor)
StandardDialect(JdbcMappingVisitor jdbcMappingVisitor, SqlLogFormattingVisitor sqlLogFormattingVisitor, ExpressionFunctions expressionFunctions)
StandardDialect(SqlLogFormattingVisitor sqlLogFormattingVisitor)

Method Summary

Modifier and Type	Method and Description
java.lang.String	applyQuote(java.lang.String name) Enclose the name with quotation marks.
ScriptBlockContext	createScriptBlockContext() Creates the context object to process an SQL block in a script.
AutoGeneratedKeysType	getAutoGeneratedKeysType() Returns the type of the auto generated keys.
protected java.sql.SQLException	getCauseSQLException(java.sql.SQLException sqlException)
CriteriaBuilder	getCriteriaBuilder()
protected int	getErrorCode(java.sql.SQLException sqlException)
ExpressionFunctions	getExpressionFunctions() Returns the aggregation of the expression functions that are available in the SQL templates.
Sql<?>	getIdentityReservationSql(java.lang.String catalogName, java.lang.String schemaName, java.lang.String tableName, java.lang.String columnName, boolean isQuoteRequired, boolean isIdColumnQuoteRequired, int reservationSize) Returns an SQL object to reserve identity in the database.
Sql<?>	getIdentitySelectSql(java.lang.String catalogName, java.lang.String schemaName, java.lang.String tableName, java.lang.String columnName, boolean isQuoteRequired, boolean isIdColumnQuoteRequired) Returns an SQL object to get IDENTITY values that are generated in the database.
JdbcMappingVisitor	getJdbcMappingVisitor() Returns the visitor that maps Wrapper to JdbcType.
java.lang.String	getName() The dialect name.
JdbcType<java.sql.ResultSet>	getResultSetType() Returns the JdbcType object that corresponds to the ResultSet class.
java.lang.Throwable	getRootCause(java.sql.SQLException sqlException) Returns the root cause of the SQL exception.
java.lang.String	getScriptBlockDelimiter() Return the delimiter that is used as the end of an SQL block in a script.
PreparedSql	getSequenceNextValSql(java.lang.String qualifiedSequenceName, long allocationSize) Returns an SQL object to get next sequence values.
SqlLogFormattingVisitor	getSqlLogFormattingVisitor() Return the visitor that maps Wrapper to SqlLogFormatter.
protected java.lang.String	getSQLState(java.sql.SQLException sqlException)
UpsertAssembler	getUpsertAssembler(UpsertAssemblerContext context) Returns the UpsertAssembler implementation for the given context.
boolean	includesIdentityColumn() Whether this object includes the IDENTITY column in SQL INSERT statements.
boolean	isUniqueConstraintViolated(java.sql.SQLException sqlException) Whether the sqlException represents an unique violation.
java.lang.String	removeQuote(java.lang.String name) Remove quotation marks from the name
boolean	supportsAutoGeneratedKeys() Whether this object supports Statement.getGeneratedKeys().
boolean	supportsBatchUpdateResults() Whether this object supports the result of Statement.executeBatch().
boolean	supportsIdentity() Whether this object supports the IDENTITY column.
boolean	supportsIdentityReservation() Whether this object supports a reservation of identity.
boolean	supportsResultSetReturningAsOutParameter() Whether this object supports an out parameter that is mapped to a result set in stored functions or stored procedures .
boolean	supportsSelectForUpdate(SelectForUpdateType type, boolean withTargets) Whether this object supports pessimistic locking.
boolean	supportsSequence() Whether this object supports the SEQUENCE.
protected SqlNode	toCountCalculatingSqlNode(SqlNode sqlNode)
protected SqlNode	toCountGettingSqlNode(SqlNode sqlNode)
protected SqlNode	toForUpdateSqlNode(SqlNode sqlNode, SelectForUpdateType forUpdateType, int waitSeconds, java.lang.String... aliases)
protected SqlNode	toPagingSqlNode(SqlNode sqlNode, long offset, long limit)
SqlNode	transformSelectSqlNode(SqlNode sqlNode, SelectOptions options) Transforms the SQL node.
SqlNode	transformSelectSqlNodeForGettingCount(SqlNode sqlNode) Transforms the SQL node to get a row count.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.seasar.doma.jdbc.dialect.Dialect

supportsAliasInDeleteClause, supportsAliasInUpdateClause, supportsBatchExecutionReturningGeneratedValues, supportsModOperator

Field Detail

OPEN_QUOTE

protected static final char OPEN_QUOTE

the quotation mark of the start

See Also:

Constant Field Values

CLOSE_QUOTE

protected static final char CLOSE_QUOTE

the quotation mark of the end

See Also:

Constant Field Values

UNIQUE_CONSTRAINT_VIOLATION_STATE_CODES

protected static final java.util.Set<java.lang.String> UNIQUE_CONSTRAINT_VIOLATION_STATE_CODES

the set of SQLState code that represents unique violation

jdbcMappingVisitor

protected final JdbcMappingVisitor jdbcMappingVisitor

the visitor that maps Wrapper to JdbcType

sqlLogFormattingVisitor

protected final SqlLogFormattingVisitor sqlLogFormattingVisitor

the visitor that maps Wrapper to SqlLogFormatter

expressionFunctions

protected final ExpressionFunctions expressionFunctions

the aggregation of expression functions

Constructor Detail

StandardDialect

public StandardDialect()

StandardDialect

public StandardDialect(JdbcMappingVisitor jdbcMappingVisitor)

StandardDialect

public StandardDialect(SqlLogFormattingVisitor sqlLogFormattingVisitor)

StandardDialect

public StandardDialect(ExpressionFunctions expressionFunctions)

StandardDialect

public StandardDialect(JdbcMappingVisitor jdbcMappingVisitor,
                       SqlLogFormattingVisitor sqlLogFormattingVisitor)

StandardDialect

public StandardDialect(JdbcMappingVisitor jdbcMappingVisitor,
                       SqlLogFormattingVisitor sqlLogFormattingVisitor,
                       ExpressionFunctions expressionFunctions)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Dialect

The dialect name.

Specified by:

getName in interface Dialect

Returns:

the name

transformSelectSqlNode

public SqlNode transformSelectSqlNode(SqlNode sqlNode,
                                      SelectOptions options)

Description copied from interface: Dialect

Transforms the SQL node.

Specified by:

transformSelectSqlNode in interface Dialect

Parameters:

sqlNode - the SQL node

options - the options

Returns:

the transformed node

toCountCalculatingSqlNode

protected SqlNode toCountCalculatingSqlNode(SqlNode sqlNode)

toPagingSqlNode

protected SqlNode toPagingSqlNode(SqlNode sqlNode,
                                  long offset,
                                  long limit)

toForUpdateSqlNode

protected SqlNode toForUpdateSqlNode(SqlNode sqlNode,
                                     SelectForUpdateType forUpdateType,
                                     int waitSeconds,
                                     java.lang.String... aliases)

transformSelectSqlNodeForGettingCount

public SqlNode transformSelectSqlNodeForGettingCount(SqlNode sqlNode)

Description copied from interface: Dialect

Transforms the SQL node to get a row count.

Specified by:

transformSelectSqlNodeForGettingCount in interface Dialect

Parameters:

sqlNode - the SQL node

Returns:

the transformed node

toCountGettingSqlNode

protected SqlNode toCountGettingSqlNode(SqlNode sqlNode)

isUniqueConstraintViolated

public boolean isUniqueConstraintViolated(java.sql.SQLException sqlException)

Description copied from interface: Dialect

Whether the sqlException represents an unique violation.

Specified by:

isUniqueConstraintViolated in interface Dialect

Parameters:

sqlException - the SQL exception

Returns:

true, if the sqlException represents an unique violation

getSQLState

protected java.lang.String getSQLState(java.sql.SQLException sqlException)

getErrorCode

protected int getErrorCode(java.sql.SQLException sqlException)

getCauseSQLException

protected java.sql.SQLException getCauseSQLException(java.sql.SQLException sqlException)

getRootCause

public java.lang.Throwable getRootCause(java.sql.SQLException sqlException)

Description copied from interface: Dialect

Returns the root cause of the SQL exception.

Specified by:

getRootCause in interface Dialect

Parameters:

sqlException - the SQL exception

Returns:

the root cause

supportsAutoGeneratedKeys

public boolean supportsAutoGeneratedKeys()

Description copied from interface: Dialect

Whether this object supports Statement.getGeneratedKeys().

Specified by:

supportsAutoGeneratedKeys in interface Dialect

Returns:

true, if this object supports it

supportsBatchUpdateResults

public boolean supportsBatchUpdateResults()

Description copied from interface: Dialect

Whether this object supports the result of Statement.executeBatch().

Specified by:

supportsBatchUpdateResults in interface Dialect

Returns:

true, if this object supports it

supportsIdentity

public boolean supportsIdentity()

Description copied from interface: Dialect

Whether this object supports the IDENTITY column.

Specified by:

supportsIdentity in interface Dialect

Returns:

true, if this object supports it

supportsSequence

public boolean supportsSequence()

Description copied from interface: Dialect

Whether this object supports the SEQUENCE.

Specified by:

supportsSequence in interface Dialect

Returns:

true, if this object supports it

supportsIdentityReservation

public boolean supportsIdentityReservation()

Description copied from interface: Dialect

Whether this object supports a reservation of identity.

Specified by:

supportsIdentityReservation in interface Dialect

Returns:

true, if this object supports it

includesIdentityColumn

public boolean includesIdentityColumn()

Description copied from interface: Dialect

Whether this object includes the IDENTITY column in SQL INSERT statements.

Specified by:

includesIdentityColumn in interface Dialect

Returns:

true, if this object includes it

supportsSelectForUpdate

public boolean supportsSelectForUpdate(SelectForUpdateType type,
                                       boolean withTargets)

Description copied from interface: Dialect

Whether this object supports pessimistic locking.

Specified by:

supportsSelectForUpdate in interface Dialect

Parameters:

type - a kind of pessimistic locking

withTargets - true if a lock target is specified

Returns:

true, if this object supports it

supportsResultSetReturningAsOutParameter

public boolean supportsResultSetReturningAsOutParameter()

Description copied from interface: Dialect

Whether this object supports an out parameter that is mapped to a result set in stored functions or stored procedures .

Specified by:

supportsResultSetReturningAsOutParameter in interface Dialect

Returns:

true, if this object supports it

getResultSetType

public JdbcType<java.sql.ResultSet> getResultSetType()

Description copied from interface: Dialect

Returns the JdbcType object that corresponds to the ResultSet class.

This method is available, only if Dialect.supportsResultSetReturningAsOutParameter() is true.

Specified by:

getResultSetType in interface Dialect

Returns:

the JdbcType object for the ResultSet class

getIdentitySelectSql

public Sql<?> getIdentitySelectSql(java.lang.String catalogName,
                                   java.lang.String schemaName,
                                   java.lang.String tableName,
                                   java.lang.String columnName,
                                   boolean isQuoteRequired,
                                   boolean isIdColumnQuoteRequired)

Description copied from interface: Dialect

Returns an SQL object to get IDENTITY values that are generated in the database.

This method is available, only if Dialect.supportsIdentity() returns true.

Specified by:

getIdentitySelectSql in interface Dialect

Parameters:

catalogName - the catalog name

schemaName - the schema name

tableName - the table name

columnName - the IDENTITY column name

isQuoteRequired - whether the quotation marks are required

isIdColumnQuoteRequired - whether the quotation marks are required for the IDENTITY column

Returns:

the SQL object

getIdentityReservationSql

public Sql<?> getIdentityReservationSql(java.lang.String catalogName,
                                        java.lang.String schemaName,
                                        java.lang.String tableName,
                                        java.lang.String columnName,
                                        boolean isQuoteRequired,
                                        boolean isIdColumnQuoteRequired,
                                        int reservationSize)

Description copied from interface: Dialect

Returns an SQL object to reserve identity in the database.

This method is available, only if Dialect.supportsIdentityReservation() returns true.

Specified by:

getIdentityReservationSql in interface Dialect

Parameters:

catalogName - the catalog name

schemaName - the schema name

tableName - the table name

columnName - the IDENTITY column name

isQuoteRequired - whether the quotation marks are required

isIdColumnQuoteRequired - whether the quotation marks are required for the IDENTITY column

reservationSize - the size of the reservation

Returns:

the SQL object

getSequenceNextValSql

public PreparedSql getSequenceNextValSql(java.lang.String qualifiedSequenceName,
                                         long allocationSize)

Description copied from interface: Dialect

Returns an SQL object to get next sequence values.

This method is available, only if Dialect.supportsSequence() returns true.

Specified by:

getSequenceNextValSql in interface Dialect

Parameters:

qualifiedSequenceName - the qualified sequence name

allocationSize - the allocation size of the sequence

Returns:

the SQL object

applyQuote

public java.lang.String applyQuote(java.lang.String name)

Description copied from interface: Dialect

Enclose the name with quotation marks.

Specified by:

applyQuote in interface Dialect

Parameters:

name - the name of a database object such as a table, a column, and so on

Returns:

the name that is enclosed with quotation marks

removeQuote

public java.lang.String removeQuote(java.lang.String name)

Description copied from interface: Dialect

Remove quotation marks from the name

Specified by:

removeQuote in interface Dialect

Parameters:

name - the name of a database object such as a table, a column, and so on

Returns:

the name that has no enclosing quotation marks

getJdbcMappingVisitor

public JdbcMappingVisitor getJdbcMappingVisitor()

Description copied from interface: Dialect

Returns the visitor that maps Wrapper to JdbcType.

Specified by:

getJdbcMappingVisitor in interface Dialect

Returns:

the visitor

getSqlLogFormattingVisitor

public SqlLogFormattingVisitor getSqlLogFormattingVisitor()

Description copied from interface: Dialect

Return the visitor that maps Wrapper to SqlLogFormatter.

Specified by:

getSqlLogFormattingVisitor in interface Dialect

Returns:

the visitor

getExpressionFunctions

public ExpressionFunctions getExpressionFunctions()

Description copied from interface: Dialect

Returns the aggregation of the expression functions that are available in the SQL templates.

Specified by:

getExpressionFunctions in interface Dialect

Returns:

the aggregation of the expression functions

createScriptBlockContext

public ScriptBlockContext createScriptBlockContext()

Description copied from interface: Dialect

Creates the context object to process an SQL block in a script.

Specified by:

createScriptBlockContext in interface Dialect

Returns:

the context object

getScriptBlockDelimiter

public java.lang.String getScriptBlockDelimiter()

Description copied from interface: Dialect

Return the delimiter that is used as the end of an SQL block in a script.

Specified by:

getScriptBlockDelimiter in interface Dialect

Returns:

the delimiter

getAutoGeneratedKeysType

public AutoGeneratedKeysType getAutoGeneratedKeysType()

Description copied from interface: Dialect

Returns the type of the auto generated keys.

Specified by:

getAutoGeneratedKeysType in interface Dialect

Returns:

the type of the auto generated keys

getCriteriaBuilder

public CriteriaBuilder getCriteriaBuilder()

Specified by:

getCriteriaBuilder in interface Dialect

getUpsertAssembler

public UpsertAssembler getUpsertAssembler(UpsertAssemblerContext context)

Description copied from interface: Dialect

Returns the UpsertAssembler implementation for the given context.

Specified by:

getUpsertAssembler in interface Dialect

Parameters:

context - the UpsertAssemblerContext object

Returns:

the UpsertAssembler object for the given context