BaseTableScriptCreator (SohelpBoot 1.1.15-SNAPSHOT API)

java.lang.Object
- net.sohelp.boot.engine.db.table.script.BaseTableScriptCreator

所有已实现的接口:

TableScriptInterface

直接已知子类:

Mssql2000TableScriptCreator, MysqlTableScriptCreator
```
public abstract class BaseTableScriptCreator
extends Object
implements TableScriptInterface
```
表Script产生器基类

从以下版本开始:

2016/03/16

作者:

AaronFung

构造器概要

构造器
构造器和说明

BaseTableScriptCreator()

构造器
构造器和说明
`BaseTableScriptCreator()`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`abstract String`	`alterField(PropertyVO propertyVO)` 生成修改字段的SQL语句
`abstract String`	`createIndexKey(PropertyVO propertyVO)` 生成创建索引的SQL语句
`abstract String`	`createPrimaryKey(PropertyVO propertyVO)` 生成创建主键的SQL语句
`String`	`createUnique(EntityVO entityVO)` 生成创建唯一约束的SQL语句
`abstract String`	`dropIndexKey(PropertyVO propertyVO)` 生成删除索引的SQL语句
`abstract String`	`dropPrimaryKey(String tableName)` 生成删除主键的SQL语句
`String`	`dropUnique(EntityVO entityVO)` 生成删除唯一约束的SQL语句
`abstract boolean`	`exist(String tableName)` 判断指定表是否存在
`abstract boolean`	`exist(String tableName, String fieldName)` 判断指定表中的字段是否存在
`abstract List<EntityVO>`	`getEntities()` 获取所有实体对象列表
`abstract EntityVO`	`getEntity(String tableName)` 根据表名获取实体对象信息
`abstract String`	`getMappingType(PropertyVO propertyVO)` 获取属性对应的数据库字段类型映射
`PropertyVO`	`getProperty(String tableName, String fieldName)` 根据表名和字段名获取属性对象
`abstract int`	`getTableFieldLength(String tableName, String fieldName)` 获取指定表字段的长度
`abstract String`	`getTableFieldType(String tableName, String fieldName)` 获取指定表字段的数据库类型
`boolean`	`isEqualsProperty(PropertyVO propertyVO)` 判断给定属性与数据库中对应字段是否相等（类型和长度）
`boolean`	`isEqualsProperty(PropertyVO xmlProperty, PropertyVO fieldPropertyVO)` 判断两个属性对象是否相等（类型和长度）
`abstract boolean`	`isExistIndexKey(PropertyVO propertyVO)` 判断指定属性的索引是否存在
`abstract boolean`	`isExistPrimaryKey(String tableName)` 判断指定表是否存在主键
`String`	`saveTable(EntityVO entityVO)` 保存表结构，根据实体对象生成创建或修改表的SQL语句

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

从接口继承的方法 net.sohelp.boot.engine.db.table.script.interfaces.TableScriptInterface
createField, createTable, dropField, droptable, getEntityNames, getProperties

- 构造器详细资料
  - BaseTableScriptCreator
```
public BaseTableScriptCreator()
```
- 方法详细资料
  - exist
```
public abstract boolean exist(String tableName,
                              String fieldName)
                       throws SQLException
```
    判断指定表中的字段是否存在
    
    指定者:
    
    exist 在接口中 TableScriptInterface
    
    参数:
    
    tableName - 表名
    
    fieldName - 字段名
    
    返回:
    
    如果字段存在返回true，否则返回false
    
    抛出:
    
    SQLException - SQL执行异常
  - exist
```
public abstract boolean exist(String tableName)
                       throws SQLException
```
    判断指定表是否存在
    
    指定者:
    
    exist 在接口中 TableScriptInterface
    
    参数:
    
    tableName - 表名
    
    返回:
    
    如果表存在返回true，否则返回false
    
    抛出:
    
    SQLException - SQL执行异常
  - getMappingType
```
public abstract String getMappingType(PropertyVO propertyVO)
                               throws SQLException
```
    获取属性对应的数据库字段类型映射
    
    指定者:
    
    getMappingType 在接口中 TableScriptInterface
    
    参数:
    
    propertyVO - 属性对象
    
    返回:
    
    数据库字段类型
    
    抛出:
    
    SQLException - SQL执行异常
  - isExistPrimaryKey
```
public abstract boolean isExistPrimaryKey(String tableName)
                                   throws SQLException
```
    判断指定表是否存在主键
    
    指定者:
    
    isExistPrimaryKey 在接口中 TableScriptInterface
    
    参数:
    
    tableName - 表名
    
    返回:
    
    如果存在主键返回true，否则返回false
    
    抛出:
    
    SQLException - SQL执行异常
  - dropPrimaryKey
```
public abstract String dropPrimaryKey(String tableName)
```
    生成删除主键的SQL语句
    
    指定者:
    
    dropPrimaryKey 在接口中 TableScriptInterface
    
    参数:
    
    tableName - 表名
    
    返回:
    
    删除主键的SQL语句
  - createPrimaryKey
```
public abstract String createPrimaryKey(PropertyVO propertyVO)
```
    生成创建主键的SQL语句
    
    指定者:
    
    createPrimaryKey 在接口中 TableScriptInterface
    
    参数:
    
    propertyVO - 属性对象，包含主键信息
    
    返回:
    
    创建主键的SQL语句
  - dropIndexKey
```
public abstract String dropIndexKey(PropertyVO propertyVO)
                             throws SQLException
```
    生成删除索引的SQL语句
    
    参数:
    
    propertyVO - 属性对象，包含索引信息
    
    返回:
    
    删除索引的SQL语句
    
    抛出:
    
    SQLException - SQL执行异常
  - createIndexKey
```
public abstract String createIndexKey(PropertyVO propertyVO)
                               throws SQLException
```
    生成创建索引的SQL语句
    
    参数:
    
    propertyVO - 属性对象，包含索引信息
    
    返回:
    
    创建索引的SQL语句
    
    抛出:
    
    SQLException - SQL执行异常
  - isExistIndexKey
```
public abstract boolean isExistIndexKey(PropertyVO propertyVO)
                                 throws SQLException
```
    判断指定属性的索引是否存在
    
    参数:
    
    propertyVO - 属性对象
    
    返回:
    
    如果索引存在返回true，否则返回false
    
    抛出:
    
    SQLException - SQL执行异常
  - getTableFieldType
```
public abstract String getTableFieldType(String tableName,
                                         String fieldName)
                                  throws SQLException
```
    获取指定表字段的数据库类型
    
    指定者:
    
    getTableFieldType 在接口中 TableScriptInterface
    
    参数:
    
    tableName - 表名
    
    fieldName - 字段名
    
    返回:
    
    字段的数据库类型
    
    抛出:
    
    SQLException - SQL执行异常
  - getEntity
```
public abstract EntityVO getEntity(String tableName)
                            throws SQLException
```
    根据表名获取实体对象信息
    
    指定者:
    
    getEntity 在接口中 TableScriptInterface
    
    参数:
    
    tableName - 表名
    
    返回:
    
    实体对象
    
    抛出:
    
    SQLException - SQL执行异常
  - getTableFieldLength
```
public abstract int getTableFieldLength(String tableName,
                                        String fieldName)
                                 throws SQLException
```
    获取指定表字段的长度
    
    指定者:
    
    getTableFieldLength 在接口中 TableScriptInterface
    
    参数:
    
    tableName - 表名
    
    fieldName - 字段名
    
    返回:
    
    字段长度
    
    抛出:
    
    SQLException - SQL执行异常
  - getProperty
```
public PropertyVO getProperty(String tableName,
                              String fieldName)
                       throws SQLException
```
    根据表名和字段名获取属性对象
    
    指定者:
    
    getProperty 在接口中 TableScriptInterface
    
    参数:
    
    tableName - 表名
    
    fieldName - 字段名
    
    返回:
    
    属性对象，如果字段不存在返回null
    
    抛出:
    
    SQLException - SQL执行异常
  - isEqualsProperty
```
public boolean isEqualsProperty(PropertyVO propertyVO)
                         throws SQLException
```
    判断给定属性与数据库中对应字段是否相等（类型和长度）
    
    指定者:
    
    isEqualsProperty 在接口中 TableScriptInterface
    
    参数:
    
    propertyVO - 属性对象
    
    返回:
    
    如果相等返回true，否则返回false
    
    抛出:
    
    SQLException - SQL执行异常
  - isEqualsProperty
```
public boolean isEqualsProperty(PropertyVO xmlProperty,
                                PropertyVO fieldPropertyVO)
                         throws SQLException
```
    判断两个属性对象是否相等（类型和长度）
    
    指定者:
    
    isEqualsProperty 在接口中 TableScriptInterface
    
    参数:
    
    xmlProperty - XML配置中的属性对象
    
    fieldPropertyVO - 数据库中的属性对象
    
    返回:
    
    如果相等返回true，否则返回false
    
    抛出:
    
    SQLException - SQL执行异常
  - createUnique
```
public String createUnique(EntityVO entityVO)
```
    生成创建唯一约束的SQL语句
    
    指定者:
    
    createUnique 在接口中 TableScriptInterface
    
    参数:
    
    entityVO - 实体对象
    
    返回:
    
    创建唯一约束的SQL语句，当前实现返回null
  - dropUnique
```
public String dropUnique(EntityVO entityVO)
```
    生成删除唯一约束的SQL语句
    
    指定者:
    
    dropUnique 在接口中 TableScriptInterface
    
    参数:
    
    entityVO - 实体对象
    
    返回:
    
    删除唯一约束的SQL语句，当前实现返回null
  - alterField
```
public abstract String alterField(PropertyVO propertyVO)
                           throws SQLException
```
    生成修改字段的SQL语句
    
    指定者:
    
    alterField 在接口中 TableScriptInterface
    
    参数:
    
    propertyVO - 属性对象
    
    返回:
    
    修改字段的SQL语句
    
    抛出:
    
    SQLException - SQL执行异常
  - saveTable
```
public String saveTable(EntityVO entityVO)
                 throws SQLException
```
    保存表结构，根据实体对象生成创建或修改表的SQL语句
    
    指定者:
    
    saveTable 在接口中 TableScriptInterface
    
    参数:
    
    entityVO - 实体对象，包含表结构信息
    
    返回:
    
    创建或修改表的SQL语句
    
    抛出:
    
    SQLException - SQL执行异常
  - getEntities
```
public abstract List<EntityVO> getEntities()
                                    throws SQLException
```
    获取所有实体对象列表
    
    指定者:
    
    getEntities 在接口中 TableScriptInterface
    
    返回:
    
    实体对象列表
    
    抛出:
    
    SQLException - SQL执行异常

类 BaseTableScriptCreator

构造器概要

方法概要

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

从接口继承的方法 net.sohelp.boot.engine.db.table.script.interfaces.TableScriptInterface

构造器详细资料

BaseTableScriptCreator

方法详细资料

exist

exist

getMappingType

isExistPrimaryKey

dropPrimaryKey

createPrimaryKey

dropIndexKey

createIndexKey

isExistIndexKey

getTableFieldType

getEntity

getTableFieldLength

getProperty

isEqualsProperty

isEqualsProperty

createUnique

dropUnique

alterField

saveTable

getEntities