org.mybatis.generator.api
Interface Plugin

All Known Implementing Classes:
CachePlugin, CaseInsensitiveLikePlugin, EqualsHashCodePlugin, MapperConfigPlugin, PluginAdapter, PluginAggregator, RenameExampleClassPlugin, RowBoundsPlugin, SerializablePlugin, SqlMapConfigPlugin, ToStringPlugin, VirtualPrimaryKeyPlugin

public interface 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:

  1. The setXXX methods are called one time
  2. The validate method is called one time
  3. The initialized method is called for each introspected table
  4. The clientXXX methods are called for each introspected table
  5. The providerXXX methods are called for each introspected table
  6. The modelXXX methods are called for each introspected table
  7. The sqlMapXXX methods are called for each introspected table
  8. The contextGenerateAdditionalJavaFiles(IntrospectedTable) method is called for each introspected table
  9. The contextGenerateAdditionalXmlFiles(IntrospectedTable) method is called for each introspected table
  10. The contextGenerateAdditionalJavaFiles() method is called one time
  11. The contextGenerateAdditionalXmlFiles() method is called one time
Plugins are related to contexts - so each context will have its own set of plugins. If the same plugin is specified in multiple contexts, then each context will hold a unique instance of the plugin.

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.

Author:
Jeff Butler
See Also:
PluginAdapter

Nested Class Summary
static class Plugin.ModelClassType
           
 
Method Summary
 boolean clientCountByExampleMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
          This method is called when the countByExample method has been generated in the client interface.
 boolean clientCountByExampleMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the countByExample method has been generated in the client implementation class.
 boolean clientDeleteByExampleMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
          This method is called when the deleteByExample method has been generated in the client interface.
 boolean clientDeleteByExampleMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the deleteByExample method has been generated in the client implementation class.
 boolean clientDeleteByPrimaryKeyMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
          This method is called when the deleteByPrimaryKey method has been generated in the client interface.
 boolean clientDeleteByPrimaryKeyMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the deleteByPrimaryKey method has been generated in the client implementation class.
 boolean clientGenerated(Interface interfaze, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the entire client has been generated.
 boolean clientInsertMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
          This method is called when the insert method has been generated in the client interface.
 boolean clientInsertMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the insert method has been generated in the client implementation class.
 boolean clientInsertSelectiveMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
          This method is called when the insert selective method has been generated in the client interface.
 boolean clientInsertSelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the insert selective method has been generated in the client implementation class.
 boolean clientSelectAllMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
          This method is called when the selectAll method has been generated in the client interface.
 boolean clientSelectAllMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the selectAll method has been generated in the client implementation class.
 boolean clientSelectByExampleWithBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
          This method is called when the selectByExampleWithBLOBs method has been generated in the client interface.
 boolean clientSelectByExampleWithBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the selectByExampleWithBLOBs method has been generated in the client implementation class.
 boolean clientSelectByExampleWithoutBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
          This method is called when the selectByExampleWithoutBLOBs method has been generated in the client interface.
 boolean clientSelectByExampleWithoutBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the selectByExampleWithoutBLOBs method has been generated in the client implementation class.
 boolean clientSelectByPrimaryKeyMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
          This method is called when the selectByPrimaryKey method has been generated in the client interface.
 boolean clientSelectByPrimaryKeyMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the selectByPrimaryKey method has been generated in the client implementation class.
 boolean clientUpdateByExampleSelectiveMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
          This method is called when the updateByExampleSelective method has been generated in the client interface.
 boolean clientUpdateByExampleSelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the updateByExampleSelective method has been generated in the client implementation class.
 boolean clientUpdateByExampleWithBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
          This method is called when the updateByExampleWithBLOBs method has been generated in the client interface.
 boolean clientUpdateByExampleWithBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the updateByExampleWithBLOBs method has been generated in the client implementation class.
 boolean clientUpdateByExampleWithoutBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
          This method is called when the updateByExampleWithoutBLOBs method has been generated in the client interface.
 boolean clientUpdateByExampleWithoutBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the updateByExampleWithoutBLOBs method has been generated in the client implementation class.
 boolean clientUpdateByPrimaryKeySelectiveMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
          This method is called when the updateByPrimaryKeySelective method has been generated in the client interface.
 boolean clientUpdateByPrimaryKeySelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the updateByPrimaryKeySelective method has been generated in the client implementation class.
 boolean clientUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
          This method is called when the updateByPrimaryKeyWithBLOBs method has been generated in the client interface.
 boolean clientUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the updateByPrimaryKeyWithBLOBs method has been generated in the client implementation class.
 boolean clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
          This method is called when the updateByPrimaryKeyWithoutBLOBs method has been generated in the client interface.
 boolean clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the updateByPrimaryKeyWithoutBLOBs method has been generated in the client implementation class.
 List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles()
          This method can be used to generate any additional Java file needed by your implementation.
 List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles(IntrospectedTable introspectedTable)
          This method can be used to generate additional Java files needed by your implementation that might be related to a specific table.
 List<GeneratedXmlFile> contextGenerateAdditionalXmlFiles()
          This method can be used to generate any additional XML file needed by your implementation.
 List<GeneratedXmlFile> contextGenerateAdditionalXmlFiles(IntrospectedTable introspectedTable)
          This method can be used to generate additional XML files needed by your implementation that might be related to a specific table.
 void initialized(IntrospectedTable introspectedTable)
          This method is called just before the getGeneratedXXXFiles methods are called on the introspected table.
 boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called after the base record class is generated by the JavaModelGenerator.
 boolean modelExampleClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called after the example class is generated by the JavaModelGenerator.
 boolean modelFieldGenerated(Field field, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, Plugin.ModelClassType modelClassType)
          This method is called after the field is generated for a specific column in a table.
 boolean modelGetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, Plugin.ModelClassType modelClassType)
          This method is called after the getter, or accessor, method is generated for a specific column in a table.
 boolean modelPrimaryKeyClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called after the primary key class is generated by the JavaModelGenerator.
 boolean modelRecordWithBLOBsClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called after the record with BLOBs class is generated by the JavaModelGenerator.
 boolean modelSetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, Plugin.ModelClassType modelClassType)
          This method is called after the setter, or mutator, method is generated for a specific column in a table.
 boolean providerApplyWhereMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the applyWhere method has been generated in the SQL provider.
 boolean providerCountByExampleMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the countByExample method has been generated in the SQL provider.
 boolean providerDeleteByExampleMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the deleteByExample method has been generated in the SQL provider.
 boolean providerGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the SQL provider has been generated.
 boolean providerInsertSelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the insertSelective method has been generated in the SQL provider.
 boolean providerSelectByExampleWithBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the selectByExampleWithBLOBs method has been generated in the SQL provider.
 boolean providerSelectByExampleWithoutBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the selectByExampleWithoutBLOBs method has been generated in the SQL provider.
 boolean providerUpdateByExampleSelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the updateByExampleSelective method has been generated in the SQL provider.
 boolean providerUpdateByExampleWithBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the updateByExampleWithBLOBs method has been generated in the SQL provider.
 boolean providerUpdateByExampleWithoutBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the updateByExampleWithoutBLOBs method has been generated in the SQL provider.
 boolean providerUpdateByPrimaryKeySelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
          This method is called when the updateByPrimaryKeySelective method has been generated in the SQL provider.
 void setContext(Context context)
          Set the context under which this plugin is running
 void setProperties(Properties properties)
          Set properties from the plugin configuration
 boolean sqlMapBaseColumnListElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the baseColumnList element is generated.
 boolean sqlMapBlobColumnListElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the blobColumnList element is generated.
 boolean sqlMapCountByExampleElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the countByExample element is generated.
 boolean sqlMapDeleteByExampleElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the deleteByExample element is generated.
 boolean sqlMapDeleteByPrimaryKeyElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the deleteByPrimaryKey element is generated.
 boolean sqlMapDocumentGenerated(Document document, IntrospectedTable introspectedTable)
          This method is called when the SqlMap document has been generated.
 boolean sqlMapExampleWhereClauseElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the exampleWhereClause element is generated.
 boolean sqlMapGenerated(GeneratedXmlFile sqlMap, IntrospectedTable introspectedTable)
          This method is called when the SqlMap file has been generated.
 boolean sqlMapInsertElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the insert element is generated.
 boolean sqlMapInsertSelectiveElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the insert selective element is generated.
 boolean sqlMapResultMapWithBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the resultMap with BLOBs element is generated - this resultMap will extend the base resultMap.
 boolean sqlMapResultMapWithoutBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the base resultMap is generated.
 boolean sqlMapSelectAllElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the selectAll element is generated.
 boolean sqlMapSelectByExampleWithBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the selectByExampleWithBLOBs element is generated.
 boolean sqlMapSelectByExampleWithoutBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the selectByExample element is generated.
 boolean sqlMapSelectByPrimaryKeyElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the selectByPrimaryKey element is generated.
 boolean sqlMapUpdateByExampleSelectiveElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the updateByExampleSelective element is generated.
 boolean sqlMapUpdateByExampleWithBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the updateByExampleWithBLOBs element is generated.
 boolean sqlMapUpdateByExampleWithoutBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the updateByExampleWithourBLOBs element is generated.
 boolean sqlMapUpdateByPrimaryKeySelectiveElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the updateByPrimaryKeySelective element is generated.
 boolean sqlMapUpdateByPrimaryKeyWithBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the updateByPrimaryKeyWithBLOBs element is generated.
 boolean sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
          This method is called when the updateByPrimaryKeyWithoutBLOBs element is generated.
 boolean validate(List<String> warnings)
          This method is called after all the setXXX methods are called, but before any other method is called.
 

Method Detail

setContext

void setContext(Context context)
Set the context under which this plugin is running

Parameters:
context -

setProperties

void setProperties(Properties properties)
Set properties from the plugin configuration

Parameters:
properties -

initialized

void initialized(IntrospectedTable introspectedTable)
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.

Parameters:
introspectedTable -

validate

boolean validate(List<String> warnings)
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.

Parameters:
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.
Returns:
true if the plugin is in a valid state. Invalid plugins will not be called

contextGenerateAdditionalJavaFiles

List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles()
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.

Returns:
a List of GeneratedJavaFiles - these files will be saved with the other files from this run.

contextGenerateAdditionalJavaFiles

List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles(IntrospectedTable introspectedTable)
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.

Parameters:
introspectedTable - The class containing information about the table as introspected from the database
Returns:
a List of GeneratedJavaFiles - these files will be saved with the other files from this run.

contextGenerateAdditionalXmlFiles

List<GeneratedXmlFile> contextGenerateAdditionalXmlFiles()
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.

Returns:
a List of GeneratedXmlFiles - these files will be saved with the other files from this run.

contextGenerateAdditionalXmlFiles

List<GeneratedXmlFile> contextGenerateAdditionalXmlFiles(IntrospectedTable introspectedTable)
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.

Parameters:
introspectedTable - The class containing information about the table as introspected from the database
Returns:
a List of GeneratedXmlFiles - these files will be saved with the other files from this run.

clientGenerated

boolean clientGenerated(Interface interfaze,
                        TopLevelClass topLevelClass,
                        IntrospectedTable introspectedTable)
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.

Parameters:
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
Returns:
true if the interface should be generated, false if the generated interface should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientCountByExampleMethodGenerated

boolean clientCountByExampleMethodGenerated(Method method,
                                            TopLevelClass topLevelClass,
                                            IntrospectedTable introspectedTable)
This method is called when the countByExample method has been generated in the client implementation class.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientDeleteByExampleMethodGenerated

boolean clientDeleteByExampleMethodGenerated(Method method,
                                             TopLevelClass topLevelClass,
                                             IntrospectedTable introspectedTable)
This method is called when the deleteByExample method has been generated in the client implementation class.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientDeleteByPrimaryKeyMethodGenerated

boolean clientDeleteByPrimaryKeyMethodGenerated(Method method,
                                                TopLevelClass topLevelClass,
                                                IntrospectedTable introspectedTable)
This method is called when the deleteByPrimaryKey method has been generated in the client implementation class.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientInsertMethodGenerated

boolean clientInsertMethodGenerated(Method method,
                                    TopLevelClass topLevelClass,
                                    IntrospectedTable introspectedTable)
This method is called when the insert method has been generated in the client implementation class.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientInsertSelectiveMethodGenerated

boolean clientInsertSelectiveMethodGenerated(Method method,
                                             TopLevelClass topLevelClass,
                                             IntrospectedTable introspectedTable)
This method is called when the insert selective method has been generated in the client implementation class.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientSelectByExampleWithBLOBsMethodGenerated

boolean clientSelectByExampleWithBLOBsMethodGenerated(Method method,
                                                      TopLevelClass topLevelClass,
                                                      IntrospectedTable introspectedTable)
This method is called when the selectByExampleWithBLOBs method has been generated in the client implementation class.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientSelectByExampleWithoutBLOBsMethodGenerated

boolean clientSelectByExampleWithoutBLOBsMethodGenerated(Method method,
                                                         TopLevelClass topLevelClass,
                                                         IntrospectedTable introspectedTable)
This method is called when the selectByExampleWithoutBLOBs method has been generated in the client implementation class.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientSelectByPrimaryKeyMethodGenerated

boolean clientSelectByPrimaryKeyMethodGenerated(Method method,
                                                TopLevelClass topLevelClass,
                                                IntrospectedTable introspectedTable)
This method is called when the selectByPrimaryKey method has been generated in the client implementation class.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientUpdateByExampleSelectiveMethodGenerated

boolean clientUpdateByExampleSelectiveMethodGenerated(Method method,
                                                      TopLevelClass topLevelClass,
                                                      IntrospectedTable introspectedTable)
This method is called when the updateByExampleSelective method has been generated in the client implementation class.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientUpdateByExampleWithBLOBsMethodGenerated

boolean clientUpdateByExampleWithBLOBsMethodGenerated(Method method,
                                                      TopLevelClass topLevelClass,
                                                      IntrospectedTable introspectedTable)
This method is called when the updateByExampleWithBLOBs method has been generated in the client implementation class.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientUpdateByExampleWithoutBLOBsMethodGenerated

boolean clientUpdateByExampleWithoutBLOBsMethodGenerated(Method method,
                                                         TopLevelClass topLevelClass,
                                                         IntrospectedTable introspectedTable)
This method is called when the updateByExampleWithoutBLOBs method has been generated in the client implementation class.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientUpdateByPrimaryKeySelectiveMethodGenerated

boolean clientUpdateByPrimaryKeySelectiveMethodGenerated(Method method,
                                                         TopLevelClass topLevelClass,
                                                         IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeySelective method has been generated in the client implementation class.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientUpdateByPrimaryKeyWithBLOBsMethodGenerated

boolean clientUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method,
                                                         TopLevelClass topLevelClass,
                                                         IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeyWithBLOBs method has been generated in the client implementation class.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated

boolean clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(Method method,
                                                            TopLevelClass topLevelClass,
                                                            IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeyWithoutBLOBs method has been generated in the client implementation class.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientCountByExampleMethodGenerated

boolean clientCountByExampleMethodGenerated(Method method,
                                            Interface interfaze,
                                            IntrospectedTable introspectedTable)
This method is called when the countByExample method has been generated in the client interface.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientDeleteByExampleMethodGenerated

boolean clientDeleteByExampleMethodGenerated(Method method,
                                             Interface interfaze,
                                             IntrospectedTable introspectedTable)
This method is called when the deleteByExample method has been generated in the client interface.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientDeleteByPrimaryKeyMethodGenerated

boolean clientDeleteByPrimaryKeyMethodGenerated(Method method,
                                                Interface interfaze,
                                                IntrospectedTable introspectedTable)
This method is called when the deleteByPrimaryKey method has been generated in the client interface.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientInsertMethodGenerated

boolean clientInsertMethodGenerated(Method method,
                                    Interface interfaze,
                                    IntrospectedTable introspectedTable)
This method is called when the insert method has been generated in the client interface.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientInsertSelectiveMethodGenerated

boolean clientInsertSelectiveMethodGenerated(Method method,
                                             Interface interfaze,
                                             IntrospectedTable introspectedTable)
This method is called when the insert selective method has been generated in the client interface.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientSelectAllMethodGenerated

boolean clientSelectAllMethodGenerated(Method method,
                                       Interface interfaze,
                                       IntrospectedTable introspectedTable)
This method is called when the selectAll method has been generated in the client interface. This method is only generated by the simple runtime.

Parameters:
method - the generated selectAll 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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientSelectAllMethodGenerated

boolean clientSelectAllMethodGenerated(Method method,
                                       TopLevelClass topLevelClass,
                                       IntrospectedTable introspectedTable)
This method is called when the selectAll method has been generated in the client implementation class.

Parameters:
method - the generated selectAll 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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientSelectByExampleWithBLOBsMethodGenerated

boolean clientSelectByExampleWithBLOBsMethodGenerated(Method method,
                                                      Interface interfaze,
                                                      IntrospectedTable introspectedTable)
This method is called when the selectByExampleWithBLOBs method has been generated in the client interface.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientSelectByExampleWithoutBLOBsMethodGenerated

boolean clientSelectByExampleWithoutBLOBsMethodGenerated(Method method,
                                                         Interface interfaze,
                                                         IntrospectedTable introspectedTable)
This method is called when the selectByExampleWithoutBLOBs method has been generated in the client interface.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientSelectByPrimaryKeyMethodGenerated

boolean clientSelectByPrimaryKeyMethodGenerated(Method method,
                                                Interface interfaze,
                                                IntrospectedTable introspectedTable)
This method is called when the selectByPrimaryKey method has been generated in the client interface.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientUpdateByExampleSelectiveMethodGenerated

boolean clientUpdateByExampleSelectiveMethodGenerated(Method method,
                                                      Interface interfaze,
                                                      IntrospectedTable introspectedTable)
This method is called when the updateByExampleSelective method has been generated in the client interface.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientUpdateByExampleWithBLOBsMethodGenerated

boolean clientUpdateByExampleWithBLOBsMethodGenerated(Method method,
                                                      Interface interfaze,
                                                      IntrospectedTable introspectedTable)
This method is called when the updateByExampleWithBLOBs method has been generated in the client interface.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientUpdateByExampleWithoutBLOBsMethodGenerated

boolean clientUpdateByExampleWithoutBLOBsMethodGenerated(Method method,
                                                         Interface interfaze,
                                                         IntrospectedTable introspectedTable)
This method is called when the updateByExampleWithoutBLOBs method has been generated in the client interface.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientUpdateByPrimaryKeySelectiveMethodGenerated

boolean clientUpdateByPrimaryKeySelectiveMethodGenerated(Method method,
                                                         Interface interfaze,
                                                         IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeySelective method has been generated in the client interface.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientUpdateByPrimaryKeyWithBLOBsMethodGenerated

boolean clientUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method,
                                                         Interface interfaze,
                                                         IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeyWithBLOBs method has been generated in the client interface.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated

boolean clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(Method method,
                                                            Interface interfaze,
                                                            IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeyWithoutBLOBs method has been generated in the client interface.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

modelFieldGenerated

boolean modelFieldGenerated(Field field,
                            TopLevelClass topLevelClass,
                            IntrospectedColumn introspectedColumn,
                            IntrospectedTable introspectedTable,
                            Plugin.ModelClassType modelClassType)
This method is called after the field is generated for a specific column in a table.

Parameters:
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
Returns:
true if the field should be generated, false if the generated field should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

modelGetterMethodGenerated

boolean modelGetterMethodGenerated(Method method,
                                   TopLevelClass topLevelClass,
                                   IntrospectedColumn introspectedColumn,
                                   IntrospectedTable introspectedTable,
                                   Plugin.ModelClassType modelClassType)
This method is called after the getter, or accessor, method is generated for a specific column in a table.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

modelSetterMethodGenerated

boolean modelSetterMethodGenerated(Method method,
                                   TopLevelClass topLevelClass,
                                   IntrospectedColumn introspectedColumn,
                                   IntrospectedTable introspectedTable,
                                   Plugin.ModelClassType modelClassType)
This method is called after the setter, or mutator, method is generated for a specific column in a table.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

modelPrimaryKeyClassGenerated

boolean modelPrimaryKeyClassGenerated(TopLevelClass topLevelClass,
                                      IntrospectedTable introspectedTable)
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.

Parameters:
topLevelClass - the generated primary key class
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the class should be generated, false if the generated class should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

modelBaseRecordClassGenerated

boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass,
                                      IntrospectedTable introspectedTable)
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.

Parameters:
topLevelClass - the generated base record class
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the class should be generated, false if the generated class should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

modelRecordWithBLOBsClassGenerated

boolean modelRecordWithBLOBsClassGenerated(TopLevelClass topLevelClass,
                                           IntrospectedTable introspectedTable)
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.

Parameters:
topLevelClass - the generated record with BLOBs class
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the class should be generated, false if the generated class should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

modelExampleClassGenerated

boolean modelExampleClassGenerated(TopLevelClass topLevelClass,
                                   IntrospectedTable introspectedTable)
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.

Parameters:
topLevelClass - the generated example class
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the class should be generated, false if the generated class should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapGenerated

boolean sqlMapGenerated(GeneratedXmlFile sqlMap,
                        IntrospectedTable introspectedTable)
This method is called when the SqlMap file has been generated.

Parameters:
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
Returns:
true if the sqlMap should be generated, false if the generated sqlMap should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapDocumentGenerated

boolean sqlMapDocumentGenerated(Document document,
                                IntrospectedTable introspectedTable)
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.

Parameters:
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
Returns:
true if the document should be generated, false if the generated document should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins. Also, if any plugin returns false, then the sqlMapGenerated method will not be called.

sqlMapResultMapWithoutBLOBsElementGenerated

boolean sqlMapResultMapWithoutBLOBsElementGenerated(XmlElement element,
                                                    IntrospectedTable introspectedTable)
This method is called when the base resultMap is generated.

Parameters:
element - the generated <resultMap> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapCountByExampleElementGenerated

boolean sqlMapCountByExampleElementGenerated(XmlElement element,
                                             IntrospectedTable introspectedTable)
This method is called when the countByExample element is generated.

Parameters:
element - the generated <select> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapDeleteByExampleElementGenerated

boolean sqlMapDeleteByExampleElementGenerated(XmlElement element,
                                              IntrospectedTable introspectedTable)
This method is called when the deleteByExample element is generated.

Parameters:
element - the generated <delete> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapDeleteByPrimaryKeyElementGenerated

boolean sqlMapDeleteByPrimaryKeyElementGenerated(XmlElement element,
                                                 IntrospectedTable introspectedTable)
This method is called when the deleteByPrimaryKey element is generated.

Parameters:
element - the generated <delete> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapExampleWhereClauseElementGenerated

boolean sqlMapExampleWhereClauseElementGenerated(XmlElement element,
                                                 IntrospectedTable introspectedTable)
This method is called when the exampleWhereClause element is generated.

Parameters:
element - the generated <sql> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapBaseColumnListElementGenerated

boolean sqlMapBaseColumnListElementGenerated(XmlElement element,
                                             IntrospectedTable introspectedTable)
This method is called when the baseColumnList element is generated.

Parameters:
element - the generated <sql> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapBlobColumnListElementGenerated

boolean sqlMapBlobColumnListElementGenerated(XmlElement element,
                                             IntrospectedTable introspectedTable)
This method is called when the blobColumnList element is generated.

Parameters:
element - the generated <sql> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapInsertElementGenerated

boolean sqlMapInsertElementGenerated(XmlElement element,
                                     IntrospectedTable introspectedTable)
This method is called when the insert element is generated.

Parameters:
element - the generated <insert> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapInsertSelectiveElementGenerated

boolean sqlMapInsertSelectiveElementGenerated(XmlElement element,
                                              IntrospectedTable introspectedTable)
This method is called when the insert selective element is generated.

Parameters:
element - the generated <insert> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapResultMapWithBLOBsElementGenerated

boolean sqlMapResultMapWithBLOBsElementGenerated(XmlElement element,
                                                 IntrospectedTable introspectedTable)
This method is called when the resultMap with BLOBs element is generated - this resultMap will extend the base resultMap.

Parameters:
element - the generated <resultMap> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapSelectAllElementGenerated

boolean sqlMapSelectAllElementGenerated(XmlElement element,
                                        IntrospectedTable introspectedTable)
This method is called when the selectAll element is generated.

Parameters:
element - the generated <select> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapSelectByPrimaryKeyElementGenerated

boolean sqlMapSelectByPrimaryKeyElementGenerated(XmlElement element,
                                                 IntrospectedTable introspectedTable)
This method is called when the selectByPrimaryKey element is generated.

Parameters:
element - the generated <select> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapSelectByExampleWithoutBLOBsElementGenerated

boolean sqlMapSelectByExampleWithoutBLOBsElementGenerated(XmlElement element,
                                                          IntrospectedTable introspectedTable)
This method is called when the selectByExample element is generated.

Parameters:
element - the generated <select> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapSelectByExampleWithBLOBsElementGenerated

boolean sqlMapSelectByExampleWithBLOBsElementGenerated(XmlElement element,
                                                       IntrospectedTable introspectedTable)
This method is called when the selectByExampleWithBLOBs element is generated.

Parameters:
element - the generated <select> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapUpdateByExampleSelectiveElementGenerated

boolean sqlMapUpdateByExampleSelectiveElementGenerated(XmlElement element,
                                                       IntrospectedTable introspectedTable)
This method is called when the updateByExampleSelective element is generated.

Parameters:
element - the generated <update> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapUpdateByExampleWithBLOBsElementGenerated

boolean sqlMapUpdateByExampleWithBLOBsElementGenerated(XmlElement element,
                                                       IntrospectedTable introspectedTable)
This method is called when the updateByExampleWithBLOBs element is generated.

Parameters:
element - the generated <update> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapUpdateByExampleWithoutBLOBsElementGenerated

boolean sqlMapUpdateByExampleWithoutBLOBsElementGenerated(XmlElement element,
                                                          IntrospectedTable introspectedTable)
This method is called when the updateByExampleWithourBLOBs element is generated.

Parameters:
element - the generated <update> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapUpdateByPrimaryKeySelectiveElementGenerated

boolean sqlMapUpdateByPrimaryKeySelectiveElementGenerated(XmlElement element,
                                                          IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeySelective element is generated.

Parameters:
element - the generated <update> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapUpdateByPrimaryKeyWithBLOBsElementGenerated

boolean sqlMapUpdateByPrimaryKeyWithBLOBsElementGenerated(XmlElement element,
                                                          IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeyWithBLOBs element is generated.

Parameters:
element - the generated <update> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated

boolean sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated(XmlElement element,
                                                             IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeyWithoutBLOBs element is generated.

Parameters:
element - the generated <update> element
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the element should be generated, false if the generated element should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

providerGenerated

boolean providerGenerated(TopLevelClass topLevelClass,
                          IntrospectedTable introspectedTable)
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.

Parameters:
topLevelClass - the generated provider
introspectedTable - The class containing information about the table as introspected from the database
Returns:
true if the provider should be generated, false if the generated provider should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

providerApplyWhereMethodGenerated

boolean providerApplyWhereMethodGenerated(Method method,
                                          TopLevelClass topLevelClass,
                                          IntrospectedTable introspectedTable)
This method is called when the applyWhere method has been generated in the SQL provider.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

providerCountByExampleMethodGenerated

boolean providerCountByExampleMethodGenerated(Method method,
                                              TopLevelClass topLevelClass,
                                              IntrospectedTable introspectedTable)
This method is called when the countByExample method has been generated in the SQL provider.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

providerDeleteByExampleMethodGenerated

boolean providerDeleteByExampleMethodGenerated(Method method,
                                               TopLevelClass topLevelClass,
                                               IntrospectedTable introspectedTable)
This method is called when the deleteByExample method has been generated in the SQL provider.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

providerInsertSelectiveMethodGenerated

boolean providerInsertSelectiveMethodGenerated(Method method,
                                               TopLevelClass topLevelClass,
                                               IntrospectedTable introspectedTable)
This method is called when the insertSelective method has been generated in the SQL provider.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

providerSelectByExampleWithBLOBsMethodGenerated

boolean providerSelectByExampleWithBLOBsMethodGenerated(Method method,
                                                        TopLevelClass topLevelClass,
                                                        IntrospectedTable introspectedTable)
This method is called when the selectByExampleWithBLOBs method has been generated in the SQL provider.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

providerSelectByExampleWithoutBLOBsMethodGenerated

boolean providerSelectByExampleWithoutBLOBsMethodGenerated(Method method,
                                                           TopLevelClass topLevelClass,
                                                           IntrospectedTable introspectedTable)
This method is called when the selectByExampleWithoutBLOBs method has been generated in the SQL provider.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

providerUpdateByExampleSelectiveMethodGenerated

boolean providerUpdateByExampleSelectiveMethodGenerated(Method method,
                                                        TopLevelClass topLevelClass,
                                                        IntrospectedTable introspectedTable)
This method is called when the updateByExampleSelective method has been generated in the SQL provider.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

providerUpdateByExampleWithBLOBsMethodGenerated

boolean providerUpdateByExampleWithBLOBsMethodGenerated(Method method,
                                                        TopLevelClass topLevelClass,
                                                        IntrospectedTable introspectedTable)
This method is called when the updateByExampleWithBLOBs method has been generated in the SQL provider.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

providerUpdateByExampleWithoutBLOBsMethodGenerated

boolean providerUpdateByExampleWithoutBLOBsMethodGenerated(Method method,
                                                           TopLevelClass topLevelClass,
                                                           IntrospectedTable introspectedTable)
This method is called when the updateByExampleWithoutBLOBs method has been generated in the SQL provider.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

providerUpdateByPrimaryKeySelectiveMethodGenerated

boolean providerUpdateByPrimaryKeySelectiveMethodGenerated(Method method,
                                                           TopLevelClass topLevelClass,
                                                           IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeySelective method has been generated in the SQL provider.

Parameters:
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
Returns:
true if the method should be generated, false if the generated method should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.


Copyright © 2010-2012 MyBatis.org. All Rights Reserved.