SdColumn (screw-driver 1.1.0 API)

java.lang.Object
- org.mirrentools.sd.models.SdColumn

所有已实现的接口:

Comparable<SdColumn>
```
public class SdColumn
extends Object
implements Comparable<SdColumn>
```
创建类与表列所需要的属性,
在被 SdTemplateContentConverter转换时,如果类属性为空需要将表中的列属性转换为类属性,主外键索引等同名则算为联合列
所以在生成时添加表属性就可以了,如果列属性不能很好的转换为类属性才设置类属性

作者:

Mirren

构造器概要

构造器
构造器和说明

SdColumn()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`SdColumn`	`addAnnotation(String annotation)` 添加类属性的注解
`SdColumn`	`addExtension(String key, Object value)` 添加附加属性
`SdColumn`	`addImport(String imports)` 添加类属性需要引入的包,默认根据表中列的类型添加需要引入的包
`int`	`compareTo(SdColumn obj)`
`Set<String>`	`getAnnotations()` 获取类属性的注解
`String`	`getCollate()` 获取字符排序规则
`String`	`getConstraintExp()` 获取约束条件
`String`	`getConstraintName()` 获取约束的名称, 比如index_name
`String`	`getConstraintType()` 获取约束的类型比如check
`String`	`getDefaults()` 设置默认值
`Object`	`getExtension(String key)` 获得拓展属性值
`Map<String,Object>`	`getExtensions()` 获取附加属性
`String`	`getFieldName()` 获取类的属性名字,实现时最好是它为驼峰命名
`String`	`getFieldNameHyphen()` 获取类的属性名字按连字符命名
`String`	`getFieldNameLower()` 获取类属性的名字,全部小写
`String`	`getFieldNamePascal()` 获取类的属性名字按帕斯卡命名
`String`	`getFieldNameUnderScore()` 获取类的属性名字按下划线命名
`String`	`getFieldNameUpper()` 获取类属性的名字,全部大写
`String`	`getFieldRemark()` 获取类的属性的注释
`String`	`getFieldType()` 获取类的属性类型
`String`	`getForeignConstraint()` 获取外键的名字
`String`	`getForeignReferencesColumn()` 获取外键的引用那个
`String`	`getForeignReferencesDB()` 获取外键引用那个数据库或模式
`String`	`getForeignReferencesTable()` 获取外键引用那个表
`Integer`	`getIdentityIncrement()` 获取标识增量
`Integer`	`getIdentitySeed()` 获取标识种子
`Set<String>`	`getImports()` 获取类属性需要引入的包
`String`	`getIndexName()` 获取索引名字
`String`	`getIndexRemark()` 获取索引的注释
`String`	`getIndexType()` 获取索引类型
`Integer`	`getLength()` 获取列的长度
`String`	`getName()` 获取列名
`int`	`getOrdinalPosition()` 获取列的顺序
`Integer`	`getPrecision()` 获取小数点精度
`String`	`getPrimaryName()` 获取主键的名字
`SdRelationalContent`	`getRelationalContent()` 获取属性的关系属性内容
`String`	`getRemark()` 获取注释
`String`	`getSequenceName()` 获取自增使用的序列名称
`String`	`getType()` 获取列的类型
`boolean`	`isAutoIncrement()` 是否自增
`boolean`	`isConcurrently()` 获取索引是否为并发
`boolean`	`isForeignKey()` 获取是否为外键
`boolean`	`isIdentity()`
`boolean`	`isIndex()` 是否为索引
`boolean`	`isNullable()` 是否可以为空
`boolean`	`isPrimary()` 是否为主键
`boolean`	`isUnique()` 获取是否为唯一索引
`boolean`	`isUnsigned()` 是否为无符号
`SdColumn`	`setAnnotations(Set<String> annotations)` 设置类属性的注解
`SdColumn`	`setAutoIncrement(boolean autoIncrement)` 设置是否自增或为标识 MySQL数据库对应increment SQL Server数据库对应identity
`SdColumn`	`setCollate(String collate)` 设置字符排序规则
`SdColumn`	`setConcurrently(boolean concurrently)` 设置索引是否为并发
`SdColumn`	`setConstraintExp(String constraintExp)` 设置约束条件,比如: id > 10
`SdColumn`	`setConstraintName(String constraintName)` 设置约束的名称, 比如index_name
`SdColumn`	`setConstraintType(String constraintType)` 设置约束的类型比如 check
`SdColumn`	`setDefaults(String defaults)` 获取默认值
`SdColumn`	`setExtensions(Map<String,Object> extensions)` 设置附加属性
`SdColumn`	`setFieldName(String fieldName)` 设置类的属性名字,默认将表中的列名转换为类属性名,实现时最好是它为驼峰命名
`SdColumn`	`setFieldNameHyphen(String fieldNameHyphen)` 设置类的属性名字按连字符命名
`SdColumn`	`setFieldNameLower(String fieldNameLower)` 设置类属性的名字,全部小写
`SdColumn`	`setFieldNamePascal(String fieldNamePascal)` 设置类的属性名字按帕斯卡命名
`SdColumn`	`setFieldNameUnderScore(String fieldNameUnderScore)` 设置类的属性名字按下划线命名
`SdColumn`	`setFieldNameUpper(String fieldNameUpper)` 设置类属性的名字,全部大写
`SdColumn`	`setFieldRemark(String fieldRemark)` 设置类的属性的注释,默认取列属性的注解
`SdColumn`	`setFieldType(String fieldType)` 设置类的属性类型,默认将表中列的属性转换为类属性类型
`SdColumn`	`setForeignConstraint(String foreignConstraint)` 设置外键的名字,如果外键的名字相同则视为多列引用
`SdColumn`	`setForeignReferencesColumn(String foreignReferencesColumn)` 设置外键的引用那个列
`SdColumn`	`setForeignReferencesDB(String foreignReferencesDB)` 设置外键的引用那个数据库或模式
`SdColumn`	`setForeignReferencesTable(String foreignReferencesTable)` 设置外键的引用那个表
`SdColumn`	`setIdentity(boolean identity)`
`SdColumn`	`setIdentityIncrement(Integer identityIncrement)` 设置标识增量
`SdColumn`	`setIdentitySeed(Integer identitySeed)` 设置标识种子
`SdColumn`	`setImports(Set<String> imports)` 设置类属性需要引入的包,默认根据表中列的类型添加需要引入的包
`SdColumn`	`setIndexName(String indexName)` 设置索引名字
`SdColumn`	`setIndexRemark(String indexRemark)` 设置索引的注释
`SdColumn`	`setIndexType(String indexType)` 设置索引类型
`SdColumn`	`setLength(Integer length)` 设置列的长度
`SdColumn`	`setLength(Integer length, Integer precision)` 设置列的长度与小数点
`SdColumn`	`setName(String name)` 设置列名
`SdColumn`	`setNullable(boolean nullable)` 设置是否可以为空
`SdColumn`	`setOrdinalPosition(int ordinalPosition)` 设置列的顺序
`SdColumn`	`setPrecision(Integer precision)` 设置小数点精度
`SdColumn`	`setPrimary(boolean primary)` 设置是否为主键,如果==true,则不能为空
`SdColumn`	`setPrimaryName(String primaryName)` 设置主键的名字
`SdColumn`	`setRelationalContent(SdRelationalContent relationalContent)` 设置属性的关系属性内容
`SdColumn`	`setRemark(String remark)` 设置注释
`SdColumn`	`setSequenceName(String sequenceName)` 设置自增使用的序列名称
`SdColumn`	`setType(String type)` 设置列的类型
`SdColumn`	`setUnique(boolean unique)` 设置是否为唯一索引
`SdColumn`	`setUnsigned(boolean unsigned)` 设置是否为无符号
`String`	`toString()`

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

- 构造器详细资料
  - SdColumn
```
public SdColumn()
```
- 方法详细资料
  - getImports
```
public Set<String> getImports()
```
    获取类属性需要引入的包
    
    返回:
  - addImport
```
public SdColumn addImport(String imports)
```
    添加类属性需要引入的包,默认根据表中列的类型添加需要引入的包
    
    参数:
    
    imports -
    
    返回:
  - setImports
```
public SdColumn setImports(Set<String> imports)
```
    设置类属性需要引入的包,默认根据表中列的类型添加需要引入的包
    
    参数:
    
    imports -
    
    返回:
  - getAnnotations
```
public Set<String> getAnnotations()
```
    获取类属性的注解
    
    返回:
  - addAnnotation
```
public SdColumn addAnnotation(String annotation)
```
    添加类属性的注解
    
    参数:
    
    annotation -
    
    返回:
  - setAnnotations
```
public SdColumn setAnnotations(Set<String> annotations)
```
    设置类属性的注解
    
    参数:
    
    annotations -
    
    返回:
  - getRelationalContent
```
public SdRelationalContent getRelationalContent()
```
    获取属性的关系属性内容
    
    返回:
  - setRelationalContent
```
public SdColumn setRelationalContent(SdRelationalContent relationalContent)
```
    设置属性的关系属性内容
    
    参数:
    
    relationalContent -
    
    返回:
  - getFieldType
```
public String getFieldType()
```
    获取类的属性类型
    
    返回:
  - setFieldType
```
public SdColumn setFieldType(String fieldType)
```
    设置类的属性类型,默认将表中列的属性转换为类属性类型
    
    参数:
    
    fieldType -
    
    返回:
  - getFieldName
```
public String getFieldName()
```
    获取类的属性名字,实现时最好是它为驼峰命名
    
    返回:
  - getFieldNameLower
```
public String getFieldNameLower()
```
    获取类属性的名字,全部小写
    
    返回:
  - setFieldNameLower
```
public SdColumn setFieldNameLower(String fieldNameLower)
```
    设置类属性的名字,全部小写
    
    参数:
    
    fieldNameLower -
    
    返回:
  - getFieldNameUpper
```
public String getFieldNameUpper()
```
    获取类属性的名字,全部大写
    
    返回:
  - setFieldNameUpper
```
public SdColumn setFieldNameUpper(String fieldNameUpper)
```
    设置类属性的名字,全部大写
    
    参数:
    
    fieldNameUpper -
    
    返回:
  - setFieldName
```
public SdColumn setFieldName(String fieldName)
```
    设置类的属性名字,默认将表中的列名转换为类属性名,实现时最好是它为驼峰命名
    
    参数:
    
    fieldName -
    
    返回:
  - getFieldNamePascal
```
public String getFieldNamePascal()
```
    获取类的属性名字按帕斯卡命名
    
    返回:
  - setFieldNamePascal
```
public SdColumn setFieldNamePascal(String fieldNamePascal)
```
    设置类的属性名字按帕斯卡命名
    
    参数:
    
    fieldNamePascal -
    
    返回:
  - getFieldNameHyphen
```
public String getFieldNameHyphen()
```
    获取类的属性名字按连字符命名
    
    返回:
  - setFieldNameHyphen
```
public SdColumn setFieldNameHyphen(String fieldNameHyphen)
```
    设置类的属性名字按连字符命名
    
    参数:
    
    fieldNameHyphen -
    
    返回:
  - getFieldNameUnderScore
```
public String getFieldNameUnderScore()
```
    获取类的属性名字按下划线命名
    
    返回:
  - setFieldNameUnderScore
```
public SdColumn setFieldNameUnderScore(String fieldNameUnderScore)
```
    设置类的属性名字按下划线命名
    
    参数:
    
    fieldNameUnderScore -
    
    返回:
  - getFieldRemark
```
public String getFieldRemark()
```
    获取类的属性的注释
    
    返回:
  - setFieldRemark
```
public SdColumn setFieldRemark(String fieldRemark)
```
    设置类的属性的注释,默认取列属性的注解
    
    参数:
    
    fieldRemark -
    
    返回:
  - getName
```
public String getName()
```
    获取列名
    
    返回:
  - setName
```
public SdColumn setName(String name)
```
    设置列名
    
    参数:
    
    name -
    
    返回:
  - getType
```
public String getType()
```
    获取列的类型
    
    返回:
  - setType
```
public SdColumn setType(String type)
```
    设置列的类型
    
    参数:
    
    type -
    
    返回:
  - getLength
```
public Integer getLength()
```
    获取列的长度
    
    返回:
  - setLength
```
public SdColumn setLength(Integer length)
```
    设置列的长度
    
    参数:
    
    length -
    
    返回:
  - setLength
```
public SdColumn setLength(Integer length,
                          Integer precision)
```
    设置列的长度与小数点
    
    参数:
    
    length - 长度
    
    precision - 小数点进度
    
    返回:
  - getPrecision
```
public Integer getPrecision()
```
    获取小数点精度
    
    返回:
  - setPrecision
```
public SdColumn setPrecision(Integer precision)
```
    设置小数点精度
    
    参数:
    
    precision -
    
    返回:
  - getDefaults
```
public String getDefaults()
```
    设置默认值
    
    返回:
  - setDefaults
```
public SdColumn setDefaults(String defaults)
```
    获取默认值
    
    参数:
    
    defaults -
    
    返回:
  - isPrimary
```
public boolean isPrimary()
```
    是否为主键
    
    返回:
  - setPrimary
```
public SdColumn setPrimary(boolean primary)
```
    设置是否为主键,如果==true,则不能为空
    
    参数:
    
    primary -
    
    返回:
  - isForeignKey
```
public boolean isForeignKey()
```
    获取是否为外键
    
    返回:
  - getForeignConstraint
```
public String getForeignConstraint()
```
    获取外键的名字
    
    返回:
  - setForeignConstraint
```
public SdColumn setForeignConstraint(String foreignConstraint)
```
    设置外键的名字,如果外键的名字相同则视为多列引用
    
    参数:
    
    foreignConstraint -
    
    返回:
  - getForeignReferencesDB
```
public String getForeignReferencesDB()
```
    获取外键引用那个数据库或模式
    
    返回:
  - setForeignReferencesDB
```
public SdColumn setForeignReferencesDB(String foreignReferencesDB)
```
    设置外键的引用那个数据库或模式
    
    参数:
    
    foreignReferencesDB -
    
    返回:
  - getForeignReferencesTable
```
public String getForeignReferencesTable()
```
    获取外键引用那个表
    
    返回:
  - setForeignReferencesTable
```
public SdColumn setForeignReferencesTable(String foreignReferencesTable)
```
    设置外键的引用那个表
    
    参数:
    
    foreignReferencesTable -
    
    返回:
  - getForeignReferencesColumn
```
public String getForeignReferencesColumn()
```
    获取外键的引用那个
    
    返回:
  - setForeignReferencesColumn
```
public SdColumn setForeignReferencesColumn(String foreignReferencesColumn)
```
    设置外键的引用那个列
    
    参数:
    
    foreignReferencesColumn -
    
    返回:
  - getPrimaryName
```
public String getPrimaryName()
```
    获取主键的名字
    
    返回:
  - setPrimaryName
```
public SdColumn setPrimaryName(String primaryName)
```
    设置主键的名字
    
    参数:
    
    primaryName -
    
    返回:
  - isIndex
```
public boolean isIndex()
```
    是否为索引
    
    返回:
  - isUnique
```
public boolean isUnique()
```
    获取是否为唯一索引
    
    返回:
  - setUnique
```
public SdColumn setUnique(boolean unique)
```
    设置是否为唯一索引
    
    参数:
    
    unique -
    
    返回:
  - isConcurrently
```
public boolean isConcurrently()
```
    获取索引是否为并发
    
    返回:
  - setConcurrently
```
public SdColumn setConcurrently(boolean concurrently)
```
    设置索引是否为并发
    
    参数:
    
    concurrently -
    
    返回:
  - getIndexType
```
public String getIndexType()
```
    获取索引类型
    
    返回:
  - setIndexType
```
public SdColumn setIndexType(String indexType)
```
    设置索引类型
    
    参数:
    
    indexType -
    
    返回:
  - getIndexName
```
public String getIndexName()
```
    获取索引名字
    
    返回:
  - setIndexName
```
public SdColumn setIndexName(String indexName)
```
    设置索引名字
    
    参数:
    
    indexName -
    
    返回:
  - getIndexRemark
```
public String getIndexRemark()
```
    获取索引的注释
    
    返回:
  - setIndexRemark
```
public SdColumn setIndexRemark(String indexRemark)
```
    设置索引的注释
    
    参数:
    
    indexRemark -
    
    返回:
  - isNullable
```
public boolean isNullable()
```
    是否可以为空
    
    返回:
  - setNullable
```
public SdColumn setNullable(boolean nullable)
```
    设置是否可以为空
    
    参数:
    
    nullable -
    
    返回:
  - isUnsigned
```
public boolean isUnsigned()
```
    是否为无符号
    
    返回:
  - setUnsigned
```
public SdColumn setUnsigned(boolean unsigned)
```
    设置是否为无符号
    
    参数:
    
    unsigned -
    
    返回:
  - isAutoIncrement
```
public boolean isAutoIncrement()
```
    是否自增
    
    返回:
  - setAutoIncrement
```
public SdColumn setAutoIncrement(boolean autoIncrement)
```
    设置是否自增或为标识
    MySQL数据库对应increment
    SQL Server数据库对应identity
    
    参数:
    
    autoIncrement -
    
    返回:
  - isIdentity
```
public boolean isIdentity()
```
  - setIdentity
```
public SdColumn setIdentity(boolean identity)
```
  - getIdentitySeed
```
public Integer getIdentitySeed()
```
    获取标识种子
    
    返回:
  - getIdentityIncrement
```
public Integer getIdentityIncrement()
```
    获取标识增量
    
    返回:
  - setIdentitySeed
```
public SdColumn setIdentitySeed(Integer identitySeed)
```
    设置标识种子
    
    参数:
    
    identitySeed -
    
    返回:
  - setIdentityIncrement
```
public SdColumn setIdentityIncrement(Integer identityIncrement)
```
    设置标识增量
    
    参数:
    
    identityIncrement -
    
    返回:
  - getSequenceName
```
public String getSequenceName()
```
    获取自增使用的序列名称
    
    返回:
  - setSequenceName
```
public SdColumn setSequenceName(String sequenceName)
```
    设置自增使用的序列名称
    
    参数:
    
    sequenceName -
    
    返回:
  - getConstraintType
```
public String getConstraintType()
```
    获取约束的类型比如check
    
    返回:
  - setConstraintType
```
public SdColumn setConstraintType(String constraintType)
```
    设置约束的类型比如 check
    
    参数:
    
    constraintType -
    
    返回:
  - getConstraintName
```
public String getConstraintName()
```
    获取约束的名称, 比如index_name
    
    返回:
  - setConstraintName
```
public SdColumn setConstraintName(String constraintName)
```
    设置约束的名称, 比如index_name
    
    参数:
    
    constraintName -
    
    返回:
  - getConstraintExp
```
public String getConstraintExp()
```
    获取约束条件
    
    返回:
  - setConstraintExp
```
public SdColumn setConstraintExp(String constraintExp)
```
    设置约束条件,比如: id > 10
    
    参数:
    
    constraintExp -
    
    返回:
  - getRemark
```
public String getRemark()
```
    获取注释
    
    返回:
  - setRemark
```
public SdColumn setRemark(String remark)
```
    设置注释
    
    参数:
    
    remark -
    
    返回:
  - getCollate
```
public String getCollate()
```
    获取字符排序规则
    
    返回:
  - setCollate
```
public SdColumn setCollate(String collate)
```
    设置字符排序规则
    
    参数:
    
    collate -
    
    返回:
  - getOrdinalPosition
```
public int getOrdinalPosition()
```
    获取列的顺序
    
    返回:
  - setOrdinalPosition
```
public SdColumn setOrdinalPosition(int ordinalPosition)
```
    设置列的顺序
    
    参数:
    
    ordinalPosition -
    
    返回:
  - getExtension
```
public Object getExtension(String key)
```
    获得拓展属性值
    
    返回:
  - addExtension
```
public SdColumn addExtension(String key,
                             Object value)
```
    添加附加属性
    
    参数:
    
    key -
    
    value -
    
    返回:
  - getExtensions
```
public Map<String,Object> getExtensions()
```
    获取附加属性
    
    返回:
  - setExtensions
```
public SdColumn setExtensions(Map<String,Object> extensions)
```
    设置附加属性
    
    参数:
    
    extensions -
    
    返回:
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - compareTo
```
public int compareTo(SdColumn obj)
```
    指定者:
    
    compareTo 在接口中 Comparable<SdColumn>

类 SdColumn

构造器概要

方法概要

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

构造器详细资料

SdColumn

方法详细资料

getImports

addImport

setImports

getAnnotations

addAnnotation

setAnnotations

getRelationalContent

setRelationalContent

getFieldType

setFieldType

getFieldName

getFieldNameLower

setFieldNameLower

getFieldNameUpper

setFieldNameUpper

setFieldName

getFieldNamePascal

setFieldNamePascal

getFieldNameHyphen

setFieldNameHyphen

getFieldNameUnderScore

setFieldNameUnderScore

getFieldRemark

setFieldRemark

getName

setName

getType

setType

getLength

setLength

setLength

getPrecision

setPrecision

getDefaults

setDefaults

isPrimary

setPrimary

isForeignKey

getForeignConstraint

setForeignConstraint

getForeignReferencesDB

setForeignReferencesDB

getForeignReferencesTable

setForeignReferencesTable

getForeignReferencesColumn

setForeignReferencesColumn

getPrimaryName

setPrimaryName

isIndex

isUnique

setUnique

isConcurrently

setConcurrently

getIndexType

setIndexType

getIndexName

setIndexName

getIndexRemark

setIndexRemark

isNullable

setNullable

isUnsigned

setUnsigned

isAutoIncrement

setAutoIncrement

isIdentity

setIdentity

getIdentitySeed

getIdentityIncrement

setIdentitySeed

setIdentityIncrement

getSequenceName

setSequenceName