Package org.mybatis.generator.codegen.mybatis3

Class IntrospectedTableMyBatis3Impl

java.lang.Object

org.mybatis.generator.api.IntrospectedTable

org.mybatis.generator.codegen.mybatis3.IntrospectedTableMyBatis3Impl

Direct Known Subclasses:

IntrospectedTableKotlinImpl, IntrospectedTableMyBatis3DynamicSqlImpl, IntrospectedTableMyBatis3SimpleImpl

public class IntrospectedTableMyBatis3Impl
extends IntrospectedTable

Introspected table implementation for generating MyBatis3 artifacts.

Author:

Jeff Butler

Nested Class Summary

Nested classes/interfaces inherited from class org.mybatis.generator.api.IntrospectedTable

IntrospectedTable.InternalAttribute, IntrospectedTable.TargetRuntime

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<AbstractJavaGenerator>	javaGenerators
protected final List<AbstractKotlinGenerator>	kotlinGenerators
protected AbstractXmlGenerator	xmlMapperGenerator

Fields inherited from class org.mybatis.generator.api.IntrospectedTable

attributes, baseColumns, blobColumns, context, fullyQualifiedTable, internalAttributes, primaryKeyColumns, remarks, rules, tableConfiguration, tableType, targetRuntime

Constructor Summary

Constructors

Constructor	Description
IntrospectedTableMyBatis3Impl()

Method Summary

Modifier and Type	Method	Description
protected AbstractJavaClientGenerator	calculateClientGenerators(List<String> warnings, ProgressCallback progressCallback)
void	calculateGenerators(List<String> warnings, ProgressCallback progressCallback)	This method can be used to initialize the generators before they will be called.
protected void	calculateJavaModelGenerators(List<String> warnings, ProgressCallback progressCallback)
protected void	calculateXmlMapperGenerator(AbstractJavaClientGenerator javaClientGenerator, List<String> warnings, ProgressCallback progressCallback)
protected AbstractJavaClientGenerator	createJavaClientGenerator()
protected String	getClientProject()
protected String	getExampleProject()
List<GeneratedJavaFile>	getGeneratedJavaFiles()	This method should return a list of generated Java files related to this table.
List<GeneratedKotlinFile>	getGeneratedKotlinFiles()	This method should return a list of generated Kotlin files related to this table.
List<GeneratedXmlFile>	getGeneratedXmlFiles()	This method should return a list of generated XML files related to this table.
int	getGenerationSteps()	This method should return the number of progress messages that will be send during the generation phase.
protected String	getModelProject()
protected void	initializeAbstractGenerator(AbstractGenerator abstractGenerator, List<String> warnings, ProgressCallback progressCallback)
boolean	requiresXMLGenerator()	Should return true if an XML generator is required for this table.

Methods inherited from class org.mybatis.generator.api.IntrospectedTable

addColumn, addPrimaryKeyColumn, calculateDynamicSqlSupportPackage, calculateJavaClientAttributes, calculateJavaClientInterfacePackage, calculateJavaModelExamplePackage, calculateJavaModelPackage, calculateModelAttributes, calculateMyBatis3FallbackSqlMapNamespace, calculateMyBatis3XmlMapperFileName, calculateSqlMapAliasedFullyQualifiedRuntimeTableName, calculateSqlMapFullyQualifiedRuntimeTableName, calculateSqlMapPackage, calculateXmlAttributes, getAliasedFullyQualifiedTableNameAtRuntime, getAllColumns, getAttribute, getBaseColumnListId, getBaseColumns, getBaseRecordType, getBaseResultMapId, getBlobColumnListId, getBLOBColumns, getColumn, getContext, getCountByExampleStatementId, getDeleteByExampleStatementId, getDeleteByPrimaryKeyStatementId, getExampleType, getExampleWhereClauseId, getFullyQualifiedTable, getFullyQualifiedTableNameAtRuntime, getGeneratedKey, getInsertSelectiveStatementId, getInsertStatementId, getKotlinRecordType, getMyBatis3FallbackSqlMapNamespace, getMyBatis3JavaMapperType, getMyBatis3SqlMapNamespace, getMyBatis3SqlProviderType, getMyBatis3UpdateByExampleWhereClauseId, getMyBatis3XmlMapperFileName, getMyBatis3XmlMapperPackage, getMyBatisDynamicSqlSupportType, getMyBatisDynamicSQLTableObjectName, getNonBLOBColumnCount, getNonBLOBColumns, getNonPrimaryKeyColumns, getPrimaryKeyColumns, getPrimaryKeyType, getRecordWithBLOBsType, getRemarks, getResultMapWithBLOBsId, getRules, getSelectAllStatementId, getSelectByExampleQueryId, getSelectByExampleStatementId, getSelectByExampleWithBLOBsStatementId, getSelectByPrimaryKeyQueryId, getSelectByPrimaryKeyStatementId, getTableConfiguration, getTableConfigurationProperty, getTableType, getTargetRuntime, getUpdateByExampleSelectiveStatementId, getUpdateByExampleStatementId, getUpdateByExampleWithBLOBsStatementId, getUpdateByPrimaryKeySelectiveStatementId, getUpdateByPrimaryKeyStatementId, getUpdateByPrimaryKeyWithBLOBsStatementId, hasAnyColumns, hasBaseColumns, hasBLOBColumns, hasJDBCDateColumns, hasJDBCTimeColumns, hasPrimaryKeyColumns, initialize, isConstructorBased, isImmutable, removeAttribute, setAttribute, setBaseColumnListId, setBaseRecordType, setBaseResultMapId, setBlobColumnListId, setContext, setCountByExampleStatementId, setDeleteByExampleStatementId, setDeleteByPrimaryKeyStatementId, setExampleType, setExampleWhereClauseId, setFullyQualifiedTable, setInsertSelectiveStatementId, setInsertStatementId, setKotlinRecordType, setMyBatis3FallbackSqlMapNamespace, setMyBatis3JavaMapperType, setMyBatis3SqlProviderType, setMyBatis3UpdateByExampleWhereClauseId, setMyBatis3XmlMapperFileName, setMyBatis3XmlMapperPackage, setMyBatisDynamicSqlSupportType, setMyBatisDynamicSQLTableObjectName, setPrimaryKeyType, setRecordWithBLOBsType, setRemarks, setResultMapWithBLOBsId, setRules, setSelectAllStatementId, setSelectByExampleStatementId, setSelectByExampleWithBLOBsStatementId, setSelectByPrimaryKeyStatementId, setSqlMapAliasedFullyQualifiedRuntimeTableName, setSqlMapFullyQualifiedRuntimeTableName, setTableConfiguration, setTableType, setUpdateByExampleSelectiveStatementId, setUpdateByExampleStatementId, setUpdateByExampleWithBLOBsStatementId, setUpdateByPrimaryKeySelectiveStatementId, setUpdateByPrimaryKeyStatementId, setUpdateByPrimaryKeyWithBLOBsStatementId

Methods inherited from class java.lang.Object

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

Field Details

javaGenerators

protected final List<AbstractJavaGenerator> javaGenerators

kotlinGenerators

protected final List<AbstractKotlinGenerator> kotlinGenerators

xmlMapperGenerator

protected AbstractXmlGenerator xmlMapperGenerator

Constructor Details

IntrospectedTableMyBatis3Impl

public IntrospectedTableMyBatis3Impl()

Method Details

calculateGenerators

public void calculateGenerators(List<String> warnings,
 ProgressCallback progressCallback)

Description copied from class: IntrospectedTable

This method can be used to initialize the generators before they will be called.

This method is called after all the setX methods, but before getNumberOfSubtasks(), getGeneratedJavaFiles, and getGeneratedXmlFiles.

Specified by:

calculateGenerators in class IntrospectedTable

Parameters:

warnings - the warnings

progressCallback - the progress callback

calculateXmlMapperGenerator

protected void calculateXmlMapperGenerator(AbstractJavaClientGenerator javaClientGenerator,
 List<String> warnings,
 ProgressCallback progressCallback)

calculateClientGenerators

protected AbstractJavaClientGenerator calculateClientGenerators(List<String> warnings,
 ProgressCallback progressCallback)

createJavaClientGenerator

protected AbstractJavaClientGenerator createJavaClientGenerator()

calculateJavaModelGenerators

protected void calculateJavaModelGenerators(List<String> warnings,
 ProgressCallback progressCallback)

initializeAbstractGenerator

protected void initializeAbstractGenerator(AbstractGenerator abstractGenerator,
 List<String> warnings,
 ProgressCallback progressCallback)

getGeneratedJavaFiles

public List<GeneratedJavaFile> getGeneratedJavaFiles()

Description copied from class: IntrospectedTable

This method should return a list of generated Java files related to this table. This list could include various types of model classes, as well as DAO classes.

Specified by:

getGeneratedJavaFiles in class IntrospectedTable

Returns:

the list of generated Java files for this table

getGeneratedKotlinFiles

public List<GeneratedKotlinFile> getGeneratedKotlinFiles()

Description copied from class: IntrospectedTable

This method should return a list of generated Kotlin files related to this table. This list could include a data classes, a mapper interface, extension methods, etc.

Specified by:

getGeneratedKotlinFiles in class IntrospectedTable

Returns:

the list of generated Kotlin files for this table

getClientProject

protected String getClientProject()

getModelProject

protected String getModelProject()

getExampleProject

protected String getExampleProject()

getGeneratedXmlFiles

public List<GeneratedXmlFile> getGeneratedXmlFiles()

Description copied from class: IntrospectedTable

This method should return a list of generated XML files related to this table. Most implementations will only return one file - the generated SqlMap file.

Specified by:

getGeneratedXmlFiles in class IntrospectedTable

Returns:

the list of generated XML files for this table

getGenerationSteps

public int getGenerationSteps()

Description copied from class: IntrospectedTable

This method should return the number of progress messages that will be send during the generation phase.

Specified by:

getGenerationSteps in class IntrospectedTable

Returns:

the number of progress messages

requiresXMLGenerator

public boolean requiresXMLGenerator()

Description copied from class: IntrospectedTable

Should return true if an XML generator is required for this table. This method will be called during validation of the configuration, so it should not rely on database introspection. This method simply tells the validator if an XML configuration is normally required for this implementation.

Specified by:

requiresXMLGenerator in class IntrospectedTable

Returns:

true, if successful