AbstractDialect (ymate-platform-persistence-jdbc 2.0.6 API)

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

所有已实现的接口:

IDialect

直接已知子类:

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

版本:

1.0

作者:

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

字段概要

字段
限定符和类型字段和说明

protected static String __LINE_END_FLAG

字段
限定符和类型	字段和说明
`protected static String`	`__LINE_END_FLAG`

构造器概要

构造器
构造器和说明

AbstractDialect()

AbstractDialect(String identifierQuoteBegin, String identifierQuoteEnd)

构造器
构造器和说明
`AbstractDialect()`
`AbstractDialect(String identifierQuoteBegin, String identifierQuoteEnd)`

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`protected String`	`__doGenerateFieldsFormatStr(Fields fields, String suffix, String separator)`
`protected String`	`__doGetColumnType(Class<?> clazz)`
`protected void`	`__doValidProperty(EntityMeta entityMeta, Fields fields, boolean isPrimaryKeys)` 验证字段是否合法有效
`String`	`buildCreateSQL(Class<? extends IEntity> entityClass, String prefix, IShardingable shardingable)`
`String`	`buildDeleteByPkSQL(Class<? extends IEntity> entityClass, String prefix, IShardingable shardingable, Fields pkFields)`
`String`	`buildDropSQL(Class<? extends IEntity> entityClass, String prefix, IShardingable shardingable)`
`String`	`buildInsertSQL(Class<? extends IEntity> entityClass, String prefix, IShardingable shardingable, Fields fields)`
`String`	`buildPagedQuerySQL(String originSql, int page, int pageSize)`
`String`	`buildSelectByPkSQL(Class<? extends IEntity> entityClass, String prefix, IShardingable shardingable, Fields pkFields, Fields fields)`
`String`	`buildSelectSQL(Class<? extends IEntity> entityClass, String prefix, IShardingable shardingable, Fields fields)`
`String`	`buildTableName(String prefix, EntityMeta entityMeta, IShardingable shardingable)`
`String`	`buildUpdateByPkSQL(Class<? extends IEntity> entityClass, String prefix, IShardingable shardingable, Fields pkFields, Fields fields)`
`Map<String,Object>`	`getGeneratedKey(Statement statement, List<String> autoincrementKeys)`
`String`	`getIdentifierQuoteBegin()`
`String`	`getIdentifierQuoteEnd()`
`String`	`getSequenceNextValSql(String sequenceName)`
`void`	`setIdentifierQuote(String identifierQuoteBegin, String identifierQuoteEnd)` 设置引用标识符
`String`	`wrapIdentifierQuote(String origin)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 net.ymate.platform.persistence.jdbc.dialect.IDialect
getName

- 字段详细资料
  - __LINE_END_FLAG
```
protected static final String __LINE_END_FLAG
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - AbstractDialect
```
public AbstractDialect()
```
  - AbstractDialect
```
public AbstractDialect(String identifierQuoteBegin,
                       String identifierQuoteEnd)
```
- 方法详细资料
  - wrapIdentifierQuote
```
public String wrapIdentifierQuote(String origin)
```
    指定者:
    
    wrapIdentifierQuote 在接口中 IDialect
    
    参数:
    
    origin - 字段或表名称
    
    返回:
    
    返回添加引用标识符的字段或表名称，防止字段或表名与关键字冲突，此接口方法默认实现按原样返回
  - setIdentifierQuote
```
public void setIdentifierQuote(String identifierQuoteBegin,
                               String identifierQuoteEnd)
```
    从接口复制的说明: IDialect
    
    设置引用标识符
    
    指定者:
    
    setIdentifierQuote 在接口中 IDialect
    
    参数:
    
    identifierQuoteBegin - 引用标识符开始
    
    identifierQuoteEnd - 引用标识符结束
  - getIdentifierQuoteBegin
```
public String getIdentifierQuoteBegin()
```
    指定者:
    
    getIdentifierQuoteBegin 在接口中 IDialect
    
    返回:
    
    返回引用标识符
  - getIdentifierQuoteEnd
```
public String getIdentifierQuoteEnd()
```
    指定者:
    
    getIdentifierQuoteEnd 在接口中 IDialect
  - getGeneratedKey
```
public Map<String,Object> getGeneratedKey(Statement statement,
                                          List<String> autoincrementKeys)
                                   throws SQLException
```
    指定者:
    
    getGeneratedKey 在接口中 IDialect
    
    参数:
    
    statement - Statement对象
    
    autoincrementKeys - 自定义自增字段名称集合
    
    返回:
    
    返回主键值（按 long 类型返回），采用JDBC Statement对象获取自动生成的主键（仅处理单主键）
    
    抛出:
    
    SQLException - 可能产生的异常
  - getSequenceNextValSql
```
public String getSequenceNextValSql(String sequenceName)
```
    指定者:
    
    getSequenceNextValSql 在接口中 IDialect
    
    参数:
    
    sequenceName - 序列名称
    
    返回:
    
    返回获取下一序列值的SQL语句
  - buildPagedQuerySQL
```
public String buildPagedQuerySQL(String originSql,
                                 int page,
                                 int pageSize)
```
    指定者:
    
    buildPagedQuerySQL 在接口中 IDialect
    
    参数:
    
    originSql - 原SQL语句
    
    page - 页号
    
    pageSize - 每页记录数
    
    返回:
    
    返回分页SQL语句
  - buildCreateSQL
```
public String buildCreateSQL(Class<? extends IEntity> entityClass,
                             String prefix,
                             IShardingable shardingable)
```
    指定者:
    
    buildCreateSQL 在接口中 IDialect
    
    参数:
    
    entityClass - 实体模型类
    
    prefix - 实体名称前缀
    
    shardingable - 分片(表)参数对象
    
    返回:
    
    返回创建实体数据表SQL语句
  - buildDropSQL
```
public String buildDropSQL(Class<? extends IEntity> entityClass,
                           String prefix,
                           IShardingable shardingable)
```
    指定者:
    
    buildDropSQL 在接口中 IDialect
    
    参数:
    
    entityClass - 实体模型类
    
    prefix - 实体名称前缀
    
    shardingable - 分片(表)参数对象
    
    返回:
    
    返回删除实体数据表SQL语句
  - __doGetColumnType
```
protected String __doGetColumnType(Class<?> clazz)
```
  - __doGenerateFieldsFormatStr
```
protected String __doGenerateFieldsFormatStr(Fields fields,
                                             String suffix,
                                             String separator)
```
    参数:
    
    fields - 字段名称集合
    
    suffix - 字段名称后缀，可选
    
    separator - 分隔符，可选，默认“, ”
    
    返回:
    
    将字段名称集合转换成为采用separator分隔的字符串
  - buildTableName
```
public String buildTableName(String prefix,
                             EntityMeta entityMeta,
                             IShardingable shardingable)
```
    指定者:
    
    buildTableName 在接口中 IDialect
    
    参数:
    
    prefix - 数据表名称前缀
    
    entityMeta - 数据实体属性描述对象
    
    shardingable - 分片(表)参数对象
    
    返回:
    
    返回完整的数据表名称，并根据数据库特性决定是否添加引用标识符
  - __doValidProperty
```
protected void __doValidProperty(EntityMeta entityMeta,
                                 Fields fields,
                                 boolean isPrimaryKeys)
```
    验证字段是否合法有效
    
    参数:
    
    entityMeta - 数据实体属性描述对象
    
    fields - 字段名称集合
    
    isPrimaryKeys - fields中存放的是否为主键
  - buildInsertSQL
```
public String buildInsertSQL(Class<? extends IEntity> entityClass,
                             String prefix,
                             IShardingable shardingable,
                             Fields fields)
```
    指定者:
    
    buildInsertSQL 在接口中 IDialect
    
    参数:
    
    entityClass - 实体模模型类
    
    prefix - 实体名称前缀
    
    shardingable - 分片(表)参数对象
    
    fields - 字段名称集合，可选参数，若不指定则包括全部字段
    
    返回:
    
    返回插入实体数据记录SQL语句
  - buildDeleteByPkSQL
```
public String buildDeleteByPkSQL(Class<? extends IEntity> entityClass,
                                 String prefix,
                                 IShardingable shardingable,
                                 Fields pkFields)
```
    指定者:
    
    buildDeleteByPkSQL 在接口中 IDialect
    
    参数:
    
    entityClass - 实体模模型类
    
    prefix - 实体名称前缀
    
    shardingable - 分片(表)参数对象
    
    pkFields - 主键字段名称集合，可选参数，若不指定则包括全部主键
    
    返回:
    
    返回删除实体数据记录SQL语句
  - buildUpdateByPkSQL
```
public String buildUpdateByPkSQL(Class<? extends IEntity> entityClass,
                                 String prefix,
                                 IShardingable shardingable,
                                 Fields pkFields,
                                 Fields fields)
```
    指定者:
    
    buildUpdateByPkSQL 在接口中 IDialect
    
    参数:
    
    entityClass - 实体模模型类
    
    prefix - 前缀名称
    
    shardingable - 分片(表)参数对象
    
    pkFields - 主键字段名称集合，可选参数，若不指定则包括全部主键
    
    fields - 字段名称集合，可选参数，若不指定则包括全部字段
    
    返回:
    
    返回更新实体数据记录SQL语句
  - buildSelectByPkSQL
```
public String buildSelectByPkSQL(Class<? extends IEntity> entityClass,
                                 String prefix,
                                 IShardingable shardingable,
                                 Fields pkFields,
                                 Fields fields)
```
    指定者:
    
    buildSelectByPkSQL 在接口中 IDialect
    
    参数:
    
    entityClass - 实体模模型类
    
    prefix - 实体名称前缀
    
    shardingable - 分片(表)参数对象
    
    pkFields - 主键字段名称集合，可选参数，若不指定则包括全部主键
    
    fields - 字段名称集合，可选参数，若不指定则包括全部字段
    
    返回:
    
    返回根据主键查询实体数据记录SQL语句
  - buildSelectSQL
```
public String buildSelectSQL(Class<? extends IEntity> entityClass,
                             String prefix,
                             IShardingable shardingable,
                             Fields fields)
```
    指定者:
    
    buildSelectSQL 在接口中 IDialect
    
    参数:
    
    entityClass - 实体模模型类
    
    prefix - 实体名称前缀
    
    shardingable - 分片(表)参数对象
    
    fields - 字段名称集合，可选参数，若不指定则包括全部字段
    
    返回:
    
    返回查询全部实体数据记录SQL语句

类 AbstractDialect

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 net.ymate.platform.persistence.jdbc.dialect.IDialect

字段详细资料

__LINE_END_FLAG

构造器详细资料

AbstractDialect

AbstractDialect

方法详细资料

wrapIdentifierQuote

setIdentifierQuote

getIdentifierQuoteBegin

getIdentifierQuoteEnd

getGeneratedKey

getSequenceNextValSql

buildPagedQuerySQL

buildCreateSQL

buildDropSQL

__doGetColumnType

__doGenerateFieldsFormatStr

buildTableName

__doValidProperty

buildInsertSQL

buildDeleteByPkSQL

buildUpdateByPkSQL

buildSelectByPkSQL

buildSelectSQL