AbstractDialect (ymate-platform-v2-码云(gitee.com))

java.lang.Object
- net.ymate.platform.persistence.jdbc.dialect.AbstractDialect

All Implemented Interfaces:

IDialect

Direct Known Subclasses:

DB2Dialect, H2Dialect, HSQLDBDialect, MySQLDialect, OracleDialect, PostgreSQLDialect, SQLiteDialect, SQLServerDialect
```
public abstract class AbstractDialect
extends Object
implements IDialect
```
数据库方言接口抽象实现

Author:

刘镇 (suninformation@163.com) on 2011-8-30 下午01:55:13

Constructor Summary

Constructors
Constructor and Description

AbstractDialect()

AbstractDialect(String identifierQuoteBegin, String identifierQuoteEnd)

Constructors
Constructor and Description
`AbstractDialect()`
`AbstractDialect(String identifierQuoteBegin, String identifierQuoteEnd)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`buildCountSQL(String originSql)` 构建计算查询结果总记录数量的SQL语句
`String`	`buildCreateSql(Class<? extends IEntity> entityClass, String prefix, IShardingable shardingable)` 构建创建实体数据表SQL语句
`String`	`buildDeleteByPkSql(Class<? extends IEntity> entityClass, String prefix, IShardingable shardingable, Fields pkFields)` 构建删除实体数据记录SQL语句
`String`	`buildDropSql(Class<? extends IEntity> entityClass, String prefix, IShardingable shardingable)` 构建删除实体数据表SQL语句
`String`	`buildInsertSql(Class<? extends IEntity> entityClass, String prefix, IShardingable shardingable, Fields fields)` 构建插入实体数据记录SQL语句
`String`	`buildPagedQuerySql(String originSql, int page, int pageSize)` 构建分页SQL语句
`String`	`buildSelectByPkSql(Class<? extends IEntity> entityClass, String prefix, IShardingable shardingable, Fields pkFields, Fields fields)` 构建根据主键查询实体数据记录SQL语句
`String`	`buildSelectSql(Class<? extends IEntity> entityClass, String prefix, IShardingable shardingable, Fields fields)` 构建查询全部实体数据记录SQL语句
`String`	`buildTableName(String prefix, EntityMeta entityMeta, IShardingable shardingable)` 获取完整的数据表名称，并根据数据库特性决定是否添加引用标识符
`String`	`buildTableName(String prefix, String tableName, IShardingRule shardingRule, IShardingable shardingable)` 获取完整的数据表名称，并根据数据库特性决定是否添加引用标识符
`String`	`buildUpdateByPkSql(Class<? extends IEntity> entityClass, String prefix, IShardingable shardingable, Fields pkFields, Fields fields)` 构建更新实体数据记录SQL语句
`protected String`	`doGenerateFieldsFormatStr(Fields fields, String suffix, String separator)`
`protected String`	`doRemoveOrderByElements(String originSql)`
`protected void`	`doValidProperty(EntityMeta entityMeta, Fields fields, boolean isPrimaryKeys)` 验证字段是否合法有效
`Map<String,Object>`	`getGeneratedKey(Statement statement, List<String> autoincrementKeys)` 获取自增主键值（按 Long 类型返回），采用JDBC Statement对象获取自动生成的主键（仅处理单主键）
`String`	`getIdentifierQuoteBegin()` 获取引用标识符
`String`	`getIdentifierQuoteEnd()` 获取引用标识符
`String`	`getSequenceNextValSql(String sequenceName)` 获取下一序列值的SQL语句
`boolean`	`hasIdentifierQuote()` 是否存在引用标识符
`void`	`setIdentifierQuote(String identifierQuoteBegin, String identifierQuoteEnd)` 设置引用标识符
`String`	`wrapIdentifierQuote(String origin)` 添加引用标识符的字段或表名称，防止字段或表名与关键字冲突，此接口方法默认实现按原样返回

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.ymate.platform.persistence.jdbc.dialect.IDialect
getName

- Constructor Detail
  - AbstractDialect
```
public AbstractDialect()
```
  - AbstractDialect
```
public AbstractDialect(String identifierQuoteBegin,
                       String identifierQuoteEnd)
```
- Method Detail
  - wrapIdentifierQuote
```
public String wrapIdentifierQuote(String origin)
```
    Description copied from interface: IDialect
    
    添加引用标识符的字段或表名称，防止字段或表名与关键字冲突，此接口方法默认实现按原样返回
    
    Specified by:
    
    wrapIdentifierQuote in interface IDialect
    
    Parameters:
    
    origin - 字段或表名称
    
    Returns:
    
    返回添加引用标识符的字段或表名称
  - setIdentifierQuote
```
public void setIdentifierQuote(String identifierQuoteBegin,
                               String identifierQuoteEnd)
```
    Description copied from interface: IDialect
    
    设置引用标识符
    
    Specified by:
    
    setIdentifierQuote in interface IDialect
    
    Parameters:
    
    identifierQuoteBegin - 引用标识符开始
    
    identifierQuoteEnd - 引用标识符结束
  - hasIdentifierQuote
```
public boolean hasIdentifierQuote()
```
    Description copied from interface: IDialect
    
    是否存在引用标识符
    
    Specified by:
    
    hasIdentifierQuote in interface IDialect
    
    Returns:
    
    返回true表示引用标识符存在(即值不为空)
  - getIdentifierQuoteBegin
```
public String getIdentifierQuoteBegin()
```
    Description copied from interface: IDialect
    
    获取引用标识符
    
    Specified by:
    
    getIdentifierQuoteBegin in interface IDialect
    
    Returns:
    
    返回引用标识符
  - getIdentifierQuoteEnd
```
public String getIdentifierQuoteEnd()
```
    Description copied from interface: IDialect
    
    获取引用标识符
    
    Specified by:
    
    getIdentifierQuoteEnd in interface IDialect
    
    Returns:
    
    返回引用标识符
  - getGeneratedKey
```
public Map<String,Object> getGeneratedKey(Statement statement,
                                          List<String> autoincrementKeys)
                                   throws SQLException
```
    Description copied from interface: IDialect
    
    获取自增主键值（按 Long 类型返回），采用JDBC Statement对象获取自动生成的主键（仅处理单主键）
    
    Specified by:
    
    getGeneratedKey in interface IDialect
    
    Parameters:
    
    statement - Statement对象
    
    autoincrementKeys - 自定义自增字段名称集合
    
    Returns:
    
    返回自动生成的主键
    
    Throws:
    
    SQLException - 可能产生的异常
  - getSequenceNextValSql
```
public String getSequenceNextValSql(String sequenceName)
```
    Description copied from interface: IDialect
    
    获取下一序列值的SQL语句
    
    Specified by:
    
    getSequenceNextValSql in interface IDialect
    
    Parameters:
    
    sequenceName - 序列名称
    
    Returns:
    
    返回下一序列值的SQL语句
  - buildPagedQuerySql
```
public String buildPagedQuerySql(String originSql,
                                 int page,
                                 int pageSize)
```
    Description copied from interface: IDialect
    
    构建分页SQL语句
    
    Specified by:
    
    buildPagedQuerySql in interface IDialect
    
    Parameters:
    
    originSql - 原SQL语句
    
    page - 页号
    
    pageSize - 每页记录数
    
    Returns:
    
    返回分页SQL语句
  - doRemoveOrderByElements
```
protected String doRemoveOrderByElements(String originSql)
```
  - buildCountSQL
```
public String buildCountSQL(String originSql)
```
    Description copied from interface: IDialect
    
    构建计算查询结果总记录数量的SQL语句
    
    Specified by:
    
    buildCountSQL in interface IDialect
    
    Parameters:
    
    originSql - 原SQL语句
    
    Returns:
    
    返回计算查询结果总记录数量的SQL语句
  - buildCreateSql
```
public String buildCreateSql(Class<? extends IEntity> entityClass,
                             String prefix,
                             IShardingable shardingable)
```
    Description copied from interface: IDialect
    
    构建创建实体数据表SQL语句
    
    Specified by:
    
    buildCreateSql in interface IDialect
    
    Parameters:
    
    entityClass - 实体模型类
    
    prefix - 实体名称前缀
    
    shardingable - 分片(表)参数对象
    
    Returns:
    
    返回创建实体数据表SQL语句
  - buildDropSql
```
public String buildDropSql(Class<? extends IEntity> entityClass,
                           String prefix,
                           IShardingable shardingable)
```
    Description copied from interface: IDialect
    
    构建删除实体数据表SQL语句
    
    Specified by:
    
    buildDropSql in interface IDialect
    
    Parameters:
    
    entityClass - 实体模型类
    
    prefix - 实体名称前缀
    
    shardingable - 分片(表)参数对象
    
    Returns:
    
    返回删除实体数据表SQL语句
  - doGenerateFieldsFormatStr
```
protected String doGenerateFieldsFormatStr(Fields fields,
                                           String suffix,
                                           String separator)
```
    Parameters:
    
    fields - 字段名称集合
    
    suffix - 字段名称后缀，可选
    
    separator - 分隔符，可选，默认“, ”
    
    Returns:
    
    将字段名称集合转换成为采用separator分隔的字符串
  - buildTableName
```
public String buildTableName(String prefix,
                             EntityMeta entityMeta,
                             IShardingable shardingable)
```
    Description copied from interface: IDialect
    
    获取完整的数据表名称，并根据数据库特性决定是否添加引用标识符
    
    Specified by:
    
    buildTableName in interface IDialect
    
    Parameters:
    
    prefix - 数据表名称前缀
    
    entityMeta - 数据实体属性描述对象
    
    shardingable - 分片(表)参数对象
    
    Returns:
    
    返回数据表名称
  - buildTableName
```
public String buildTableName(String prefix,
                             String tableName,
                             IShardingRule shardingRule,
                             IShardingable shardingable)
```
    Description copied from interface: IDialect
    
    获取完整的数据表名称，并根据数据库特性决定是否添加引用标识符
    
    Specified by:
    
    buildTableName in interface IDialect
    
    Parameters:
    
    prefix - 数据表名称前缀
    
    tableName - 数据表名称
    
    shardingRule - 数据分片(表)规则
    
    shardingable - 分片(表)参数对象
    
    Returns:
    
    返回数据表名称
  - doValidProperty
```
protected void doValidProperty(EntityMeta entityMeta,
                               Fields fields,
                               boolean isPrimaryKeys)
```
    验证字段是否合法有效
    
    Parameters:
    
    entityMeta - 数据实体属性描述对象
    
    fields - 字段名称集合
    
    isPrimaryKeys - fields中存放的是否为主键
  - buildInsertSql
```
public String buildInsertSql(Class<? extends IEntity> entityClass,
                             String prefix,
                             IShardingable shardingable,
                             Fields fields)
```
    Description copied from interface: IDialect
    
    构建插入实体数据记录SQL语句
    
    Specified by:
    
    buildInsertSql in interface IDialect
    
    Parameters:
    
    entityClass - 实体模模型类
    
    prefix - 实体名称前缀
    
    shardingable - 分片(表)参数对象
    
    fields - 字段名称集合，可选参数，若不指定则包括全部字段
    
    Returns:
    
    返回插入实体数据记录SQL语句
  - buildDeleteByPkSql
```
public String buildDeleteByPkSql(Class<? extends IEntity> entityClass,
                                 String prefix,
                                 IShardingable shardingable,
                                 Fields pkFields)
```
    Description copied from interface: IDialect
    
    构建删除实体数据记录SQL语句
    
    Specified by:
    
    buildDeleteByPkSql in interface IDialect
    
    Parameters:
    
    entityClass - 实体模模型类
    
    prefix - 实体名称前缀
    
    shardingable - 分片(表)参数对象
    
    pkFields - 主键字段名称集合，可选参数，若不指定则包括全部主键
    
    Returns:
    
    返回删除实体数据记录SQL语句
  - buildUpdateByPkSql
```
public String buildUpdateByPkSql(Class<? extends IEntity> entityClass,
                                 String prefix,
                                 IShardingable shardingable,
                                 Fields pkFields,
                                 Fields fields)
```
    Description copied from interface: IDialect
    
    构建更新实体数据记录SQL语句
    
    Specified by:
    
    buildUpdateByPkSql in interface IDialect
    
    Parameters:
    
    entityClass - 实体模模型类
    
    prefix - 前缀名称
    
    shardingable - 分片(表)参数对象
    
    pkFields - 主键字段名称集合，可选参数，若不指定则包括全部主键
    
    fields - 字段名称集合，可选参数，若不指定则包括全部字段
    
    Returns:
    
    返回更新实体数据记录SQL语句
  - buildSelectByPkSql
```
public String buildSelectByPkSql(Class<? extends IEntity> entityClass,
                                 String prefix,
                                 IShardingable shardingable,
                                 Fields pkFields,
                                 Fields fields)
```
    Description copied from interface: IDialect
    
    构建根据主键查询实体数据记录SQL语句
    
    Specified by:
    
    buildSelectByPkSql in interface IDialect
    
    Parameters:
    
    entityClass - 实体模模型类
    
    prefix - 实体名称前缀
    
    shardingable - 分片(表)参数对象
    
    pkFields - 主键字段名称集合，可选参数，若不指定则包括全部主键
    
    fields - 字段名称集合，可选参数，若不指定则包括全部字段
    
    Returns:
    
    返回根据主键查询实体数据记录SQL语句
  - buildSelectSql
```
public String buildSelectSql(Class<? extends IEntity> entityClass,
                             String prefix,
                             IShardingable shardingable,
                             Fields fields)
```
    Description copied from interface: IDialect
    
    构建查询全部实体数据记录SQL语句
    
    Specified by:
    
    buildSelectSql in interface IDialect
    
    Parameters:
    
    entityClass - 实体模模型类
    
    prefix - 实体名称前缀
    
    shardingable - 分片(表)参数对象
    
    fields - 字段名称集合，可选参数，若不指定则包括全部字段
    
    Returns:
    
    返回查询全部实体数据记录SQL语句

Class AbstractDialect

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.ymate.platform.persistence.jdbc.dialect.IDialect

Constructor Detail

AbstractDialect

AbstractDialect

Method Detail

wrapIdentifierQuote

setIdentifierQuote

hasIdentifierQuote

getIdentifierQuoteBegin

getIdentifierQuoteEnd

getGeneratedKey

getSequenceNextValSql

buildPagedQuerySql

doRemoveOrderByElements

buildCountSQL

buildCreateSql

buildDropSql

doGenerateFieldsFormatStr

buildTableName

buildTableName

doValidProperty

buildInsertSql

buildDeleteByPkSql

buildUpdateByPkSql

buildSelectByPkSql

buildSelectSql