org.asia.mybatis.generator.plugins

类 MySqlPaginationPlugin

java.lang.Object

org.mybatis.generator.api.PluginAdapter

org.asia.mybatis.generator.plugins.MySqlPaginationPlugin

所有已实现的接口:

Plugin

public class MySqlPaginationPlugin
extends PluginAdapter

嵌套类概要

从接口继承的嵌套类/接口 org.mybatis.generator.api.Plugin

Plugin.ModelClassType

字段概要

从类继承的字段 org.mybatis.generator.api.PluginAdapter

context, properties

构造器概要

构造器

构造器和说明
MySqlPaginationPlugin()

方法概要

限定符和类型	方法和说明
protected void	addBaseColumns(IntrospectedTable introspectedTable)
protected void	addColumn(java.lang.String name, java.lang.String jdbcType, java.lang.String javaName, FullyQualifiedJavaType javaType, boolean isSequence, boolean isKey, IntrospectedTable introspectedTable)
boolean	clientDeleteByPrimaryKeyMethodGenerated(Method method, Interface interfaze, IntrospectedTable introspectedTable) This method is called when the deleteByPrimaryKey method has been generated in the client interface.
boolean	clientGenerated(Interface interfaze, TopLevelClass topLevelClass, IntrospectedTable introspectedTable) This method is called when the entire client has been generated.
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(IntrospectedTable introspectedTable) This method can be used to generate additional XML files needed by your implementation that might be related to a specific table.
protected void	createCriteriaMethod(java.lang.String fieldName, java.lang.String propertyName, FullyQualifiedJavaType type, InnerClass returnClazz, InnerClass innerClazz, TopLevelClass outClazz)
protected void	createInnerMethod(JavaVisibility visi, java.lang.String name, java.lang.String annotation, FullyQualifiedJavaType returnType, java.util.List<Parameter> parms, java.lang.String body, InnerClass innerClass, TopLevelClass outClass)
protected void	createMethod(JavaVisibility visi, java.lang.String name, java.lang.String annotation, FullyQualifiedJavaType returnType, java.util.List<Parameter> parms, java.lang.String body, TopLevelClass topLevelClass)
static void	main(java.lang.String[] args)
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	sqlMapCountByExampleElementGenerated(XmlElement element, IntrospectedTable introspectedTable) This method is called when the countByExample 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	sqlMapInsertSelectiveElementGenerated(XmlElement element, IntrospectedTable introspectedTable) This method is called when the insert selective 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	sqlMapUpdateByPrimaryKeySelectiveElementGenerated(XmlElement element, IntrospectedTable introspectedTable) This method is called when the updateByPrimaryKeySelective element is generated.
boolean	sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated(XmlElement element, IntrospectedTable introspectedTable) This method is called when the updateByPrimaryKeyWithoutBLOBs element is generated.
boolean	validate(java.util.List<java.lang.String> warnings) This method is called after all the setXXX methods are called, but before any other method is called.

从类继承的方法 org.mybatis.generator.api.PluginAdapter

clientCountByExampleMethodGenerated, clientCountByExampleMethodGenerated, clientDeleteByExampleMethodGenerated, clientDeleteByExampleMethodGenerated, clientDeleteByPrimaryKeyMethodGenerated, clientInsertMethodGenerated, clientInsertMethodGenerated, clientInsertSelectiveMethodGenerated, clientInsertSelectiveMethodGenerated, clientSelectAllMethodGenerated, clientSelectAllMethodGenerated, clientSelectByExampleWithBLOBsMethodGenerated, clientSelectByExampleWithBLOBsMethodGenerated, clientSelectByExampleWithoutBLOBsMethodGenerated, clientSelectByExampleWithoutBLOBsMethodGenerated, clientSelectByPrimaryKeyMethodGenerated, clientSelectByPrimaryKeyMethodGenerated, clientUpdateByExampleSelectiveMethodGenerated, clientUpdateByExampleSelectiveMethodGenerated, clientUpdateByExampleWithBLOBsMethodGenerated, clientUpdateByExampleWithBLOBsMethodGenerated, clientUpdateByExampleWithoutBLOBsMethodGenerated, clientUpdateByExampleWithoutBLOBsMethodGenerated, clientUpdateByPrimaryKeySelectiveMethodGenerated, clientUpdateByPrimaryKeySelectiveMethodGenerated, clientUpdateByPrimaryKeyWithBLOBsMethodGenerated, clientUpdateByPrimaryKeyWithBLOBsMethodGenerated, clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated, clientUpdateByPrimaryKeyWithoutBLOBsMethodGenerated, contextGenerateAdditionalJavaFiles, contextGenerateAdditionalXmlFiles, getContext, getProperties, initialized, modelFieldGenerated, modelGetterMethodGenerated, modelPrimaryKeyClassGenerated, modelRecordWithBLOBsClassGenerated, modelSetterMethodGenerated, providerApplyWhereMethodGenerated, providerCountByExampleMethodGenerated, providerDeleteByExampleMethodGenerated, providerGenerated, providerInsertSelectiveMethodGenerated, providerSelectByExampleWithBLOBsMethodGenerated, providerSelectByExampleWithoutBLOBsMethodGenerated, providerUpdateByExampleSelectiveMethodGenerated, providerUpdateByExampleWithBLOBsMethodGenerated, providerUpdateByExampleWithoutBLOBsMethodGenerated, providerUpdateByPrimaryKeySelectiveMethodGenerated, setContext, setProperties, sqlMapBaseColumnListElementGenerated, sqlMapBlobColumnListElementGenerated, sqlMapDeleteByExampleElementGenerated, sqlMapExampleWhereClauseElementGenerated, sqlMapGenerated, sqlMapInsertElementGenerated, sqlMapResultMapWithBLOBsElementGenerated, sqlMapResultMapWithoutBLOBsElementGenerated, sqlMapSelectAllElementGenerated, sqlMapSelectByExampleWithBLOBsElementGenerated, sqlMapUpdateByExampleSelectiveElementGenerated, sqlMapUpdateByExampleWithBLOBsElementGenerated, sqlMapUpdateByExampleWithoutBLOBsElementGenerated, sqlMapUpdateByPrimaryKeyWithBLOBsElementGenerated

从类继承的方法 java.lang.Object

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

构造器详细资料

MySqlPaginationPlugin

public MySqlPaginationPlugin()

方法详细资料

modelBaseRecordClassGenerated

public boolean modelBaseRecordClassGenerated(TopLevelClass topLevelClass,
                                             IntrospectedTable introspectedTable)

从接口复制的说明: Plugin

This method is called after the base record class is generated by the JavaModelGenerator. This method will only be called if the table rules call for generation of a base record class.

This method is only guaranteed to be called by the default Java model generators. Other user supplied generators may, or may not, call this method.

指定者:

modelBaseRecordClassGenerated 在接口中 Plugin

覆盖:

modelBaseRecordClassGenerated 在类中 PluginAdapter

参数:

topLevelClass - the generated base record class

introspectedTable - The class containing information about the table as introspected from the database

返回:

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.

createMethod

protected void createMethod(JavaVisibility visi,
                            java.lang.String name,
                            java.lang.String annotation,
                            FullyQualifiedJavaType returnType,
                            java.util.List<Parameter> parms,
                            java.lang.String body,
                            TopLevelClass topLevelClass)

createInnerMethod

protected void createInnerMethod(JavaVisibility visi,
                                 java.lang.String name,
                                 java.lang.String annotation,
                                 FullyQualifiedJavaType returnType,
                                 java.util.List<Parameter> parms,
                                 java.lang.String body,
                                 InnerClass innerClass,
                                 TopLevelClass outClass)

createCriteriaMethod

protected void createCriteriaMethod(java.lang.String fieldName,
                                    java.lang.String propertyName,
                                    FullyQualifiedJavaType type,
                                    InnerClass returnClazz,
                                    InnerClass innerClazz,
                                    TopLevelClass outClazz)

addBaseColumns

protected void addBaseColumns(IntrospectedTable introspectedTable)

addColumn

protected void addColumn(java.lang.String name,
                         java.lang.String jdbcType,
                         java.lang.String javaName,
                         FullyQualifiedJavaType javaType,
                         boolean isSequence,
                         boolean isKey,
                         IntrospectedTable introspectedTable)

modelExampleClassGenerated

public boolean modelExampleClassGenerated(TopLevelClass topLevelClass,
                                          IntrospectedTable introspectedTable)

从接口复制的说明: Plugin

This method is called after the example class is generated by the JavaModelGenerator. This method will only be called if the table rules call for generation of an example class.

This method is only guaranteed to be called by the default Java model generators. Other user supplied generators may, or may not, call this method.

指定者:

modelExampleClassGenerated 在接口中 Plugin

覆盖:

modelExampleClassGenerated 在类中 PluginAdapter

参数:

topLevelClass - the generated example class

introspectedTable - The class containing information about the table as introspected from the database

返回:

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.

sqlMapDocumentGenerated

public boolean sqlMapDocumentGenerated(Document document,
                                       IntrospectedTable introspectedTable)

从接口复制的说明: Plugin

This method is called when the SqlMap document has been generated. This method can be used to add additional XML elements the the generated document.

指定者:

sqlMapDocumentGenerated 在接口中 Plugin

覆盖:

sqlMapDocumentGenerated 在类中 PluginAdapter

参数:

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

introspectedTable - The class containing information about the table as introspected from the database

返回:

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.

sqlMapSelectByPrimaryKeyElementGenerated

public boolean sqlMapSelectByPrimaryKeyElementGenerated(XmlElement element,
                                                        IntrospectedTable introspectedTable)

从接口复制的说明: Plugin

This method is called when the selectByPrimaryKey element is generated.

指定者:

sqlMapSelectByPrimaryKeyElementGenerated 在接口中 Plugin

覆盖:

sqlMapSelectByPrimaryKeyElementGenerated 在类中 PluginAdapter

参数:

element - the generated <select> element

introspectedTable - The class containing information about the table as introspected from the database

返回:

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)

从接口复制的说明: Plugin

This method is called when the updateByPrimaryKeySelective element is generated.

指定者:

sqlMapUpdateByPrimaryKeySelectiveElementGenerated 在接口中 Plugin

覆盖:

sqlMapUpdateByPrimaryKeySelectiveElementGenerated 在类中 PluginAdapter

参数:

element - the generated <update> element

introspectedTable - The class containing information about the table as introspected from the database

返回:

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)

从接口复制的说明: Plugin

This method is called when the updateByPrimaryKeyWithoutBLOBs element is generated.

指定者:

sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated 在接口中 Plugin

覆盖:

sqlMapUpdateByPrimaryKeyWithoutBLOBsElementGenerated 在类中 PluginAdapter

参数:

element - the generated <update> element

introspectedTable - The class containing information about the table as introspected from the database

返回:

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)

从接口复制的说明: Plugin

This method is called when the deleteByPrimaryKey element is generated.

指定者:

sqlMapDeleteByPrimaryKeyElementGenerated 在接口中 Plugin

覆盖:

sqlMapDeleteByPrimaryKeyElementGenerated 在类中 PluginAdapter

参数:

element - the generated <delete> element

introspectedTable - The class containing information about the table as introspected from the database

返回:

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)

从接口复制的说明: Plugin

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

指定者:

sqlMapInsertSelectiveElementGenerated 在接口中 Plugin

覆盖:

sqlMapInsertSelectiveElementGenerated 在类中 PluginAdapter

参数:

element - the generated <insert> element

introspectedTable - The class containing information about the table as introspected from the database

返回:

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.

clientDeleteByPrimaryKeyMethodGenerated

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

从接口复制的说明: Plugin

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

指定者:

clientDeleteByPrimaryKeyMethodGenerated 在接口中 Plugin

覆盖:

clientDeleteByPrimaryKeyMethodGenerated 在类中 PluginAdapter

参数:

method - the generated deleteByPrimaryKey method

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

introspectedTable - The class containing information about the table as introspected from the database

返回:

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

clientGenerated

public boolean clientGenerated(Interface interfaze,
                               TopLevelClass topLevelClass,
                               IntrospectedTable introspectedTable)

从接口复制的说明: Plugin

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

指定者:

clientGenerated 在接口中 Plugin

覆盖:

clientGenerated 在类中 PluginAdapter

参数:

interfaze - the generated interface if any, may be null

topLevelClass - the generated implementation class if any, may be null

introspectedTable - The class containing information about the table as introspected from the database

返回:

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.

sqlMapSelectByExampleWithoutBLOBsElementGenerated

public boolean sqlMapSelectByExampleWithoutBLOBsElementGenerated(XmlElement element,
                                                                 IntrospectedTable introspectedTable)

从接口复制的说明: Plugin

This method is called when the selectByExample element is generated.

指定者:

sqlMapSelectByExampleWithoutBLOBsElementGenerated 在接口中 Plugin

覆盖:

sqlMapSelectByExampleWithoutBLOBsElementGenerated 在类中 PluginAdapter

参数:

element - the generated <select> element

introspectedTable - The class containing information about the table as introspected from the database

返回:

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)

从接口复制的说明: Plugin

This method is called when the countByExample element is generated.

指定者:

sqlMapCountByExampleElementGenerated 在接口中 Plugin

覆盖:

sqlMapCountByExampleElementGenerated 在类中 PluginAdapter

参数:

element - the generated <select> element

introspectedTable - The class containing information about the table as introspected from the database

返回:

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.

contextGenerateAdditionalXmlFiles

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

从接口复制的说明: Plugin

This method can be used to generate additional XML files needed by your implementation that might be related to a specific table. This method is called once for every table in the configuration.

指定者:

contextGenerateAdditionalXmlFiles 在接口中 Plugin

覆盖:

contextGenerateAdditionalXmlFiles 在类中 PluginAdapter

参数:

introspectedTable - The class containing information about the table as introspected from the database

返回:

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

contextGenerateAdditionalJavaFiles

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

从接口复制的说明: Plugin

This method can be used to generate additional Java files needed by your implementation that might be related to a specific table. This method is called once for every table in the configuration.

指定者:

contextGenerateAdditionalJavaFiles 在接口中 Plugin

覆盖:

contextGenerateAdditionalJavaFiles 在类中 PluginAdapter

参数:

introspectedTable - The class containing information about the table as introspected from the database

返回:

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

validate

public boolean validate(java.util.List<java.lang.String> warnings)

从接口复制的说明: Plugin

This method is called after all the setXXX methods are called, but before any other method is called. This allows the plugin to determine whether it can run or not. For example, if the plugin requires certain properties to be set, and the properties are not set, then the plugin is invalid and will not run.

参数:

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.

返回:

true if the plugin is in a valid state. Invalid plugins will not be called

main

public static void main(java.lang.String[] args)