public interface Plugin
Plugins have a lifecycle. In general, the lifecycle is this:
Plugins are called, and initialized, in the same order they are specified in the configuration.
The clientXXX, modelXXX, and sqlMapXXX methods are called by the code generators. If you replace the default code generators with other implementations, these methods may not be called.
PluginAdapter
Modifier and Type | Interface and Description |
---|---|
static class |
Plugin.ModelClassType |
Modifier and Type | Method and Description |
---|---|
boolean |
clientCountByExampleMethodGenerated(Method method,
Interface interfaze,
IntrospectedTable introspectedTable)
This method is called when the countByExample method has been generated
in the client interface.
|
boolean |
clientCountByExampleMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the countByExample method has been generated
in the client implementation class.
|
boolean |
clientDeleteByExampleMethodGenerated(Method method,
Interface interfaze,
IntrospectedTable introspectedTable)
This method is called when the deleteByExample method has been generated
in the client interface.
|
boolean |
clientDeleteByExampleMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the deleteByExample method has been generated
in the client implementation class.
|
boolean |
clientDeleteByPrimaryKeyMethodGenerated(Method method,
Interface interfaze,
IntrospectedTable introspectedTable)
This method is called when the deleteByPrimaryKey method has been
generated in the client interface.
|
boolean |
clientDeleteByPrimaryKeyMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the deleteByPrimaryKey method has been
generated in the client implementation class.
|
boolean |
clientGenerated(Interface interfaze,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the entire client has been generated.
|
boolean |
clientInsertMethodGenerated(Method method,
Interface interfaze,
IntrospectedTable introspectedTable)
This method is called when the insert method has been generated in the
client interface.
|
boolean |
clientInsertMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the insert method has been generated in the
client implementation class.
|
boolean |
clientInsertSelectiveMethodGenerated(Method method,
Interface interfaze,
IntrospectedTable introspectedTable)
This method is called when the insert selective method has been generated
in the client interface.
|
boolean |
clientInsertSelectiveMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the insert selective method has been generated
in the client implementation class.
|
boolean |
clientSelectAllMethodGenerated(Method method,
Interface interfaze,
IntrospectedTable introspectedTable)
This method is called when the selectAll method has been
generated in the client interface.
|
boolean |
clientSelectAllMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the selectAll method has been
generated in the client implementation class.
|
boolean |
clientSelectByExampleWithBLOBsMethodGenerated(Method method,
Interface interfaze,
IntrospectedTable introspectedTable)
This method is called when the selectByExampleWithBLOBs method has been
generated in the client interface.
|
boolean |
clientSelectByExampleWithBLOBsMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the selectByExampleWithBLOBs method has been
generated in the client implementation class.
|
boolean |
clientSelectByExampleWithoutBLOBsMethodGenerated(Method method,
Interface interfaze,
IntrospectedTable introspectedTable)
This method is called when the selectByExampleWithoutBLOBs method has
been generated in the client interface.
|
boolean |
clientSelectByExampleWithoutBLOBsMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the selectByExampleWithoutBLOBs method has
been generated in the client implementation class.
|
boolean |
clientSelectByPrimaryKeyMethodGenerated(Method method,
Interface interfaze,
IntrospectedTable introspectedTable)
This method is called when the selectByPrimaryKey method has been
generated in the client interface.
|
boolean |
clientSelectByPrimaryKeyMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the selectByPrimaryKey method has been
generated in the client implementation class.
|
boolean |
clientUpdateByExampleSelectiveMethodGenerated(Method method,
Interface interfaze,
IntrospectedTable introspectedTable)
This method is called when the updateByExampleSelective method has been
generated in the client interface.
|
boolean |
clientUpdateByExampleSelectiveMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the updateByExampleSelective method has been
generated in the client implementation class.
|
boolean |
clientUpdateByExampleWithBLOBsMethodGenerated(Method method,
Interface interfaze,
IntrospectedTable introspectedTable)
This method is called when the updateByExampleWithBLOBs method has been
generated in the client interface.
|
boolean |
clientUpdateByExampleWithBLOBsMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the updateByExampleWithBLOBs method has been
generated in the client implementation class.
|
boolean |
clientUpdateByExampleWithoutBLOBsMethodGenerated(Method method,
Interface interfaze,
IntrospectedTable introspectedTable)
This method is called when the updateByExampleWithoutBLOBs method has
been generated in the client interface.
|
boolean |
clientUpdateByExampleWithoutBLOBsMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the updateByExampleWithoutBLOBs method has
been generated in the client implementation class.
|
boolean |
clientUpdateByPrimaryKeySelectiveMethodGenerated(Method method,
Interface interfaze,
IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeySelective method has
been generated in the client interface.
|
boolean |
clientUpdateByPrimaryKeySelectiveMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeySelective method has
been generated in the client implementation class.
|
boolean |
clientUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method,
Interface interfaze,
IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeyWithBLOBs method has
been generated in the client interface.
|
boolean |
clientUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeyWithBLOBs method has
been generated in the client implementation class.
|
boolean |
clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(Method method,
Interface interfaze,
IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeyWithoutBLOBs method has
been generated in the client interface.
|
boolean |
clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeyWithoutBLOBs method has
been generated in the client implementation class.
|
List<GeneratedJavaFile> |
contextGenerateAdditionalJavaFiles()
This method can be used to generate any additional Java file needed by
your implementation.
|
List<GeneratedJavaFile> |
contextGenerateAdditionalJavaFiles(IntrospectedTable introspectedTable)
This method can be used to generate additional Java files needed by your
implementation that might be related to a specific table.
|
List<GeneratedXmlFile> |
contextGenerateAdditionalXmlFiles()
This method can be used to generate any additional XML file needed by
your implementation.
|
List<GeneratedXmlFile> |
contextGenerateAdditionalXmlFiles(IntrospectedTable introspectedTable)
This method can be used to generate additional XML files needed by your
implementation that might be related to a specific table.
|
void |
initialized(IntrospectedTable introspectedTable)
This method is called just before the getGeneratedXXXFiles methods are
called on the introspected table.
|
boolean |
modelBaseRecordClassGenerated(TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called after the base record class is generated by the
JavaModelGenerator.
|
boolean |
modelExampleClassGenerated(TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called after the example class is generated by the
JavaModelGenerator.
|
boolean |
modelFieldGenerated(Field field,
TopLevelClass topLevelClass,
IntrospectedColumn introspectedColumn,
IntrospectedTable introspectedTable,
Plugin.ModelClassType modelClassType)
This method is called after the field is generated for a specific column
in a table.
|
boolean |
modelGetterMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedColumn introspectedColumn,
IntrospectedTable introspectedTable,
Plugin.ModelClassType modelClassType)
This method is called after the getter, or accessor, method is generated
for a specific column in a table.
|
boolean |
modelPrimaryKeyClassGenerated(TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called after the primary key class is generated by the
JavaModelGenerator.
|
boolean |
modelRecordWithBLOBsClassGenerated(TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called after the record with BLOBs class is generated by
the JavaModelGenerator.
|
boolean |
modelSetterMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedColumn introspectedColumn,
IntrospectedTable introspectedTable,
Plugin.ModelClassType modelClassType)
This method is called after the setter, or mutator, method is generated
for a specific column in a table.
|
boolean |
providerApplyWhereMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the applyWhere method has
been generated in the SQL provider.
|
boolean |
providerCountByExampleMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the countByExample method has
been generated in the SQL provider.
|
boolean |
providerDeleteByExampleMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the deleteByExample method has
been generated in the SQL provider.
|
boolean |
providerGenerated(TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the SQL provider has been generated.
|
boolean |
providerInsertSelectiveMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the insertSelective method has
been generated in the SQL provider.
|
boolean |
providerSelectByExampleWithBLOBsMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the selectByExampleWithBLOBs method has
been generated in the SQL provider.
|
boolean |
providerSelectByExampleWithoutBLOBsMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the selectByExampleWithoutBLOBs method has
been generated in the SQL provider.
|
boolean |
providerUpdateByExampleSelectiveMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the updateByExampleSelective method has
been generated in the SQL provider.
|
boolean |
providerUpdateByExampleWithBLOBsMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the updateByExampleWithBLOBs method has
been generated in the SQL provider.
|
boolean |
providerUpdateByExampleWithoutBLOBsMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the updateByExampleWithoutBLOBs method has
been generated in the SQL provider.
|
boolean |
providerUpdateByPrimaryKeySelectiveMethodGenerated(Method method,
TopLevelClass topLevelClass,
IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeySelective method has
been generated in the SQL provider.
|
void |
setContext(Context context)
Set the context under which this plugin is running
|
void |
setProperties(Properties properties)
Set properties from the plugin configuration
|
boolean |
sqlMapBaseColumnListElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the baseColumnList element is generated.
|
boolean |
sqlMapBlobColumnListElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the blobColumnList element is generated.
|
boolean |
sqlMapCountByExampleElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the countByExample element is generated.
|
boolean |
sqlMapDeleteByExampleElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the deleteByExample element is generated.
|
boolean |
sqlMapDeleteByPrimaryKeyElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the deleteByPrimaryKey element is generated.
|
boolean |
sqlMapDocumentGenerated(Document document,
IntrospectedTable introspectedTable)
This method is called when the SqlMap document has been generated.
|
boolean |
sqlMapExampleWhereClauseElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the exampleWhereClause element is generated.
|
boolean |
sqlMapGenerated(GeneratedXmlFile sqlMap,
IntrospectedTable introspectedTable)
This method is called when the SqlMap file has been generated.
|
boolean |
sqlMapInsertElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the insert element is generated.
|
boolean |
sqlMapInsertSelectiveElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the insert selective element is generated.
|
boolean |
sqlMapResultMapWithBLOBsElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the resultMap with BLOBs element is generated
- this resultMap will extend the base resultMap.
|
boolean |
sqlMapResultMapWithoutBLOBsElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the base resultMap is generated.
|
boolean |
sqlMapSelectAllElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the selectAll element is generated.
|
boolean |
sqlMapSelectByExampleWithBLOBsElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the selectByExampleWithBLOBs element is
generated.
|
boolean |
sqlMapSelectByExampleWithoutBLOBsElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the selectByExample element is generated.
|
boolean |
sqlMapSelectByPrimaryKeyElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the selectByPrimaryKey element is generated.
|
boolean |
sqlMapUpdateByExampleSelectiveElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the updateByExampleSelective element is
generated.
|
boolean |
sqlMapUpdateByExampleWithBLOBsElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the updateByExampleWithBLOBs element is
generated.
|
boolean |
sqlMapUpdateByExampleWithoutBLOBsElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the updateByExampleWithourBLOBs element is
generated.
|
boolean |
sqlMapUpdateByPrimaryKeySelectiveElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeySelective element is
generated.
|
boolean |
sqlMapUpdateByPrimaryKeyWithBLOBsElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeyWithBLOBs element is
generated.
|
boolean |
sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated(XmlElement element,
IntrospectedTable introspectedTable)
This method is called when the updateByPrimaryKeyWithoutBLOBs element is
generated.
|
boolean |
validate(List<String> warnings)
This method is called after all the setXXX methods are called, but before
any other method is called.
|
void setContext(Context context)
context
- void setProperties(Properties properties)
properties
- void initialized(IntrospectedTable 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.
introspectedTable
- boolean validate(List<String> warnings)
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.List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles()
List<GeneratedJavaFile> contextGenerateAdditionalJavaFiles(IntrospectedTable introspectedTable)
introspectedTable
- The class containing information about the table as
introspected from the databaseList<GeneratedXmlFile> contextGenerateAdditionalXmlFiles()
List<GeneratedXmlFile> contextGenerateAdditionalXmlFiles(IntrospectedTable introspectedTable)
introspectedTable
- The class containing information about the table as
introspected from the databaseboolean clientGenerated(Interface interfaze, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
interfaze
- the generated interface if any, may be nulltopLevelClass
- the generated implementation class if any, may be nullintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean clientCountByExampleMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated countByExample methodtopLevelClass
- 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 databaseboolean clientDeleteByExampleMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated deleteByExample methodtopLevelClass
- 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 databaseboolean clientDeleteByPrimaryKeyMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated deleteByPrimaryKey methodtopLevelClass
- 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 databaseboolean clientInsertMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated insert methodtopLevelClass
- 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 databaseboolean clientInsertSelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated insert methodtopLevelClass
- 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 databaseboolean clientSelectByExampleWithBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated selectByExampleWithBLOBs methodtopLevelClass
- 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 databaseboolean clientSelectByExampleWithoutBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated selectByExampleWithoutBLOBs methodtopLevelClass
- 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 databaseboolean clientSelectByPrimaryKeyMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated selectByPrimaryKey methodtopLevelClass
- 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 databaseboolean clientUpdateByExampleSelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated updateByExampleSelective methodtopLevelClass
- 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 databaseboolean clientUpdateByExampleWithBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated updateByExampleWithBLOBs methodtopLevelClass
- 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 databaseboolean clientUpdateByExampleWithoutBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated updateByExampleWithoutBLOBs methodtopLevelClass
- 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 databaseboolean clientUpdateByPrimaryKeySelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated updateByPrimaryKeySelective methodtopLevelClass
- 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 databaseboolean clientUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated updateByPrimaryKeyWithBLOBs methodtopLevelClass
- 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 databaseboolean clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated updateByPrimaryKeyWithBLOBs methodtopLevelClass
- 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 databaseboolean clientCountByExampleMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
method
- the generated countByExample methodinterfaze
- 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 databaseboolean clientDeleteByExampleMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
method
- the generated deleteByExample methodinterfaze
- 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 databaseboolean clientDeleteByPrimaryKeyMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
method
- the generated deleteByPrimaryKey methodinterfaze
- 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 databaseboolean clientInsertMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
method
- the generated insert methodinterfaze
- 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 databaseboolean clientInsertSelectiveMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
method
- the generated insert methodinterfaze
- 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 databaseboolean clientSelectAllMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
method
- the generated selectAll methodinterfaze
- 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 databaseboolean clientSelectAllMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated selectAll methodtopLevelClass
- 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 databaseboolean clientSelectByExampleWithBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
method
- the generated selectByExampleWithBLOBs methodinterfaze
- 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 databaseboolean clientSelectByExampleWithoutBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
method
- the generated selectByExampleWithoutBLOBs methodinterfaze
- 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 databaseboolean clientSelectByPrimaryKeyMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
method
- the generated selectByPrimaryKey methodinterfaze
- 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 databaseboolean clientUpdateByExampleSelectiveMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
method
- the generated updateByExampleSelective methodinterfaze
- 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 databaseboolean clientUpdateByExampleWithBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
method
- the generated updateByExampleWithBLOBs methodinterfaze
- 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 databaseboolean clientUpdateByExampleWithoutBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
method
- the generated updateByExampleWithoutBLOBs methodinterfaze
- 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 databaseboolean clientUpdateByPrimaryKeySelectiveMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
method
- the generated updateByPrimaryKeySelective methodinterfaze
- 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 databaseboolean clientUpdateByPrimaryKeyWithBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
method
- the generated updateByPrimaryKeyWithBLOBs methodinterfaze
- 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 databaseboolean clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable)
method
- the generated updateByPrimaryKeyWithoutBLOBs methodinterfaze
- 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 databaseboolean modelFieldGenerated(Field field, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, Plugin.ModelClassType modelClassType)
field
- the field generated for the specified columntopLevelClass
- 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 databaseintrospectedTable
- The class containing information about the table as
introspected from the databasemodelClassType
- the type of class that the field is generated forboolean modelGetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, Plugin.ModelClassType modelClassType)
method
- the getter, or accessor, method generated for the specified
columntopLevelClass
- 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 databaseintrospectedTable
- The class containing information about the table as
introspected from the databasemodelClassType
- the type of class that the field is generated forboolean modelSetterMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable, Plugin.ModelClassType modelClassType)
method
- the setter, or mutator, method generated for the specified
columntopLevelClass
- 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 databaseintrospectedTable
- The class containing information about the table as
introspected from the databasemodelClassType
- the type of class that the field is generated forboolean modelPrimaryKeyClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
topLevelClass
- the generated primary key classintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
topLevelClass
- the generated base record classintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean modelRecordWithBLOBsClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
topLevelClass
- the generated record with BLOBs classintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean modelExampleClassGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
topLevelClass
- the generated example classintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapGenerated(GeneratedXmlFile sqlMap, IntrospectedTable introspectedTable)
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 databaseboolean sqlMapDocumentGenerated(Document document, IntrospectedTable introspectedTable)
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 databaseboolean sqlMapResultMapWithoutBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <resultMap> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapCountByExampleElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <select> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapDeleteByExampleElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <delete> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapDeleteByPrimaryKeyElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <delete> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapExampleWhereClauseElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <sql> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapBaseColumnListElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <sql> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapBlobColumnListElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <sql> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapInsertElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <insert> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapInsertSelectiveElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <insert> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapResultMapWithBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <resultMap> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapSelectAllElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <select> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapSelectByPrimaryKeyElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <select> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapSelectByExampleWithoutBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <select> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapSelectByExampleWithBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <select> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapUpdateByExampleSelectiveElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <update> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapUpdateByExampleWithBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <update> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapUpdateByExampleWithoutBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <update> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapUpdateByPrimaryKeySelectiveElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <update> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapUpdateByPrimaryKeyWithBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <update> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable)
element
- the generated <update> elementintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean providerGenerated(TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
topLevelClass
- the generated providerintrospectedTable
- The class containing information about the table as
introspected from the databaseboolean providerApplyWhereMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated applyWhere methodtopLevelClass
- 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 databaseboolean providerCountByExampleMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated countByExample methodtopLevelClass
- 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 databaseboolean providerDeleteByExampleMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated deleteByExample methodtopLevelClass
- 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 databaseboolean providerInsertSelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated insertSelective methodtopLevelClass
- 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 databaseboolean providerSelectByExampleWithBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated selectByExampleWithBLOBs methodtopLevelClass
- 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 databaseboolean providerSelectByExampleWithoutBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated selectByExampleWithoutBLOBs methodtopLevelClass
- 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 databaseboolean providerUpdateByExampleSelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated updateByExampleSelective methodtopLevelClass
- 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 databaseboolean providerUpdateByExampleWithBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated updateByExampleWithBLOBs methodtopLevelClass
- 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 databaseboolean providerUpdateByExampleWithoutBLOBsMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated updateByExampleWithoutBLOBs methodtopLevelClass
- 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 databaseboolean providerUpdateByPrimaryKeySelectiveMethodGenerated(Method method, TopLevelClass topLevelClass, IntrospectedTable introspectedTable)
method
- the generated updateByPrimaryKeySelective methodtopLevelClass
- 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 databaseCopyright © 2010–2018 MyBatis.org. All rights reserved.