org.mybatis.generator.internal
Class PluginAggregator

java.lang.Object
  extended by org.mybatis.generator.internal.PluginAggregator
All Implemented Interfaces:
Plugin

public final class PluginAggregator
extends Object
implements Plugin

This class is for internal use only. It contains a list of plugins for the current context and is used to aggregate plugins together. This class implements the rule that if any plugin returns "false" from a method, then no other plugin is called.

This class does not follow the normal plugin lifecycle and should not be subclassed by clients.

Author:
Jeff Butler

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.mybatis.generator.api.Plugin
Plugin.ModelClassType
 
Constructor Summary
PluginAggregator()
           
 
Method Summary
 void addPlugin(Plugin plugin)
           
 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 tlc, IntrospectedTable introspectedTable)
          This method is called after the base record class is generated by the JavaModelGenerator.
 boolean modelExampleClassGenerated(TopLevelClass tlc, 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 tlc, IntrospectedTable introspectedTable)
          This method is called after the primary key class is generated by the JavaModelGenerator.
 boolean modelRecordWithBLOBsClassGenerated(TopLevelClass tlc, 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 table)
          This method is called when the countByExample element is generated.
 boolean sqlMapDeleteByExampleElementGenerated(XmlElement element, IntrospectedTable table)
          This method is called when the deleteByExample element is generated.
 boolean sqlMapDeleteByPrimaryKeyElementGenerated(XmlElement element, IntrospectedTable table)
          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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PluginAggregator

public PluginAggregator()
Method Detail

addPlugin

public void addPlugin(Plugin plugin)

setContext

public void setContext(Context context)
Description copied from interface: Plugin
Set the context under which this plugin is running

Specified by:
setContext in interface Plugin

setProperties

public void setProperties(Properties properties)
Description copied from interface: Plugin
Set properties from the plugin configuration

Specified by:
setProperties in interface Plugin

validate

public boolean validate(List<String> warnings)
Description copied from interface: Plugin
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.

Specified by:
validate in interface Plugin
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

modelBaseRecordClassGenerated

public boolean modelBaseRecordClassGenerated(TopLevelClass tlc,
                                             IntrospectedTable introspectedTable)
Description copied from interface: Plugin
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.

Specified by:
modelBaseRecordClassGenerated in interface Plugin
Parameters:
tlc - 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

public boolean modelRecordWithBLOBsClassGenerated(TopLevelClass tlc,
                                                  IntrospectedTable introspectedTable)
Description copied from interface: Plugin
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.

Specified by:
modelRecordWithBLOBsClassGenerated in interface Plugin
Parameters:
tlc - 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.

sqlMapCountByExampleElementGenerated

public boolean sqlMapCountByExampleElementGenerated(XmlElement element,
                                                    IntrospectedTable table)
Description copied from interface: Plugin
This method is called when the countByExample element is generated.

Specified by:
sqlMapCountByExampleElementGenerated in interface Plugin
Parameters:
element - the generated <select> element
table - 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

public boolean sqlMapDeleteByExampleElementGenerated(XmlElement element,
                                                     IntrospectedTable table)
Description copied from interface: Plugin
This method is called when the deleteByExample element is generated.

Specified by:
sqlMapDeleteByExampleElementGenerated in interface Plugin
Parameters:
element - the generated <delete> element
table - 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

public boolean sqlMapDeleteByPrimaryKeyElementGenerated(XmlElement element,
                                                        IntrospectedTable table)
Description copied from interface: Plugin
This method is called when the deleteByPrimaryKey element is generated.

Specified by:
sqlMapDeleteByPrimaryKeyElementGenerated in interface Plugin
Parameters:
element - the generated <delete> element
table - 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.

modelExampleClassGenerated

public boolean modelExampleClassGenerated(TopLevelClass tlc,
                                          IntrospectedTable introspectedTable)
Description copied from interface: Plugin
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.

Specified by:
modelExampleClassGenerated in interface Plugin
Parameters:
tlc - 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.

contextGenerateAdditionalJavaFiles

public List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles(IntrospectedTable introspectedTable)
Description copied from interface: Plugin
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.

Specified by:
contextGenerateAdditionalJavaFiles in interface Plugin
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

public List<GeneratedXmlFile> contextGenerateAdditionalXmlFiles(IntrospectedTable introspectedTable)
Description copied from interface: Plugin
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.

Specified by:
contextGenerateAdditionalXmlFiles in interface Plugin
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.

modelPrimaryKeyClassGenerated

public boolean modelPrimaryKeyClassGenerated(TopLevelClass tlc,
                                             IntrospectedTable introspectedTable)
Description copied from interface: Plugin
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.

Specified by:
modelPrimaryKeyClassGenerated in interface Plugin
Parameters:
tlc - 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.

sqlMapResultMapWithoutBLOBsElementGenerated

public boolean sqlMapResultMapWithoutBLOBsElementGenerated(XmlElement element,
                                                           IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the base resultMap is generated.

Specified by:
sqlMapResultMapWithoutBLOBsElementGenerated in interface Plugin
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.

sqlMapExampleWhereClauseElementGenerated

public boolean sqlMapExampleWhereClauseElementGenerated(XmlElement element,
                                                        IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the exampleWhereClause element is generated.

Specified by:
sqlMapExampleWhereClauseElementGenerated in interface Plugin
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

public boolean sqlMapInsertElementGenerated(XmlElement element,
                                            IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the insert element is generated.

Specified by:
sqlMapInsertElementGenerated in interface Plugin
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

public boolean sqlMapResultMapWithBLOBsElementGenerated(XmlElement element,
                                                        IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the resultMap with BLOBs element is generated - this resultMap will extend the base resultMap.

Specified by:
sqlMapResultMapWithBLOBsElementGenerated in interface Plugin
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.

sqlMapSelectByExampleWithoutBLOBsElementGenerated

public boolean sqlMapSelectByExampleWithoutBLOBsElementGenerated(XmlElement element,
                                                                 IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the selectByExample element is generated.

Specified by:
sqlMapSelectByExampleWithoutBLOBsElementGenerated in interface Plugin
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

public boolean sqlMapSelectByExampleWithBLOBsElementGenerated(XmlElement element,
                                                              IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the selectByExampleWithBLOBs element is generated.

Specified by:
sqlMapSelectByExampleWithBLOBsElementGenerated in interface Plugin
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

public boolean sqlMapSelectByPrimaryKeyElementGenerated(XmlElement element,
                                                        IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the selectByPrimaryKey element is generated.

Specified by:
sqlMapSelectByPrimaryKeyElementGenerated in interface Plugin
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.

sqlMapGenerated

public boolean sqlMapGenerated(GeneratedXmlFile sqlMap,
                               IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the SqlMap file has been generated.

Specified by:
sqlMapGenerated in interface Plugin
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.

sqlMapUpdateByExampleSelectiveElementGenerated

public boolean sqlMapUpdateByExampleSelectiveElementGenerated(XmlElement element,
                                                              IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the updateByExampleSelective element is generated.

Specified by:
sqlMapUpdateByExampleSelectiveElementGenerated in interface Plugin
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

public boolean sqlMapUpdateByExampleWithBLOBsElementGenerated(XmlElement element,
                                                              IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the updateByExampleWithBLOBs element is generated.

Specified by:
sqlMapUpdateByExampleWithBLOBsElementGenerated in interface Plugin
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

public boolean sqlMapUpdateByExampleWithoutBLOBsElementGenerated(XmlElement element,
                                                                 IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the updateByExampleWithourBLOBs element is generated.

Specified by:
sqlMapUpdateByExampleWithoutBLOBsElementGenerated in interface Plugin
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

public boolean sqlMapUpdateByPrimaryKeySelectiveElementGenerated(XmlElement element,
                                                                 IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the updateByPrimaryKeySelective element is generated.

Specified by:
sqlMapUpdateByPrimaryKeySelectiveElementGenerated in interface Plugin
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

public boolean sqlMapUpdateByPrimaryKeyWithBLOBsElementGenerated(XmlElement element,
                                                                 IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the updateByPrimaryKeyWithBLOBs element is generated.

Specified by:
sqlMapUpdateByPrimaryKeyWithBLOBsElementGenerated in interface Plugin
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

public boolean sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated(XmlElement element,
                                                                    IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the updateByPrimaryKeyWithoutBLOBs element is generated.

Specified by:
sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated in interface Plugin
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.

clientCountByExampleMethodGenerated

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

Specified by:
clientCountByExampleMethodGenerated in interface Plugin
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.

clientCountByExampleMethodGenerated

public boolean clientCountByExampleMethodGenerated(Method method,
                                                   TopLevelClass topLevelClass,
                                                   IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the countByExample method has been generated in the client implementation class.

Specified by:
clientCountByExampleMethodGenerated in interface Plugin
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

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

Specified by:
clientDeleteByExampleMethodGenerated in interface Plugin
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.

clientDeleteByExampleMethodGenerated

public boolean clientDeleteByExampleMethodGenerated(Method method,
                                                    TopLevelClass topLevelClass,
                                                    IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the deleteByExample method has been generated in the client implementation class.

Specified by:
clientDeleteByExampleMethodGenerated in interface Plugin
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

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

Specified by:
clientDeleteByPrimaryKeyMethodGenerated in interface Plugin
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.

clientDeleteByPrimaryKeyMethodGenerated

public boolean clientDeleteByPrimaryKeyMethodGenerated(Method method,
                                                       TopLevelClass topLevelClass,
                                                       IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the deleteByPrimaryKey method has been generated in the client implementation class.

Specified by:
clientDeleteByPrimaryKeyMethodGenerated in interface Plugin
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

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

Specified by:
clientInsertMethodGenerated in interface Plugin
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.

clientInsertMethodGenerated

public boolean clientInsertMethodGenerated(Method method,
                                           TopLevelClass topLevelClass,
                                           IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the insert method has been generated in the client implementation class.

Specified by:
clientInsertMethodGenerated in interface Plugin
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.

clientGenerated

public boolean clientGenerated(Interface interfaze,
                               TopLevelClass topLevelClass,
                               IntrospectedTable introspectedTable)
Description copied from interface: Plugin
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.

Specified by:
clientGenerated in interface Plugin
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.

clientSelectAllMethodGenerated

public boolean clientSelectAllMethodGenerated(Method method,
                                              TopLevelClass topLevelClass,
                                              IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the selectAll method has been generated in the client implementation class.

Specified by:
clientSelectAllMethodGenerated in interface Plugin
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.

clientSelectAllMethodGenerated

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

Specified by:
clientSelectAllMethodGenerated in interface Plugin
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.

clientSelectByExampleWithBLOBsMethodGenerated

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

Specified by:
clientSelectByExampleWithBLOBsMethodGenerated in interface Plugin
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.

clientSelectByExampleWithBLOBsMethodGenerated

public boolean clientSelectByExampleWithBLOBsMethodGenerated(Method method,
                                                             TopLevelClass topLevelClass,
                                                             IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the selectByExampleWithBLOBs method has been generated in the client implementation class.

Specified by:
clientSelectByExampleWithBLOBsMethodGenerated in interface Plugin
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

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

Specified by:
clientSelectByExampleWithoutBLOBsMethodGenerated in interface Plugin
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.

clientSelectByExampleWithoutBLOBsMethodGenerated

public boolean clientSelectByExampleWithoutBLOBsMethodGenerated(Method method,
                                                                TopLevelClass topLevelClass,
                                                                IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the selectByExampleWithoutBLOBs method has been generated in the client implementation class.

Specified by:
clientSelectByExampleWithoutBLOBsMethodGenerated in interface Plugin
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

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

Specified by:
clientSelectByPrimaryKeyMethodGenerated in interface Plugin
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.

clientSelectByPrimaryKeyMethodGenerated

public boolean clientSelectByPrimaryKeyMethodGenerated(Method method,
                                                       TopLevelClass topLevelClass,
                                                       IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the selectByPrimaryKey method has been generated in the client implementation class.

Specified by:
clientSelectByPrimaryKeyMethodGenerated in interface Plugin
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

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

Specified by:
clientUpdateByExampleSelectiveMethodGenerated in interface Plugin
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.

clientUpdateByExampleSelectiveMethodGenerated

public boolean clientUpdateByExampleSelectiveMethodGenerated(Method method,
                                                             TopLevelClass topLevelClass,
                                                             IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the updateByExampleSelective method has been generated in the client implementation class.

Specified by:
clientUpdateByExampleSelectiveMethodGenerated in interface Plugin
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

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

Specified by:
clientUpdateByExampleWithBLOBsMethodGenerated in interface Plugin
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.

clientUpdateByExampleWithBLOBsMethodGenerated

public boolean clientUpdateByExampleWithBLOBsMethodGenerated(Method method,
                                                             TopLevelClass topLevelClass,
                                                             IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the updateByExampleWithBLOBs method has been generated in the client implementation class.

Specified by:
clientUpdateByExampleWithBLOBsMethodGenerated in interface Plugin
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

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

Specified by:
clientUpdateByExampleWithoutBLOBsMethodGenerated in interface Plugin
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.

clientUpdateByExampleWithoutBLOBsMethodGenerated

public boolean clientUpdateByExampleWithoutBLOBsMethodGenerated(Method method,
                                                                TopLevelClass topLevelClass,
                                                                IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the updateByExampleWithoutBLOBs method has been generated in the client implementation class.

Specified by:
clientUpdateByExampleWithoutBLOBsMethodGenerated in interface Plugin
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

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

Specified by:
clientUpdateByPrimaryKeySelectiveMethodGenerated in interface Plugin
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.

clientUpdateByPrimaryKeySelectiveMethodGenerated

public boolean clientUpdateByPrimaryKeySelectiveMethodGenerated(Method method,
                                                                TopLevelClass topLevelClass,
                                                                IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the updateByPrimaryKeySelective method has been generated in the client implementation class.

Specified by:
clientUpdateByPrimaryKeySelectiveMethodGenerated in interface Plugin
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

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

Specified by:
clientUpdateByPrimaryKeyWithBLOBsMethodGenerated in interface Plugin
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.

clientUpdateByPrimaryKeyWithBLOBsMethodGenerated

public boolean clientUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method,
                                                                TopLevelClass topLevelClass,
                                                                IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the updateByPrimaryKeyWithBLOBs method has been generated in the client implementation class.

Specified by:
clientUpdateByPrimaryKeyWithBLOBsMethodGenerated in interface Plugin
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

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

Specified by:
clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated in interface Plugin
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.

clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated

public boolean clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(Method method,
                                                                   TopLevelClass topLevelClass,
                                                                   IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the updateByPrimaryKeyWithoutBLOBs method has been generated in the client implementation class.

Specified by:
clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated in interface Plugin
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.

contextGenerateAdditionalJavaFiles

public List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles()
Description copied from interface: Plugin
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.

Specified by:
contextGenerateAdditionalJavaFiles in interface Plugin
Returns:
a List of GeneratedJavaFiles - these files will be saved with the other files from this run.

contextGenerateAdditionalXmlFiles

public List<GeneratedXmlFile> contextGenerateAdditionalXmlFiles()
Description copied from interface: Plugin
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.

Specified by:
contextGenerateAdditionalXmlFiles in interface Plugin
Returns:
a List of GeneratedXmlFiles - these files will be saved with the other files from this run.

sqlMapDocumentGenerated

public boolean sqlMapDocumentGenerated(Document document,
                                       IntrospectedTable introspectedTable)
Description copied from interface: Plugin
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.

Specified by:
sqlMapDocumentGenerated in interface Plugin
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.

modelFieldGenerated

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

Specified by:
modelFieldGenerated in interface Plugin
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

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

Specified by:
modelGetterMethodGenerated in interface Plugin
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

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

Specified by:
modelSetterMethodGenerated in interface Plugin
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.

sqlMapInsertSelectiveElementGenerated

public boolean sqlMapInsertSelectiveElementGenerated(XmlElement element,
                                                     IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the insert selective element is generated.

Specified by:
sqlMapInsertSelectiveElementGenerated in interface Plugin
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.

clientInsertSelectiveMethodGenerated

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

Specified by:
clientInsertSelectiveMethodGenerated in interface Plugin
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

public boolean clientInsertSelectiveMethodGenerated(Method method,
                                                    TopLevelClass topLevelClass,
                                                    IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the insert selective method has been generated in the client implementation class.

Specified by:
clientInsertSelectiveMethodGenerated in interface Plugin
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.

initialized

public void initialized(IntrospectedTable introspectedTable)
Description copied from interface: Plugin
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.

Specified by:
initialized in interface Plugin

sqlMapBaseColumnListElementGenerated

public boolean sqlMapBaseColumnListElementGenerated(XmlElement element,
                                                    IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the baseColumnList element is generated.

Specified by:
sqlMapBaseColumnListElementGenerated in interface Plugin
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

public boolean sqlMapBlobColumnListElementGenerated(XmlElement element,
                                                    IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the blobColumnList element is generated.

Specified by:
sqlMapBlobColumnListElementGenerated in interface Plugin
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.

providerGenerated

public boolean providerGenerated(TopLevelClass topLevelClass,
                                 IntrospectedTable introspectedTable)
Description copied from interface: Plugin
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.

Specified by:
providerGenerated in interface Plugin
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

public boolean providerApplyWhereMethodGenerated(Method method,
                                                 TopLevelClass topLevelClass,
                                                 IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the applyWhere method has been generated in the SQL provider.

Specified by:
providerApplyWhereMethodGenerated in interface Plugin
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

public boolean providerCountByExampleMethodGenerated(Method method,
                                                     TopLevelClass topLevelClass,
                                                     IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the countByExample method has been generated in the SQL provider.

Specified by:
providerCountByExampleMethodGenerated in interface Plugin
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

public boolean providerDeleteByExampleMethodGenerated(Method method,
                                                      TopLevelClass topLevelClass,
                                                      IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the deleteByExample method has been generated in the SQL provider.

Specified by:
providerDeleteByExampleMethodGenerated in interface Plugin
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

public boolean providerInsertSelectiveMethodGenerated(Method method,
                                                      TopLevelClass topLevelClass,
                                                      IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the insertSelective method has been generated in the SQL provider.

Specified by:
providerInsertSelectiveMethodGenerated in interface Plugin
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

public boolean providerSelectByExampleWithBLOBsMethodGenerated(Method method,
                                                               TopLevelClass topLevelClass,
                                                               IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the selectByExampleWithBLOBs method has been generated in the SQL provider.

Specified by:
providerSelectByExampleWithBLOBsMethodGenerated in interface Plugin
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

public boolean providerSelectByExampleWithoutBLOBsMethodGenerated(Method method,
                                                                  TopLevelClass topLevelClass,
                                                                  IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the selectByExampleWithoutBLOBs method has been generated in the SQL provider.

Specified by:
providerSelectByExampleWithoutBLOBsMethodGenerated in interface Plugin
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

public boolean providerUpdateByExampleSelectiveMethodGenerated(Method method,
                                                               TopLevelClass topLevelClass,
                                                               IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the updateByExampleSelective method has been generated in the SQL provider.

Specified by:
providerUpdateByExampleSelectiveMethodGenerated in interface Plugin
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

public boolean providerUpdateByExampleWithBLOBsMethodGenerated(Method method,
                                                               TopLevelClass topLevelClass,
                                                               IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the updateByExampleWithBLOBs method has been generated in the SQL provider.

Specified by:
providerUpdateByExampleWithBLOBsMethodGenerated in interface Plugin
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

public boolean providerUpdateByExampleWithoutBLOBsMethodGenerated(Method method,
                                                                  TopLevelClass topLevelClass,
                                                                  IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the updateByExampleWithoutBLOBs method has been generated in the SQL provider.

Specified by:
providerUpdateByExampleWithoutBLOBsMethodGenerated in interface Plugin
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

public boolean providerUpdateByPrimaryKeySelectiveMethodGenerated(Method method,
                                                                  TopLevelClass topLevelClass,
                                                                  IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the updateByPrimaryKeySelective method has been generated in the SQL provider.

Specified by:
providerUpdateByPrimaryKeySelectiveMethodGenerated in interface Plugin
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.

sqlMapSelectAllElementGenerated

public boolean sqlMapSelectAllElementGenerated(XmlElement element,
                                               IntrospectedTable introspectedTable)
Description copied from interface: Plugin
This method is called when the selectAll element is generated.

Specified by:
sqlMapSelectAllElementGenerated in interface Plugin
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.


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