org.mybatis.generator.api.Plugin |
![]() |
This interface defines methods that will be called at different times during the code generation process. These methods can be used to extend or modify the generated code. Clients may implement this interface in its entirety, or extend the PluginAdapter (highly recommended).
Plugins have a lifecycle. In general, the lifecycle is this:
Plugins are called, and initialized, in the same order they are specified in the configuration.
The clientXXX, modelXXX, and sqlMapXXX methods are called by the code generators. If you replace the default code generators with other implementations, these methods may not be called.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Plugin.ModelClassType |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
This method is called when the countByExample method has been generated
in the client interface.
| |||||||||||
This method is called when the countByExample method has been generated
in the client implementation class.
| |||||||||||
This method is called when the deleteByExample method has been generated
in the client interface.
| |||||||||||
This method is called when the deleteByExample method has been generated
in the client implementation class.
| |||||||||||
This method is called when the deleteByPrimaryKey method has been
generated in the client interface.
| |||||||||||
This method is called when the deleteByPrimaryKey method has been
generated in the client implementation class.
| |||||||||||
This method is called when the entire client has been generated.
| |||||||||||
This method is called when the insert method has been generated in the
client interface.
| |||||||||||
This method is called when the insert method has been generated in the
client implementation class.
| |||||||||||
This method is called when the insert selective method has been generated
in the client interface.
| |||||||||||
This method is called when the insert selective method has been generated
in the client implementation class.
| |||||||||||
This method is called when the selectByExampleWithBLOBs method has been
generated in the client interface.
| |||||||||||
This method is called when the selectByExampleWithBLOBs method has been
generated in the client implementation class.
| |||||||||||
This method is called when the selectByExampleWithoutBLOBs method has
been generated in the client interface.
| |||||||||||
This method is called when the selectByExampleWithoutBLOBs method has
been generated in the client implementation class.
| |||||||||||
This method is called when the selectByPrimaryKey method has been
generated in the client interface.
| |||||||||||
This method is called when the selectByPrimaryKey method has been
generated in the client implementation class.
| |||||||||||
This method is called when the updateByExampleSelective method has been
generated in the client interface.
| |||||||||||
This method is called when the updateByExampleSelective method has been
generated in the client implementation class.
| |||||||||||
This method is called when the updateByExampleWithBLOBs method has been
generated in the client interface.
| |||||||||||
This method is called when the updateByExampleWithBLOBs method has been
generated in the client implementation class.
| |||||||||||
This method is called when the updateByExampleWithoutBLOBs method has
been generated in the client interface.
| |||||||||||
This method is called when the updateByExampleWithoutBLOBs method has
been generated in the client implementation class.
| |||||||||||
This method is called when the updateByPrimaryKeySelective method has
been generated in the client interface.
| |||||||||||
This method is called when the updateByPrimaryKeySelective method has
been generated in the client implementation class.
| |||||||||||
This method is called when the updateByPrimaryKeyWithBLOBs method has
been generated in the client interface.
| |||||||||||
This method is called when the updateByPrimaryKeyWithBLOBs method has
been generated in the client implementation class.
| |||||||||||
This method is called when the updateByPrimaryKeyWithoutBLOBs method has
been generated in the client interface.
| |||||||||||
This method is called when the updateByPrimaryKeyWithoutBLOBs method has
been generated in the client implementation class.
| |||||||||||
This method can be used to generate any additional Java file needed by
your implementation.
| |||||||||||
This method can be used to generate additional Java files needed by your
implementation that might be related to a specific table.
| |||||||||||
This method can be used to generate any additional XML file needed by
your implementation.
| |||||||||||
This method can be used to generate additional XML files needed by your
implementation that might be related to a specific table.
| |||||||||||
This method is called just before the getGeneratedXXXFiles methods are
called on the introspected table.
| |||||||||||
This method is called after the base record class is generated by the
JavaModelGenerator.
| |||||||||||
This method is called after the example class is generated by the
JavaModelGenerator.
| |||||||||||
This method is called after the field is generated for a specific column
in a table.
| |||||||||||
This method is called after the getter, or accessor, method is generated
for a specific column in a table.
| |||||||||||
This method is called after the primary key class is generated by the
JavaModelGenerator.
| |||||||||||
This method is called after the record with BLOBs class is generated by
the JavaModelGenerator.
| |||||||||||
This method is called after the setter, or mutator, method is generated
for a specific column in a table.
| |||||||||||
This method is called when the applyWhere method has
been generated in the SQL provider.
| |||||||||||
This method is called when the countByExample method has
been generated in the SQL provider.
| |||||||||||
This method is called when the deleteByExample method has
been generated in the SQL provider.
| |||||||||||
This method is called when the SQL provider has been generated.
| |||||||||||
This method is called when the insertSelective method has
been generated in the SQL provider.
| |||||||||||
This method is called when the selectByExampleWithBLOBs method has
been generated in the SQL provider.
| |||||||||||
This method is called when the selectByExampleWithoutBLOBs method has
been generated in the SQL provider.
| |||||||||||
This method is called when the updateByExampleSelective method has
been generated in the SQL provider.
| |||||||||||
This method is called when the updateByExampleWithBLOBs method has
been generated in the SQL provider.
| |||||||||||
This method is called when the updateByExampleWithoutBLOBs method has
been generated in the SQL provider.
| |||||||||||
This method is called when the updateByPrimaryKeySelective method has
been generated in the SQL provider.
| |||||||||||
Set the context under which this plugin is running
| |||||||||||
Set properties from the plugin configuration
| |||||||||||
This method is called when the baseColumnList element is generated.
| |||||||||||
This method is called when the blobColumnList element is generated.
| |||||||||||
This method is called when the countByExample element is generated.
| |||||||||||
This method is called when the deleteByExample element is generated.
| |||||||||||
This method is called when the deleteByPrimaryKey element is generated.
| |||||||||||
This method is called when the SqlMap document has been generated.
| |||||||||||
This method is called when the exampleWhereClause element is generated.
| |||||||||||
This method is called when the SqlMap file has been generated.
| |||||||||||
This method is called when the insert element is generated.
| |||||||||||
This method is called when the insert selective element is generated.
| |||||||||||
This method is called when the resultMap with BLOBs element is generated
- this resultMap will extend the base resultMap.
| |||||||||||
This method is called when the base resultMap is generated.
| |||||||||||
This method is called when the selectByExampleWithBLOBs element is
generated.
| |||||||||||
This method is called when the selectByExample element is generated.
| |||||||||||
This method is called when the selectByPrimaryKey element is generated.
| |||||||||||
This method is called when the updateByExampleSelective element is
generated.
| |||||||||||
This method is called when the updateByExampleWithBLOBs element is
generated.
| |||||||||||
This method is called when the updateByExampleWithourBLOBs element is
generated.
| |||||||||||
This method is called when the updateByPrimaryKeySelective element is
generated.
| |||||||||||
This method is called when the updateByPrimaryKeyWithBLOBs element is
generated.
| |||||||||||
This method is called when the updateByPrimaryKeyWithoutBLOBs element is
generated.
| |||||||||||
This method is called after all the setXXX methods are called, but before
any other method is called.
|
This method is called when the countByExample method has been generated in the client interface.
method | the generated countByExample method |
---|---|
interfaze | the partially implemented client interface. You can add additional imported classes to the interface if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the countByExample method has been generated in the client implementation class.
method | the generated countByExample method |
---|---|
topLevelClass | the partially implemented client implementation class. You can add additional imported classes to the implementation class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the deleteByExample method has been generated in the client interface.
method | the generated deleteByExample method |
---|---|
interfaze | the partially implemented client interface. You can add additional imported classes to the interface if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the deleteByExample method has been generated in the client implementation class.
method | the generated deleteByExample method |
---|---|
topLevelClass | the partially implemented client implementation class. You can add additional imported classes to the implementation class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the deleteByPrimaryKey method has been generated in the client interface.
method | the generated deleteByPrimaryKey method |
---|---|
interfaze | the partially implemented client interface. You can add additional imported classes to the interface if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the deleteByPrimaryKey method has been generated in the client implementation class.
method | the generated deleteByPrimaryKey method |
---|---|
topLevelClass | the partially implemented client implementation class. You can add additional imported classes to the implementation class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the entire client has been generated. Implement this method to add additional methods or fields to a generated client interface or implementation.
interfaze | the generated interface if any, may be null |
---|---|
topLevelClass | the generated implementation class if any, may be null |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the insert method has been generated in the client interface.
method | the generated insert method |
---|---|
interfaze | the partially implemented client interface. You can add additional imported classes to the interface if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the insert method has been generated in the client implementation class.
method | the generated insert method |
---|---|
topLevelClass | the partially implemented client implementation class. You can add additional imported classes to the implementation class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the insert selective method has been generated in the client interface.
method | the generated insert method |
---|---|
interfaze | the partially implemented client interface. You can add additional imported classes to the interface if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the insert selective method has been generated in the client implementation class.
method | the generated insert method |
---|---|
topLevelClass | the partially implemented client implementation class. You can add additional imported classes to the implementation class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the selectByExampleWithBLOBs method has been generated in the client interface.
method | the generated selectByExampleWithBLOBs method |
---|---|
interfaze | the partially implemented client interface. You can add additional imported classes to the interface if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the selectByExampleWithBLOBs method has been generated in the client implementation class.
method | the generated selectByExampleWithBLOBs method |
---|---|
topLevelClass | the partially implemented client implementation class. You can add additional imported classes to the implementation class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the selectByExampleWithoutBLOBs method has been generated in the client interface.
method | the generated selectByExampleWithoutBLOBs method |
---|---|
interfaze | the partially implemented client interface. You can add additional imported classes to the interface if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the selectByExampleWithoutBLOBs method has been generated in the client implementation class.
method | the generated selectByExampleWithoutBLOBs method |
---|---|
topLevelClass | the partially implemented client implementation class. You can add additional imported classes to the implementation class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the selectByPrimaryKey method has been generated in the client interface.
method | the generated selectByPrimaryKey method |
---|---|
interfaze | the partially implemented client interface. You can add additional imported classes to the interface if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the selectByPrimaryKey method has been generated in the client implementation class.
method | the generated selectByPrimaryKey method |
---|---|
topLevelClass | the partially implemented client implementation class. You can add additional imported classes to the implementation class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByExampleSelective method has been generated in the client interface.
method | the generated updateByExampleSelective method |
---|---|
interfaze | the partially implemented client interface. You can add additional imported classes to the interface if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByExampleSelective method has been generated in the client implementation class.
method | the generated updateByExampleSelective method |
---|---|
topLevelClass | the partially implemented client implementation class. You can add additional imported classes to the implementation class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByExampleWithBLOBs method has been generated in the client interface.
method | the generated updateByExampleWithBLOBs method |
---|---|
interfaze | the partially implemented client interface. You can add additional imported classes to the interface if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByExampleWithBLOBs method has been generated in the client implementation class.
method | the generated updateByExampleWithBLOBs method |
---|---|
topLevelClass | the partially implemented client implementation class. You can add additional imported classes to the implementation class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByExampleWithoutBLOBs method has been generated in the client interface.
method | the generated updateByExampleWithoutBLOBs method |
---|---|
interfaze | the partially implemented client interface. You can add additional imported classes to the interface if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByExampleWithoutBLOBs method has been generated in the client implementation class.
method | the generated updateByExampleWithoutBLOBs method |
---|---|
topLevelClass | the partially implemented client implementation class. You can add additional imported classes to the implementation class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByPrimaryKeySelective method has been generated in the client interface.
method | the generated updateByPrimaryKeySelective method |
---|---|
interfaze | the partially implemented client interface. You can add additional imported classes to the interface if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByPrimaryKeySelective method has been generated in the client implementation class.
method | the generated updateByPrimaryKeySelective method |
---|---|
topLevelClass | the partially implemented client implementation class. You can add additional imported classes to the implementation class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByPrimaryKeyWithBLOBs method has been generated in the client interface.
method | the generated updateByPrimaryKeyWithBLOBs method |
---|---|
interfaze | the partially implemented client interface. You can add additional imported classes to the interface if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByPrimaryKeyWithBLOBs method has been generated in the client implementation class.
method | the generated updateByPrimaryKeyWithBLOBs method |
---|---|
topLevelClass | the partially implemented client implementation class. You can add additional imported classes to the implementation class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByPrimaryKeyWithoutBLOBs method has been generated in the client interface.
method | the generated updateByPrimaryKeyWithoutBLOBs method |
---|---|
interfaze | the partially implemented client interface. You can add additional imported classes to the interface if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByPrimaryKeyWithoutBLOBs method has been generated in the client implementation class.
method | the generated updateByPrimaryKeyWithBLOBs method |
---|---|
topLevelClass | the partially implemented client implementation class. You can add additional imported classes to the implementation class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method can be used to generate any additional Java file needed by your implementation. This method is called once, after all other Java files have been generated.
This method can be used to generate additional Java files needed by your implementation that might be related to a specific table. This method is called once for every table in the configuration.
introspectedTable | The class containing information about the table as introspected from the database |
---|
This method can be used to generate any additional XML file needed by your implementation. This method is called once, after all other XML files have been generated.
This method can be used to generate additional XML files needed by your implementation that might be related to a specific table. This method is called once for every table in the configuration.
introspectedTable | The class containing information about the table as introspected from the database |
---|
This method is called just before the getGeneratedXXXFiles methods are called on the introspected table. Plugins can implement this method to override any of the default attributes, or change the results of database introspection, before any code generation activities occur. Attributes are listed as static Strings with the prefix ATTR_ in IntrospectedTable.
A good example of overriding an attribute would be the case where a user wanted to change the name of one of the generated classes, change the target package, or change the name of the generated SQL map file.
Warning: Anything that is listed as an attribute should not be
changed by one of the other plugin methods. For example, if you want to
change the name of a generated example class, you should not simply
change the Type in the modelExampleClassGenerated()
method.
If you do, the change will not be reflected in other generated artifacts.
This method is called after the base record class is generated by the JavaModelGenerator. This method will only be called if the table rules call for generation of a base record class.
This method is only guaranteed to be called by the default Java model generators. Other user supplied generators may, or may not, call this method.topLevelClass | the generated base record class |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called after the example class is generated by the JavaModelGenerator. This method will only be called if the table rules call for generation of an example class.
This method is only guaranteed to be called by the default Java model generators. Other user supplied generators may, or may not, call this method.topLevelClass | the generated example class |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called after the field is generated for a specific column in a table.
field | the field generated for the specified column |
---|---|
topLevelClass | the partially implemented model class. You can add additional imported classes to the implementation class if necessary. |
introspectedColumn | The class containing information about the column related to this field as introspected from the database |
introspectedTable | The class containing information about the table as introspected from the database |
modelClassType | the type of class that the field is generated for |
This method is called after the getter, or accessor, method is generated for a specific column in a table.
method | the getter, or accessor, method generated for the specified column |
---|---|
topLevelClass | the partially implemented model class. You can add additional imported classes to the implementation class if necessary. |
introspectedColumn | The class containing information about the column related to this field as introspected from the database |
introspectedTable | The class containing information about the table as introspected from the database |
modelClassType | the type of class that the field is generated for |
This method is called after the primary key class is generated by the JavaModelGenerator. This method will only be called if the table rules call for generation of a primary key class.
This method is only guaranteed to be called by the Java model generators. Other user supplied generators may, or may not, call this method.topLevelClass | the generated primary key class |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called after the record with BLOBs class is generated by the JavaModelGenerator. This method will only be called if the table rules call for generation of a record with BLOBs class.
This method is only guaranteed to be called by the default Java model generators. Other user supplied generators may, or may not, call this method.topLevelClass | the generated record with BLOBs class |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called after the setter, or mutator, method is generated for a specific column in a table.
method | the setter, or mutator, method generated for the specified column |
---|---|
topLevelClass | the partially implemented model class. You can add additional imported classes to the implementation class if necessary. |
introspectedColumn | The class containing information about the column related to this field as introspected from the database |
introspectedTable | The class containing information about the table as introspected from the database |
modelClassType | the type of class that the field is generated for |
This method is called when the applyWhere method has been generated in the SQL provider.
method | the generated applyWhere method |
---|---|
topLevelClass | the partially generated provider class You can add additional imported classes to the class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the countByExample method has been generated in the SQL provider.
method | the generated countByExample method |
---|---|
topLevelClass | the partially generated provider class You can add additional imported classes to the class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the deleteByExample method has been generated in the SQL provider.
method | the generated deleteByExample method |
---|---|
topLevelClass | the partially generated provider class You can add additional imported classes to the class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the SQL provider has been generated. Implement this method to add additional methods or fields to a generated SQL provider.
topLevelClass | the generated provider |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the insertSelective method has been generated in the SQL provider.
method | the generated insertSelective method |
---|---|
topLevelClass | the partially generated provider class You can add additional imported classes to the class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the selectByExampleWithBLOBs method has been generated in the SQL provider.
method | the generated selectByExampleWithBLOBs method |
---|---|
topLevelClass | the partially generated provider class You can add additional imported classes to the class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the selectByExampleWithoutBLOBs method has been generated in the SQL provider.
method | the generated selectByExampleWithoutBLOBs method |
---|---|
topLevelClass | the partially generated provider class You can add additional imported classes to the class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByExampleSelective method has been generated in the SQL provider.
method | the generated updateByExampleSelective method |
---|---|
topLevelClass | the partially generated provider class You can add additional imported classes to the class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByExampleWithBLOBs method has been generated in the SQL provider.
method | the generated updateByExampleWithBLOBs method |
---|---|
topLevelClass | the partially generated provider class You can add additional imported classes to the class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByExampleWithoutBLOBs method has been generated in the SQL provider.
method | the generated updateByExampleWithoutBLOBs method |
---|---|
topLevelClass | the partially generated provider class You can add additional imported classes to the class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByPrimaryKeySelective method has been generated in the SQL provider.
method | the generated updateByPrimaryKeySelective method |
---|---|
topLevelClass | the partially generated provider class You can add additional imported classes to the class if necessary. |
introspectedTable | The class containing information about the table as introspected from the database |
Set the context under which this plugin is running
Set properties from the plugin configuration
This method is called when the baseColumnList element is generated.
element | the generated <sql> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the blobColumnList element is generated.
element | the generated <sql> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the countByExample element is generated.
element | the generated <select> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the deleteByExample element is generated.
element | the generated <delete> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the deleteByPrimaryKey element is generated.
element | the generated <delete> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the SqlMap document has been generated. This method can be used to add additional XML elements the the generated document.
document | the generated document (note that this is the MyBatis generator's internal Document class - not the w3c XML Document class) |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the exampleWhereClause element is generated.
element | the generated <sql> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the SqlMap file has been generated.
sqlMap | the generated file (containing the file name, package name, and project name) |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the insert element is generated.
element | the generated <insert> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the insert selective element is generated.
element | the generated <insert> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the resultMap with BLOBs element is generated - this resultMap will extend the base resultMap.
element | the generated <resultMap> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the base resultMap is generated.
element | the generated <resultMap> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the selectByExampleWithBLOBs element is generated.
element | the generated <select> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the selectByExample element is generated.
element | the generated <select> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the selectByPrimaryKey element is generated.
element | the generated <select> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByExampleSelective element is generated.
element | the generated <update> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByExampleWithBLOBs element is generated.
element | the generated <update> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByExampleWithourBLOBs element is generated.
element | the generated <update> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByPrimaryKeySelective element is generated.
element | the generated <update> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByPrimaryKeyWithBLOBs element is generated.
element | the generated <update> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called when the updateByPrimaryKeyWithoutBLOBs element is generated.
element | the generated <update> element |
---|---|
introspectedTable | The class containing information about the table as introspected from the database |
This method is called after all the setXXX methods are called, but before any other method is called. This allows the plugin to determine whether it can run or not. For example, if the plugin requires certain properties to be set, and the properties are not set, then the plugin is invalid and will not run.
warnings | add strings to this list to specify warnings. For example, if the plugin is invalid, you should specify why. Warnings are reported to users after the completion of the run. |
---|