org.apache.ibatis.ibator.api
Class IbatorPluginAdapter

java.lang.Object
  org.apache.ibatis.ibator.api.IbatorPluginAdapter

All Implemented Interfaces:

IbatorPlugin

Direct Known Subclasses:

EqualsHashCodePlugin, RenameExampleClassPlugin, SerializablePlugin, SqlMapConfigPlugin

public abstract class IbatorPluginAdapter
extends java.lang.Object
implements IbatorPlugin

This class includes no-operation methods for almost every method in the IbatorPlugin interface. Clients may extend this class to implement some or all of the methods in a plugin.

This adapter does not implement the validate method - all plugins must perform validation.

Author:

Jeff Butler

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ibatis.ibator.api.IbatorPlugin

IbatorPlugin.ModelClassType

Field Summary

protected IbatorContext	ibatorContext
protected java.util.Properties	properties

Constructor Summary

IbatorPluginAdapter()

Method Summary

java.util.List<GeneratedJavaFile>	contextGenerateAdditionalJavaFiles() This method can be used to generate any additional Java file needed by your implementation.
java.util.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.
java.util.List<GeneratedXmlFile>	contextGenerateAdditionalXmlFiles() This method can be used to generate any additional XML file needed by your implementation.
java.util.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.
boolean	daoCountByExampleMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the countByExample method has been generated in the DAO interface class.
boolean	daoCountByExampleMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the countByExample method has been generated in the DAO implementation class.
boolean	daoDeleteByExampleMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the deleteByExample method has been generated in the DAO interface class.
boolean	daoDeleteByExampleMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the deleteByExample method has been generated in the DAO implementation class.
boolean	daoDeleteByPrimaryKeyMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the deleteByPrimaryKey method has been generated in the DAO interface class.
boolean	daoDeleteByPrimaryKeyMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the deleteByPrimaryKey method has been generated in the DAO implementation class.
boolean	daoImplementationGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the entire DAO implementation has been generated.
boolean	daoInsertMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the insert method has been generated in the DAO interface class.
boolean	daoInsertMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the insert method has been generated in the DAO implementation class.
boolean	daoInsertSelectiveMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the insert selective method has been generated in the DAO interface class.
boolean	daoInsertSelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the insert selective method has been generated in the DAO implementation class.
boolean	daoInterfaceGenerated(Interface interfaze, IntrospectedTable introspectedTable) This method is called when the entire DAO interface has been generated.
boolean	daoSelectByExampleWithBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the selectByExampleWithBLOBs method has been generated in the DAO interface class.
boolean	daoSelectByExampleWithBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the selectByExampleWithBLOBs method has been generated in the DAO implementation class.
boolean	daoSelectByExampleWithoutBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the selectByExampleWithoutBLOBs method has been generated in the DAO interface class.
boolean	daoSelectByExampleWithoutBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the selectByExampleWithoutBLOBs method has been generated in the DAO implementation class.
boolean	daoSelectByPrimaryKeyMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the selectByPrimaryKey method has been generated in the DAO interface class.
boolean	daoSelectByPrimaryKeyMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the selectByPrimaryKey method has been generated in the DAO implementation class.
boolean	daoUpdateByExampleSelectiveMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the updateByExampleSelective method has been generated in the DAO interface class.
boolean	daoUpdateByExampleSelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the updateByExampleSelective method has been generated in the DAO implementation class.
boolean	daoUpdateByExampleWithBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the updateByExampleWithBLOBs method has been generated in the DAO interface class.
boolean	daoUpdateByExampleWithBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the updateByExampleWithBLOBs method has been generated in the DAO implementation class.
boolean	daoUpdateByExampleWithoutBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the updateByExampleWithoutBLOBs method has been generated in the DAO interface class.
boolean	daoUpdateByExampleWithoutBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the updateByExampleWithoutBLOBs method has been generated in the DAO implementation class.
boolean	daoUpdateByPrimaryKeySelectiveMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the updateByPrimaryKeySelective method has been generated in the DAO interface class.
boolean	daoUpdateByPrimaryKeySelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the updateByPrimaryKeySelective method has been generated in the DAO implementation class.
boolean	daoUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the updateByPrimaryKeyWithBLOBs method has been generated in the DAO interface class.
boolean	daoUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the updateByPrimaryKeyWithBLOBs method has been generated in the DAO implementation class.
boolean	daoUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the updateByPrimaryKeyWithoutBLOBs method has been generated in the DAO interface class.
boolean	daoUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the updateByPrimaryKeyWithoutBLOBs method has been generated in the DAO implementation class.
IbatorContext	getIbatorContext()
java.util.Properties	getProperties()
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 ibator supplied JavaModelGenerator.
boolean	modelExampleClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called after the example class is generated by the ibator supplied JavaModelGenerator.
boolean	modelFieldGenerated(Field field, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, IbatorPlugin.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, IbatorPlugin.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 ibator supplied JavaModelGenerator.
boolean	modelRecordWithBLOBsClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called after the record with BLOBs class is generated by the ibator supplied JavaModelGenerator.
boolean	modelSetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, IbatorPlugin.ModelClassType modelClassType) This method is called after the setter, or mutator, method is generated for a specific column in a table.
void	setIbatorContext(IbatorContext ibatorContext) Set the context under which this plugin is running
void	setProperties(java.util.Properties properties) Set properties from the plugin configuration
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	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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.ibatis.ibator.api.IbatorPlugin

validate

Field Detail

ibatorContext

protected IbatorContext ibatorContext

properties

protected java.util.Properties properties

Constructor Detail

IbatorPluginAdapter

public IbatorPluginAdapter()

Method Detail

getIbatorContext

public IbatorContext getIbatorContext()

setIbatorContext

public void setIbatorContext(IbatorContext ibatorContext)

Description copied from interface: IbatorPlugin

Set the context under which this plugin is running

Specified by:

setIbatorContext in interface IbatorPlugin

getProperties

public java.util.Properties getProperties()

setProperties

public void setProperties(java.util.Properties properties)

Description copied from interface: IbatorPlugin

Set properties from the plugin configuration

Specified by:

setProperties in interface IbatorPlugin

contextGenerateAdditionalJavaFiles

public java.util.List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles()

Description copied from interface: IbatorPlugin

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 IbatorPlugin

Returns:

a List of GeneratedJavaFiles - ibator will persist these files with the other files from this run of ibator.

contextGenerateAdditionalJavaFiles

public java.util.List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles(IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

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 IbatorPlugin

Parameters:

introspectedTable - ibator's class containing information about the table as introspected from the database

Returns:

a List of GeneratedJavaFiles - ibator will persist these files with the other files from this run of ibator.

contextGenerateAdditionalXmlFiles

public java.util.List<GeneratedXmlFile> contextGenerateAdditionalXmlFiles()

Description copied from interface: IbatorPlugin

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 IbatorPlugin

Returns:

a List of GeneratedXmlFiles - ibator will persist these files with the other files from this run of ibator.

contextGenerateAdditionalXmlFiles

public java.util.List<GeneratedXmlFile> contextGenerateAdditionalXmlFiles(IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

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 IbatorPlugin

Parameters:

introspectedTable - ibator's class containing information about the table as introspected from the database

Returns:

a List of GeneratedXmlFiles - ibator will persist these files with the other files from this run of ibator.

daoCountByExampleMethodGenerated

public boolean daoCountByExampleMethodGenerated(Method method,
                                                Interface interfaze,
                                                IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the countByExample method has been generated in the DAO interface class.

Specified by:

daoCountByExampleMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated countByExample method

interfaze - the partially implemented DAO interface class. You can add additional imported classes to the interface class if necessary.

introspectedTable - ibator's 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.

daoCountByExampleMethodGenerated

public boolean daoCountByExampleMethodGenerated(Method method,
                                                TopLevelClass topLevelClass,
                                                IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the countByExample method has been generated in the DAO implementation class.

Specified by:

daoCountByExampleMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated countByExample method

topLevelClass - the partially implemented DAO implementation class. You can add additional imported classes to the implementation class if necessary.

introspectedTable - ibator's 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.

daoDeleteByExampleMethodGenerated

public boolean daoDeleteByExampleMethodGenerated(Method method,
                                                 Interface interfaze,
                                                 IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the deleteByExample method has been generated in the DAO interface class.

Specified by:

daoDeleteByExampleMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated deleteByExample method

interfaze - the partially implemented DAO interface class. You can add additional imported classes to the interface class if necessary.

introspectedTable - ibator's 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.

daoDeleteByExampleMethodGenerated

public boolean daoDeleteByExampleMethodGenerated(Method method,
                                                 TopLevelClass topLevelClass,
                                                 IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the deleteByExample method has been generated in the DAO implementation class.

Specified by:

daoDeleteByExampleMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated deleteByExample method

topLevelClass - the partially implemented DAO implementation class. You can add additional imported classes to the implementation class if necessary.

introspectedTable - ibator's 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.

daoDeleteByPrimaryKeyMethodGenerated

public boolean daoDeleteByPrimaryKeyMethodGenerated(Method method,
                                                    Interface interfaze,
                                                    IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the deleteByPrimaryKey method has been generated in the DAO interface class.

Specified by:

daoDeleteByPrimaryKeyMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated deleteByPrimaryKey method

interfaze - the partially implemented DAO interface class. You can add additional imported classes to the interface class if necessary.

introspectedTable - ibator's 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.

daoDeleteByPrimaryKeyMethodGenerated

public boolean daoDeleteByPrimaryKeyMethodGenerated(Method method,
                                                    TopLevelClass topLevelClass,
                                                    IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the deleteByPrimaryKey method has been generated in the DAO implementation class.

Specified by:

daoDeleteByPrimaryKeyMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated deleteByPrimaryKey method

topLevelClass - the partially implemented DAO implementation class. You can add additional imported classes to the implementation class if necessary.

introspectedTable - ibator's 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.

daoImplementationGenerated

public boolean daoImplementationGenerated(TopLevelClass topLevelClass,
                                          IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the entire DAO implementation has been generated. Implement this method to add additional methods or fields to a generated DAO implementation.

Specified by:

daoImplementationGenerated in interface IbatorPlugin

Parameters:

topLevelClass - the generated implementation class

introspectedTable - ibator's class containing information about the table as introspected from the database

Returns:

true if the implementation class should be generated, false if the generated implementation class should be ignored. In the case of multiple plugins, the first plugin returning false will disable the calling of further plugins.

daoInsertMethodGenerated

public boolean daoInsertMethodGenerated(Method method,
                                        Interface interfaze,
                                        IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the insert method has been generated in the DAO interface class.

Specified by:

daoInsertMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated insert method

interfaze - the partially implemented DAO interface class. You can add additional imported classes to the interface class if necessary.

introspectedTable - ibator's 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.

daoInsertMethodGenerated

public boolean daoInsertMethodGenerated(Method method,
                                        TopLevelClass topLevelClass,
                                        IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the insert method has been generated in the DAO implementation class.

Specified by:

daoInsertMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated insert method

topLevelClass - the partially implemented DAO implementation class. You can add additional imported classes to the implementation class if necessary.

introspectedTable - ibator's 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.

daoInterfaceGenerated

public boolean daoInterfaceGenerated(Interface interfaze,
                                     IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the entire DAO interface has been generated. Implement this method to add additional methods or fields to a generated DAO interface.

Specified by:

daoInterfaceGenerated in interface IbatorPlugin

Parameters:

interfaze - the generated interface

introspectedTable - ibator's 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.

daoSelectByExampleWithBLOBsMethodGenerated

public boolean daoSelectByExampleWithBLOBsMethodGenerated(Method method,
                                                          Interface interfaze,
                                                          IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the selectByExampleWithBLOBs method has been generated in the DAO interface class.

Specified by:

daoSelectByExampleWithBLOBsMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated selectByExampleWithBLOBs method

interfaze - the partially implemented DAO interface class. You can add additional imported classes to the interface class if necessary.

introspectedTable - ibator's 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.

daoSelectByExampleWithBLOBsMethodGenerated

public boolean daoSelectByExampleWithBLOBsMethodGenerated(Method method,
                                                          TopLevelClass topLevelClass,
                                                          IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the selectByExampleWithBLOBs method has been generated in the DAO implementation class.

Specified by:

daoSelectByExampleWithBLOBsMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated selectByExampleWithBLOBs method

topLevelClass - the partially implemented DAO implementation class. You can add additional imported classes to the implementation class if necessary.

introspectedTable - ibator's 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.

daoSelectByExampleWithoutBLOBsMethodGenerated

public boolean daoSelectByExampleWithoutBLOBsMethodGenerated(Method method,
                                                             Interface interfaze,
                                                             IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the selectByExampleWithoutBLOBs method has been generated in the DAO interface class.

Specified by:

daoSelectByExampleWithoutBLOBsMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated selectByExampleWithoutBLOBs method

interfaze - the partially implemented DAO interface class. You can add additional imported classes to the interface class if necessary.

introspectedTable - ibator's 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.

daoSelectByExampleWithoutBLOBsMethodGenerated

public boolean daoSelectByExampleWithoutBLOBsMethodGenerated(Method method,
                                                             TopLevelClass topLevelClass,
                                                             IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the selectByExampleWithoutBLOBs method has been generated in the DAO implementation class.

Specified by:

daoSelectByExampleWithoutBLOBsMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated selectByExampleWithoutBLOBs method

topLevelClass - the partially implemented DAO implementation class. You can add additional imported classes to the implementation class if necessary.

introspectedTable - ibator's 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.

daoSelectByPrimaryKeyMethodGenerated

public boolean daoSelectByPrimaryKeyMethodGenerated(Method method,
                                                    Interface interfaze,
                                                    IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the selectByPrimaryKey method has been generated in the DAO interface class.

Specified by:

daoSelectByPrimaryKeyMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated selectByPrimaryKey method

interfaze - the partially implemented DAO interface class. You can add additional imported classes to the interface class if necessary.

introspectedTable - ibator's 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.

daoSelectByPrimaryKeyMethodGenerated

public boolean daoSelectByPrimaryKeyMethodGenerated(Method method,
                                                    TopLevelClass topLevelClass,
                                                    IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the selectByPrimaryKey method has been generated in the DAO implementation class.

Specified by:

daoSelectByPrimaryKeyMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated selectByPrimaryKey method

topLevelClass - the partially implemented DAO implementation class. You can add additional imported classes to the implementation class if necessary.

introspectedTable - ibator's 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.

daoUpdateByExampleSelectiveMethodGenerated

public boolean daoUpdateByExampleSelectiveMethodGenerated(Method method,
                                                          Interface interfaze,
                                                          IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the updateByExampleSelective method has been generated in the DAO interface class.

Specified by:

daoUpdateByExampleSelectiveMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated updateByExampleSelective method

interfaze - the partially implemented DAO interface class. You can add additional imported classes to the interface class if necessary.

introspectedTable - ibator's 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.

daoUpdateByExampleSelectiveMethodGenerated

public boolean daoUpdateByExampleSelectiveMethodGenerated(Method method,
                                                          TopLevelClass topLevelClass,
                                                          IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the updateByExampleSelective method has been generated in the DAO implementation class.

Specified by:

daoUpdateByExampleSelectiveMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated updateByExampleSelective method

topLevelClass - the partially implemented DAO implementation class. You can add additional imported classes to the implementation class if necessary.

introspectedTable - ibator's 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.

daoUpdateByExampleWithBLOBsMethodGenerated

public boolean daoUpdateByExampleWithBLOBsMethodGenerated(Method method,
                                                          Interface interfaze,
                                                          IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the updateByExampleWithBLOBs method has been generated in the DAO interface class.

Specified by:

daoUpdateByExampleWithBLOBsMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated updateByExampleWithBLOBs method

interfaze - the partially implemented DAO interface class. You can add additional imported classes to the interface class if necessary.

introspectedTable - ibator's 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.

daoUpdateByExampleWithBLOBsMethodGenerated

public boolean daoUpdateByExampleWithBLOBsMethodGenerated(Method method,
                                                          TopLevelClass topLevelClass,
                                                          IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the updateByExampleWithBLOBs method has been generated in the DAO implementation class.

Specified by:

daoUpdateByExampleWithBLOBsMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated updateByExampleWithBLOBs method

topLevelClass - the partially implemented DAO implementation class. You can add additional imported classes to the implementation class if necessary.

introspectedTable - ibator's 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.

daoUpdateByExampleWithoutBLOBsMethodGenerated

public boolean daoUpdateByExampleWithoutBLOBsMethodGenerated(Method method,
                                                             Interface interfaze,
                                                             IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the updateByExampleWithoutBLOBs method has been generated in the DAO interface class.

Specified by:

daoUpdateByExampleWithoutBLOBsMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated updateByExampleWithoutBLOBs method

interfaze - the partially implemented DAO interface class. You can add additional imported classes to the interface class if necessary.

introspectedTable - ibator's 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.

daoUpdateByExampleWithoutBLOBsMethodGenerated

public boolean daoUpdateByExampleWithoutBLOBsMethodGenerated(Method method,
                                                             TopLevelClass topLevelClass,
                                                             IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the updateByExampleWithoutBLOBs method has been generated in the DAO implementation class.

Specified by:

daoUpdateByExampleWithoutBLOBsMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated updateByExampleWithoutBLOBs method

topLevelClass - the partially implemented DAO implementation class. You can add additional imported classes to the implementation class if necessary.

introspectedTable - ibator's 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.

daoUpdateByPrimaryKeySelectiveMethodGenerated

public boolean daoUpdateByPrimaryKeySelectiveMethodGenerated(Method method,
                                                             Interface interfaze,
                                                             IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the updateByPrimaryKeySelective method has been generated in the DAO interface class.

Specified by:

daoUpdateByPrimaryKeySelectiveMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated updateByPrimaryKeySelective method

interfaze - the partially implemented DAO interface class. You can add additional imported classes to the interface class if necessary.

introspectedTable - ibator's 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.

daoUpdateByPrimaryKeySelectiveMethodGenerated

public boolean daoUpdateByPrimaryKeySelectiveMethodGenerated(Method method,
                                                             TopLevelClass topLevelClass,
                                                             IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the updateByPrimaryKeySelective method has been generated in the DAO implementation class.

Specified by:

daoUpdateByPrimaryKeySelectiveMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated updateByPrimaryKeySelective method

topLevelClass - the partially implemented DAO implementation class. You can add additional imported classes to the implementation class if necessary.

introspectedTable - ibator's 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.

daoUpdateByPrimaryKeyWithBLOBsMethodGenerated

public boolean daoUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method,
                                                             Interface interfaze,
                                                             IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the updateByPrimaryKeyWithBLOBs method has been generated in the DAO interface class.

Specified by:

daoUpdateByPrimaryKeyWithBLOBsMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated updateByPrimaryKeyWithBLOBs method

interfaze - the partially implemented DAO interface class. You can add additional imported classes to the interface class if necessary.

introspectedTable - ibator's 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.

daoUpdateByPrimaryKeyWithBLOBsMethodGenerated

public boolean daoUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method,
                                                             TopLevelClass topLevelClass,
                                                             IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the updateByPrimaryKeyWithBLOBs method has been generated in the DAO implementation class.

Specified by:

daoUpdateByPrimaryKeyWithBLOBsMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated updateByPrimaryKeyWithBLOBs method

topLevelClass - the partially implemented DAO implementation class. You can add additional imported classes to the implementation class if necessary.

introspectedTable - ibator's 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.

daoUpdateByPrimaryKeyWithoutBLOBsMethodGenerated

public boolean daoUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(Method method,
                                                                Interface interfaze,
                                                                IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the updateByPrimaryKeyWithoutBLOBs method has been generated in the DAO interface class.

Specified by:

daoUpdateByPrimaryKeyWithoutBLOBsMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated updateByPrimaryKeyWithoutBLOBs method

interfaze - the partially implemented DAO interface class. You can add additional imported classes to the interface class if necessary.

introspectedTable - ibator's 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.

daoUpdateByPrimaryKeyWithoutBLOBsMethodGenerated

public boolean daoUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(Method method,
                                                                TopLevelClass topLevelClass,
                                                                IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the updateByPrimaryKeyWithoutBLOBs method has been generated in the DAO implementation class.

Specified by:

daoUpdateByPrimaryKeyWithoutBLOBsMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated updateByPrimaryKeyWithBLOBs method

topLevelClass - the partially implemented DAO implementation class. You can add additional imported classes to the implementation class if necessary.

introspectedTable - ibator's 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.

modelBaseRecordClassGenerated

public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass,
                                             IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called after the base record class is generated by the ibator supplied 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 ibator supplied Java model generators. Other user supplied generators may, or may not, call this method.

Specified by:

modelBaseRecordClassGenerated in interface IbatorPlugin

Parameters:

topLevelClass - the generated base record class

introspectedTable - ibator's 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

public boolean modelExampleClassGenerated(TopLevelClass topLevelClass,
                                          IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called after the example class is generated by the ibator supplied 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 ibator supplied Java model generators. Other user supplied generators may, or may not, call this method.

Specified by:

modelExampleClassGenerated in interface IbatorPlugin

Parameters:

topLevelClass - the generated example class

introspectedTable - ibator's 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.

modelFieldGenerated

public boolean modelFieldGenerated(Field field,
                                   TopLevelClass topLevelClass,
                                   IntrospectedColumn introspectedColumn,
                                   IntrospectedTable introspectedTable,
                                   IbatorPlugin.ModelClassType modelClassType)

Description copied from interface: IbatorPlugin

This method is called after the field is generated for a specific column in a table.

Specified by:

modelFieldGenerated in interface IbatorPlugin

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 - ibator's class containing information about the column related to this field as introspected from the database

introspectedTable - ibator's 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,
                                          IbatorPlugin.ModelClassType modelClassType)

Description copied from interface: IbatorPlugin

This method is called after the getter, or accessor, method is generated for a specific column in a table.

Specified by:

modelGetterMethodGenerated in interface IbatorPlugin

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 - ibator's class containing information about the column related to this field as introspected from the database

introspectedTable - ibator's 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

public boolean modelPrimaryKeyClassGenerated(TopLevelClass topLevelClass,
                                             IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called after the primary key class is generated by the ibator supplied 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 ibator supplied Java model generators. Other user supplied generators may, or may not, call this method.

Specified by:

modelPrimaryKeyClassGenerated in interface IbatorPlugin

Parameters:

topLevelClass - the generated primary key class

introspectedTable - ibator's 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 topLevelClass,
                                                  IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called after the record with BLOBs class is generated by the ibator supplied 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 ibator supplied Java model generators. Other user supplied generators may, or may not, call this method.

Specified by:

modelRecordWithBLOBsClassGenerated in interface IbatorPlugin

Parameters:

topLevelClass - the generated record with BLOBs class

introspectedTable - ibator's 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.

modelSetterMethodGenerated

public boolean modelSetterMethodGenerated(Method method,
                                          TopLevelClass topLevelClass,
                                          IntrospectedColumn introspectedColumn,
                                          IntrospectedTable introspectedTable,
                                          IbatorPlugin.ModelClassType modelClassType)

Description copied from interface: IbatorPlugin

This method is called after the setter, or mutator, method is generated for a specific column in a table.

Specified by:

modelSetterMethodGenerated in interface IbatorPlugin

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 - ibator's class containing information about the column related to this field as introspected from the database

introspectedTable - ibator's 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.

sqlMapResultMapWithoutBLOBsElementGenerated

public boolean sqlMapResultMapWithoutBLOBsElementGenerated(XmlElement element,
                                                           IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the base resultMap is generated.

Specified by:

sqlMapResultMapWithoutBLOBsElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <resultMap> element

introspectedTable - ibator's 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

public boolean sqlMapCountByExampleElementGenerated(XmlElement element,
                                                    IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the countByExample element is generated.

Specified by:

sqlMapCountByExampleElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <select> element

introspectedTable - ibator's 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 introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the deleteByExample element is generated.

Specified by:

sqlMapDeleteByExampleElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <delete> element

introspectedTable - ibator's 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 introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the deleteByPrimaryKey element is generated.

Specified by:

sqlMapDeleteByPrimaryKeyElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <delete> element

introspectedTable - ibator's 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.

sqlMapDocumentGenerated

public boolean sqlMapDocumentGenerated(Document document,
                                       IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

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 IbatorPlugin

Parameters:

document - the generated document (note that this is ibator's internal Document class - not the w3c XML Document class)

introspectedTable - ibator's 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.

sqlMapExampleWhereClauseElementGenerated

public boolean sqlMapExampleWhereClauseElementGenerated(XmlElement element,
                                                        IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the exampleWhereClause element is generated.

Specified by:

sqlMapExampleWhereClauseElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <sql> element

introspectedTable - ibator's 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: IbatorPlugin

This method is called when the SqlMap file has been generated.

Specified by:

sqlMapGenerated in interface IbatorPlugin

Parameters:

sqlMap - the generated file (containing the file name, package name, and project name)

introspectedTable - ibator's 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.

sqlMapInsertElementGenerated

public boolean sqlMapInsertElementGenerated(XmlElement element,
                                            IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the insert element is generated.

Specified by:

sqlMapInsertElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <insert> element

introspectedTable - ibator's 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: IbatorPlugin

This method is called when the resultMap with BLOBs element is generated - this resultMap will extend the base resultMap.

Specified by:

sqlMapResultMapWithBLOBsElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <resultMap> element

introspectedTable - ibator's 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: IbatorPlugin

This method is called when the selectByExample element is generated.

Specified by:

sqlMapSelectByExampleWithoutBLOBsElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <select> element

introspectedTable - ibator's 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: IbatorPlugin

This method is called when the selectByExampleWithBLOBs element is generated.

Specified by:

sqlMapSelectByExampleWithBLOBsElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <select> element

introspectedTable - ibator's 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: IbatorPlugin

This method is called when the selectByPrimaryKey element is generated.

Specified by:

sqlMapSelectByPrimaryKeyElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <select> element

introspectedTable - ibator's 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

public boolean sqlMapUpdateByExampleSelectiveElementGenerated(XmlElement element,
                                                              IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the updateByExampleSelective element is generated.

Specified by:

sqlMapUpdateByExampleSelectiveElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <update> element

introspectedTable - ibator's 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: IbatorPlugin

This method is called when the updateByExampleWithBLOBs element is generated.

Specified by:

sqlMapUpdateByExampleWithBLOBsElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <update> element

introspectedTable - ibator's 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: IbatorPlugin

This method is called when the updateByExampleWithourBLOBs element is generated.

Specified by:

sqlMapUpdateByExampleWithoutBLOBsElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <update> element

introspectedTable - ibator's 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: IbatorPlugin

This method is called when the updateByPrimaryKeySelective element is generated.

Specified by:

sqlMapUpdateByPrimaryKeySelectiveElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <update> element

introspectedTable - ibator's 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: IbatorPlugin

This method is called when the updateByPrimaryKeyWithBLOBs element is generated.

Specified by:

sqlMapUpdateByPrimaryKeyWithBLOBsElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <update> element

introspectedTable - ibator's 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: IbatorPlugin

This method is called when the updateByPrimaryKeyWithoutBLOBs element is generated.

Specified by:

sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <update> element

introspectedTable - ibator's 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

public boolean sqlMapInsertSelectiveElementGenerated(XmlElement element,
                                                     IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the insert selective element is generated.

Specified by:

sqlMapInsertSelectiveElementGenerated in interface IbatorPlugin

Parameters:

element - the generated <insert> element

introspectedTable - ibator's 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.

daoInsertSelectiveMethodGenerated

public boolean daoInsertSelectiveMethodGenerated(Method method,
                                                 Interface interfaze,
                                                 IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the insert selective method has been generated in the DAO interface class.

Specified by:

daoInsertSelectiveMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated insert method

interfaze - the partially implemented DAO interface class. You can add additional imported classes to the interface class if necessary.

introspectedTable - ibator's 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.

daoInsertSelectiveMethodGenerated

public boolean daoInsertSelectiveMethodGenerated(Method method,
                                                 TopLevelClass topLevelClass,
                                                 IntrospectedTable introspectedTable)

Description copied from interface: IbatorPlugin

This method is called when the insert selective method has been generated in the DAO implementation class.

Specified by:

daoInsertSelectiveMethodGenerated in interface IbatorPlugin

Parameters:

method - the generated insert method

topLevelClass - the partially implemented DAO implementation class. You can add additional imported classes to the implementation class if necessary.

introspectedTable - ibator's 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: IbatorPlugin

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 IbatorPlugin