BaseRules (mybatis-generator-csz-ddd 1.0.0 API)

java.lang.Object
- org.mybatis.generator.internal.rules.BaseRules

所有已实现的接口:

Rules

直接已知子类:

ConditionalModelRules, FlatModelRules, HierarchicalModelRules
```
public abstract class BaseRules
extends java.lang.Object
implements Rules
```
This class centralizes all the rules related to code generation - including the methods and objects to create, and certain attributes related to those objects.

作者:

Jeff Butler

字段概要

字段
限定符和类型	字段和说明
`protected IntrospectedTable`	`introspectedTable` The introspected table.
`protected boolean`	`isModelOnly` The is model only.
`protected TableConfiguration`	`tableConfiguration` The table configuration.

构造器概要

构造器
构造器和说明

BaseRules(IntrospectedTable introspectedTable)
Instantiates a new base rules.

构造器
构造器和说明
`BaseRules(IntrospectedTable introspectedTable)` Instantiates a new base rules.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`FullyQualifiedJavaType`	`calculateAllFieldsClass()` Calculates the class that contains all fields.
`boolean`	`generateBaseColumnList()` Implements the rule for generating the SQL base column list element.
`boolean`	`generateBaseResultMap()` Implements the rule for generating the result map without BLOBs.
`boolean`	`generateBlobColumnList()` Implements the rule for generating the SQL blob column list element.
`boolean`	`generateCountByExample()`
`boolean`	`generateDeleteByExample()` Implements the rule for generating the delete by example SQL Map element and DAO method.
`boolean`	`generateDeleteByPrimaryKey()` Implements the rule for generating the delete by primary key SQL Map element and DAO method.
`boolean`	`generateExampleClass()` Implements the rule for generating an example class.
`boolean`	`generateInsert()` Implements the rule for generating the insert SQL Map element and DAO method.
`boolean`	`generateInsertSelective()` Implements the rule for generating the insert selective SQL Map element and DAO method.
`boolean`	`generateJavaClient()` Implements the rule for generating a Java client.
`boolean`	`generateMyBatis3UpdateByExampleWhereClause()` Implements the rule for generating the SQL example where clause element specifically for use in the update by example methods.
`boolean`	`generateResultMapWithBLOBs()` Implements the rule for generating the result map with BLOBs.
`boolean`	`generateSelectByExampleWithBLOBs()` Implements the rule for generating the select by example with BLOBs SQL Map element and DAO method.
`boolean`	`generateSelectByExampleWithoutBLOBs()` Implements the rule for generating the select by example without BLOBs SQL Map element and DAO method.
`boolean`	`generateSelectByPrimaryKey()` Implements the rule for generating the select by primary key SQL Map element and DAO method.
`boolean`	`generateSQLExampleWhereClause()` Implements the rule for generating the SQL example where clause element.
`boolean`	`generateUpdateByExampleSelective()`
`boolean`	`generateUpdateByExampleWithBLOBs()`
`boolean`	`generateUpdateByExampleWithoutBLOBs()`
`boolean`	`generateUpdateByPrimaryKeySelective()` Implements the rule for generating the update by primary key selective SQL Map element and DAO method.
`boolean`	`generateUpdateByPrimaryKeyWithBLOBs()` Implements the rule for generating the update by primary key with BLOBs SQL Map element and DAO method.
`boolean`	`generateUpdateByPrimaryKeyWithoutBLOBs()` Implements the rule for generating the update by primary key without BLOBs SQL Map element and DAO method.
`IntrospectedTable`	`getIntrospectedTable()`

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

从接口继承的方法 org.mybatis.generator.internal.rules.Rules
generateBaseRecordClass, generatePrimaryKeyClass, generateRecordWithBLOBsClass

- 字段详细资料
  - tableConfiguration
```
protected TableConfiguration tableConfiguration
```
    The table configuration.
  - introspectedTable
```
protected IntrospectedTable introspectedTable
```
    The introspected table.
  - isModelOnly
```
protected final boolean isModelOnly
```
    The is model only.
- 构造器详细资料
  - BaseRules
```
public BaseRules(IntrospectedTable introspectedTable)
```
    Instantiates a new base rules.
    
    参数:
    
    introspectedTable - the introspected table
- 方法详细资料
  - generateInsert
```
public boolean generateInsert()
```
    Implements the rule for generating the insert SQL Map element and DAO method. If the insert statement is allowed, then generate the element and method.
    
    指定者:
    
    generateInsert 在接口中 Rules
    
    返回:
    
    true if the element and method should be generated
  - generateInsertSelective
```
public boolean generateInsertSelective()
```
    Implements the rule for generating the insert selective SQL Map element and DAO method. If the insert statement is allowed, then generate the element and method.
    
    指定者:
    
    generateInsertSelective 在接口中 Rules
    
    返回:
    
    true if the element and method should be generated
  - calculateAllFieldsClass
```
public FullyQualifiedJavaType calculateAllFieldsClass()
```
    Calculates the class that contains all fields. This class is used as the insert statement parameter, as well as the returned value from the select by primary key method. The actual class depends on how the domain model is generated.
    
    指定者:
    
    calculateAllFieldsClass 在接口中 Rules
    
    返回:
    
    the type of the class that holds all fields
  - generateUpdateByPrimaryKeyWithoutBLOBs
```
public boolean generateUpdateByPrimaryKeyWithoutBLOBs()
```
    Implements the rule for generating the update by primary key without BLOBs SQL Map element and DAO method. If the table has a primary key as well as other non-BLOB fields, and the updateByPrimaryKey statement is allowed, then generate the element and method.
    
    指定者:
    
    generateUpdateByPrimaryKeyWithoutBLOBs 在接口中 Rules
    
    返回:
    
    true if the element and method should be generated
  - generateUpdateByPrimaryKeyWithBLOBs
```
public boolean generateUpdateByPrimaryKeyWithBLOBs()
```
    Implements the rule for generating the update by primary key with BLOBs SQL Map element and DAO method. If the table has a primary key as well as other BLOB fields, and the updateByPrimaryKey statement is allowed, then generate the element and method.
    
    指定者:
    
    generateUpdateByPrimaryKeyWithBLOBs 在接口中 Rules
    
    返回:
    
    true if the element and method should be generated
  - generateUpdateByPrimaryKeySelective
```
public boolean generateUpdateByPrimaryKeySelective()
```
    Implements the rule for generating the update by primary key selective SQL Map element and DAO method. If the table has a primary key as well as other fields, and the updateByPrimaryKey statement is allowed, then generate the element and method.
    
    指定者:
    
    generateUpdateByPrimaryKeySelective 在接口中 Rules
    
    返回:
    
    true if the element and method should be generated
  - generateDeleteByPrimaryKey
```
public boolean generateDeleteByPrimaryKey()
```
    Implements the rule for generating the delete by primary key SQL Map element and DAO method. If the table has a primary key, and the deleteByPrimaryKey statement is allowed, then generate the element and method.
    
    指定者:
    
    generateDeleteByPrimaryKey 在接口中 Rules
    
    返回:
    
    true if the element and method should be generated
  - generateDeleteByExample
```
public boolean generateDeleteByExample()
```
    Implements the rule for generating the delete by example SQL Map element and DAO method. If the deleteByExample statement is allowed, then generate the element and method.
    
    指定者:
    
    generateDeleteByExample 在接口中 Rules
    
    返回:
    
    true if the element and method should be generated
  - generateBaseResultMap
```
public boolean generateBaseResultMap()
```
    Implements the rule for generating the result map without BLOBs. If either select method is allowed, then generate the result map.
    
    指定者:
    
    generateBaseResultMap 在接口中 Rules
    
    返回:
    
    true if the result map should be generated
  - generateResultMapWithBLOBs
```
public boolean generateResultMapWithBLOBs()
```
    Implements the rule for generating the result map with BLOBs. If the table has BLOB columns, and either select method is allowed, then generate the result map.
    
    指定者:
    
    generateResultMapWithBLOBs 在接口中 Rules
    
    返回:
    
    true if the result map should be generated
  - generateSQLExampleWhereClause
```
public boolean generateSQLExampleWhereClause()
```
    Implements the rule for generating the SQL example where clause element. In iBATIS2, generate the element if the selectByExample, deleteByExample, updateByExample, or countByExample statements are allowed. In MyBatis3, generate the element if the selectByExample, deleteByExample, or countByExample statements are allowed.
    
    指定者:
    
    generateSQLExampleWhereClause 在接口中 Rules
    
    返回:
    
    true if the SQL where clause element should be generated
  - generateMyBatis3UpdateByExampleWhereClause
```
public boolean generateMyBatis3UpdateByExampleWhereClause()
```
    Implements the rule for generating the SQL example where clause element specifically for use in the update by example methods. In iBATIS2, do not generate the element. In MyBatis3, generate the element if the updateByExample statements are allowed.
    
    指定者:
    
    generateMyBatis3UpdateByExampleWhereClause 在接口中 Rules
    
    返回:
    
    true if the SQL where clause element should be generated
  - generateSelectByPrimaryKey
```
public boolean generateSelectByPrimaryKey()
```
    Implements the rule for generating the select by primary key SQL Map element and DAO method. If the table has a primary key as well as other fields, and the selectByPrimaryKey statement is allowed, then generate the element and method.
    
    指定者:
    
    generateSelectByPrimaryKey 在接口中 Rules
    
    返回:
    
    true if the element and method should be generated
  - generateSelectByExampleWithoutBLOBs
```
public boolean generateSelectByExampleWithoutBLOBs()
```
    Implements the rule for generating the select by example without BLOBs SQL Map element and DAO method. If the selectByExample statement is allowed, then generate the element and method.
    
    指定者:
    
    generateSelectByExampleWithoutBLOBs 在接口中 Rules
    
    返回:
    
    true if the element and method should be generated
  - generateSelectByExampleWithBLOBs
```
public boolean generateSelectByExampleWithBLOBs()
```
    Implements the rule for generating the select by example with BLOBs SQL Map element and DAO method. If the table has BLOB fields and the selectByExample statement is allowed, then generate the element and method.
    
    指定者:
    
    generateSelectByExampleWithBLOBs 在接口中 Rules
    
    返回:
    
    true if the element and method should be generated
  - generateExampleClass
```
public boolean generateExampleClass()
```
    Implements the rule for generating an example class. The class should be generated if the selectByExample or deleteByExample or countByExample methods are allowed.
    
    指定者:
    
    generateExampleClass 在接口中 Rules
    
    返回:
    
    true if the example class should be generated
  - generateCountByExample
```
public boolean generateCountByExample()
```
    指定者:
    
    generateCountByExample 在接口中 Rules
  - generateUpdateByExampleSelective
```
public boolean generateUpdateByExampleSelective()
```
    指定者:
    
    generateUpdateByExampleSelective 在接口中 Rules
  - generateUpdateByExampleWithoutBLOBs
```
public boolean generateUpdateByExampleWithoutBLOBs()
```
    指定者:
    
    generateUpdateByExampleWithoutBLOBs 在接口中 Rules
  - generateUpdateByExampleWithBLOBs
```
public boolean generateUpdateByExampleWithBLOBs()
```
    指定者:
    
    generateUpdateByExampleWithBLOBs 在接口中 Rules
  - getIntrospectedTable
```
public IntrospectedTable getIntrospectedTable()
```
    指定者:
    
    getIntrospectedTable 在接口中 Rules
  - generateBaseColumnList
```
public boolean generateBaseColumnList()
```
    从接口复制的说明: Rules
    
    Implements the rule for generating the SQL base column list element. Generate the element if any of the select methods are enabled.
    
    指定者:
    
    generateBaseColumnList 在接口中 Rules
    
    返回:
    
    true if the SQL base column list element should be generated
  - generateBlobColumnList
```
public boolean generateBlobColumnList()
```
    从接口复制的说明: Rules
    
    Implements the rule for generating the SQL blob column list element. Generate the element if any of the select methods are enabled, and the table contains BLOB columns.
    
    指定者:
    
    generateBlobColumnList 在接口中 Rules
    
    返回:
    
    true if the SQL blob column list element should be generated
  - generateJavaClient
```
public boolean generateJavaClient()
```
    从接口复制的说明: Rules
    
    Implements the rule for generating a Java client. This rule is only active when a javaClientGenerator configuration has been specified, but the table is designated as "modelOnly". Do not generate the client if the table is designated as modelOnly.
    
    指定者:
    
    generateJavaClient 在接口中 Rules
    
    返回:
    
    true if the Java client should be generated

类 BaseRules

字段概要

构造器概要

方法概要

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

从接口继承的方法 org.mybatis.generator.internal.rules.Rules

字段详细资料

tableConfiguration

introspectedTable

isModelOnly

构造器详细资料

BaseRules

方法详细资料

generateInsert

generateInsertSelective

calculateAllFieldsClass

generateUpdateByPrimaryKeyWithoutBLOBs

generateUpdateByPrimaryKeyWithBLOBs

generateUpdateByPrimaryKeySelective

generateDeleteByPrimaryKey

generateDeleteByExample

generateBaseResultMap

generateResultMapWithBLOBs

generateSQLExampleWhereClause

generateMyBatis3UpdateByExampleWhereClause

generateSelectByPrimaryKey

generateSelectByExampleWithoutBLOBs

generateSelectByExampleWithBLOBs

generateExampleClass

generateCountByExample

generateUpdateByExampleSelective

generateUpdateByExampleWithoutBLOBs

generateUpdateByExampleWithBLOBs

getIntrospectedTable

generateBaseColumnList

generateBlobColumnList

generateJavaClient