RulesDelegate (MyBatis Generator Core 1.3.5 API)

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

All Implemented Interfaces:: Rules

public class RulesDelegate
extends Object
implements Rules

This class can be used by plugins to easily implement a custom rules implementation. Plugins should respect the rules implementation calculated by the generator, as well as implementations from other plugins. In general if something is disabled by the default rules, or is disabled by some other plugin, it should not be re-enabled. Therefore, the following pattern of use is recommended:

 public class MyPlugin extends PluginAdapter {
   @Override
   public void initialized(IntrospectedTable introspectedTable) {
     MyRules myRules = new MyRules(introspectedTable.getRules());
     introspectedTable.setRules(myRules);
   }
 }
 
 public class MyRules extends RulesDelegate (
   public MyRules(Rules rules) {
     super(rules);
   }
   
   @Override
   public boolean generateInsert() {
     boolean rc = super.generateInsert();
     if (rc) {
       // Other plugins, and the default rules, enable generation
       // of the insert method.  We can decide to disable it here
       // if needed.
     }
     
     return rc;
   }

Author:: Jeff Butler

Field Summary

Fields
Modifier and Type Field and Description

protected Rules rules

Fields
Modifier and Type	Field and Description
`protected Rules`	`rules`

Constructor Summary

Constructors
Constructor and Description

RulesDelegate(Rules rules)

Constructors
Constructor and Description
`RulesDelegate(Rules rules)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FullyQualifiedJavaType`	`calculateAllFieldsClass()` Calculates the class that contains all fields.
`boolean`	`generateBaseColumnList()` Implements the rule for generating the SQL base column list element.
`boolean`	`generateBaseRecordClass()` Implements the rule for generating a base record.
`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`	`generatePrimaryKeyClass()` Implements the rule for determining whether to generate a primary key class.
`boolean`	`generateRecordWithBLOBsClass()` Implements the rule for generating a record with BLOBs.
`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()`

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

- Field Detail
  - rules
```
protected Rules rules
```
- Constructor Detail
  - RulesDelegate
```
public RulesDelegate(Rules rules)
```
- Method Detail
  - calculateAllFieldsClass
```
public FullyQualifiedJavaType calculateAllFieldsClass()
```
    Description copied from interface: Rules
    
    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.
    
    Specified by:
    
    calculateAllFieldsClass in interface Rules
    
    Returns:
    
    the type of the class that holds all fields
  - generateBaseRecordClass
```
public boolean generateBaseRecordClass()
```
    Description copied from interface: Rules
    
    Implements the rule for generating a base record.
    
    Specified by:
    
    generateBaseRecordClass in interface Rules
    
    Returns:
    
    true if the class should be generated
  - generateBaseResultMap
```
public boolean generateBaseResultMap()
```
    Description copied from interface: Rules
    
    Implements the rule for generating the result map without BLOBs. If either select method is allowed, then generate the result map.
    
    Specified by:
    
    generateBaseResultMap in interface Rules
    
    Returns:
    
    true if the result map should be generated
  - generateCountByExample
```
public boolean generateCountByExample()
```
    Specified by:
    
    generateCountByExample in interface Rules
  - generateDeleteByExample
```
public boolean generateDeleteByExample()
```
    Description copied from interface: Rules
    
    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.
    
    Specified by:
    
    generateDeleteByExample in interface Rules
    
    Returns:
    
    true if the element and method should be generated
  - generateDeleteByPrimaryKey
```
public boolean generateDeleteByPrimaryKey()
```
    Description copied from interface: Rules
    
    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.
    
    Specified by:
    
    generateDeleteByPrimaryKey in interface Rules
    
    Returns:
    
    true if the element and method should be generated
  - generateExampleClass
```
public boolean generateExampleClass()
```
    Description copied from interface: Rules
    
    Implements the rule for generating an example class. The class should be generated if the selectByExample or deleteByExample or countByExample methods are allowed.
    
    Specified by:
    
    generateExampleClass in interface Rules
    
    Returns:
    
    true if the example class should be generated
  - generateInsert
```
public boolean generateInsert()
```
    Description copied from interface: Rules
    
    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.
    
    Specified by:
    
    generateInsert in interface Rules
    
    Returns:
    
    true if the element and method should be generated
  - generateInsertSelective
```
public boolean generateInsertSelective()
```
    Description copied from interface: Rules
    
    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.
    
    Specified by:
    
    generateInsertSelective in interface Rules
    
    Returns:
    
    true if the element and method should be generated
  - generatePrimaryKeyClass
```
public boolean generatePrimaryKeyClass()
```
    Description copied from interface: Rules
    
    Implements the rule for determining whether to generate a primary key class. If you return false from this method, and the table has primary key columns, then the primary key columns will be added to the base class.
    
    Specified by:
    
    generatePrimaryKeyClass in interface Rules
    
    Returns:
    
    true if a separate primary key class should be generated
  - generateRecordWithBLOBsClass
```
public boolean generateRecordWithBLOBsClass()
```
    Description copied from interface: Rules
    
    Implements the rule for generating a record with BLOBs. If you return false from this method, and the table had BLOB columns, then the BLOB columns will be added to the base class.
    
    Specified by:
    
    generateRecordWithBLOBsClass in interface Rules
    
    Returns:
    
    true if the record with BLOBs class should be generated
  - generateResultMapWithBLOBs
```
public boolean generateResultMapWithBLOBs()
```
    Description copied from interface: Rules
    
    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.
    
    Specified by:
    
    generateResultMapWithBLOBs in interface Rules
    
    Returns:
    
    true if the result map should be generated
  - generateSelectByExampleWithBLOBs
```
public boolean generateSelectByExampleWithBLOBs()
```
    Description copied from interface: Rules
    
    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.
    
    Specified by:
    
    generateSelectByExampleWithBLOBs in interface Rules
    
    Returns:
    
    true if the element and method should be generated
  - generateSelectByExampleWithoutBLOBs
```
public boolean generateSelectByExampleWithoutBLOBs()
```
    Description copied from interface: Rules
    
    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.
    
    Specified by:
    
    generateSelectByExampleWithoutBLOBs in interface Rules
    
    Returns:
    
    true if the element and method should be generated
  - generateSelectByPrimaryKey
```
public boolean generateSelectByPrimaryKey()
```
    Description copied from interface: Rules
    
    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.
    
    Specified by:
    
    generateSelectByPrimaryKey in interface Rules
    
    Returns:
    
    true if the element and method should be generated
  - generateSQLExampleWhereClause
```
public boolean generateSQLExampleWhereClause()
```
    Description copied from interface: Rules
    
    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.
    
    Specified by:
    
    generateSQLExampleWhereClause in interface Rules
    
    Returns:
    
    true if the SQL where clause element should be generated
  - generateMyBatis3UpdateByExampleWhereClause
```
public boolean generateMyBatis3UpdateByExampleWhereClause()
```
    Description copied from interface: Rules
    
    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 MyBatis, generate the element if the updateByExample statements are allowed.
    
    Specified by:
    
    generateMyBatis3UpdateByExampleWhereClause in interface Rules
    
    Returns:
    
    true if the SQL where clause element should be generated
  - generateUpdateByExampleSelective
```
public boolean generateUpdateByExampleSelective()
```
    Specified by:
    
    generateUpdateByExampleSelective in interface Rules
  - generateUpdateByExampleWithBLOBs
```
public boolean generateUpdateByExampleWithBLOBs()
```
    Specified by:
    
    generateUpdateByExampleWithBLOBs in interface Rules
  - generateUpdateByExampleWithoutBLOBs
```
public boolean generateUpdateByExampleWithoutBLOBs()
```
    Specified by:
    
    generateUpdateByExampleWithoutBLOBs in interface Rules
  - generateUpdateByPrimaryKeySelective
```
public boolean generateUpdateByPrimaryKeySelective()
```
    Description copied from interface: Rules
    
    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.
    
    Specified by:
    
    generateUpdateByPrimaryKeySelective in interface Rules
    
    Returns:
    
    true if the element and method should be generated
  - generateUpdateByPrimaryKeyWithBLOBs
```
public boolean generateUpdateByPrimaryKeyWithBLOBs()
```
    Description copied from interface: Rules
    
    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.
    
    Specified by:
    
    generateUpdateByPrimaryKeyWithBLOBs in interface Rules
    
    Returns:
    
    true if the element and method should be generated
  - generateUpdateByPrimaryKeyWithoutBLOBs
```
public boolean generateUpdateByPrimaryKeyWithoutBLOBs()
```
    Description copied from interface: Rules
    
    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.
    
    Specified by:
    
    generateUpdateByPrimaryKeyWithoutBLOBs in interface Rules
    
    Returns:
    
    true if the element and method should be generated
  - getIntrospectedTable
```
public IntrospectedTable getIntrospectedTable()
```
    Specified by:
    
    getIntrospectedTable in interface Rules
  - generateBaseColumnList
```
public boolean generateBaseColumnList()
```
    Description copied from interface: Rules
    
    Implements the rule for generating the SQL base column list element. Generate the element if any of the select methods are enabled.
    
    Specified by:
    
    generateBaseColumnList in interface Rules
    
    Returns:
    
    true if the SQL base column list element should be generated
  - generateBlobColumnList
```
public boolean generateBlobColumnList()
```
    Description copied from interface: 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.
    
    Specified by:
    
    generateBlobColumnList in interface Rules
    
    Returns:
    
    true if the SQL blob column list element should be generated
  - generateJavaClient
```
public boolean generateJavaClient()
```
    Description copied from interface: 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.
    
    Specified by:
    
    generateJavaClient in interface Rules
    
    Returns:
    
    true if the Java client should be generated

Class RulesDelegate

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

rules

Constructor Detail

RulesDelegate

Method Detail

calculateAllFieldsClass

generateBaseRecordClass

generateBaseResultMap

generateCountByExample

generateDeleteByExample

generateDeleteByPrimaryKey

generateExampleClass

generateInsert

generateInsertSelective

generatePrimaryKeyClass

generateRecordWithBLOBsClass

generateResultMapWithBLOBs

generateSelectByExampleWithBLOBs

generateSelectByExampleWithoutBLOBs

generateSelectByPrimaryKey

generateSQLExampleWhereClause

generateMyBatis3UpdateByExampleWhereClause

generateUpdateByExampleSelective

generateUpdateByExampleWithBLOBs

generateUpdateByExampleWithoutBLOBs

generateUpdateByPrimaryKeySelective

generateUpdateByPrimaryKeyWithBLOBs

generateUpdateByPrimaryKeyWithoutBLOBs

getIntrospectedTable

generateBaseColumnList

generateBlobColumnList

generateJavaClient