org.apache.ibatis.abator.api
Interface SqlMapGenerator

All Known Implementing Classes:
SqlMapGeneratorIterateImpl, SqlMapGeneratorLegacyImpl

public interface SqlMapGenerator

This interface describes the operations that are required of an Sql Map Generator. An Sql Map Generator is a class that generates properly formatted Sql Maps for iBATIS. All setXXX methods will be called before any getXXX method is called.

Author:
Jeff Butler

Method Summary
 void addConfigurationProperties(java.util.Map properties)
          Adds properties for this instance from any properties configured in the SqlMapGeneratorConfiguration.
 void addContextProperties(java.util.Map properties)
          Adds properties for this instance from any properties configured in the current context.
 java.lang.String getDeleteByExampleStatementId()
           
 java.lang.String getDeleteByPrimaryKeyStatementId()
           
 java.util.List getGeneratedXMLFiles(IntrospectedTable introspectedTable, ProgressCallback callback)
           
 java.lang.String getInsertStatementId()
           
 java.lang.String getSelectByExampleStatementId()
           
 java.lang.String getSelectByExampleWithBLOBsStatementId()
           
 java.lang.String getSelectByPrimaryKeyStatementId()
           
 java.lang.String getSqlMapNamespace(FullyQualifiedTable table)
           
 java.lang.String getUpdateByPrimaryKeySelectiveStatementId()
           
 java.lang.String getUpdateByPrimaryKeyStatementId()
           
 java.lang.String getUpdateByPrimaryKeyWithBLOBsStatementId()
           
 void setJavaModelGenerator(JavaModelGenerator javaModelGenerator)
           
 void setTargetPackage(java.lang.String targetPackage)
           
 void setTargetProject(java.lang.String targetProject)
           
 void setWarnings(java.util.List warnings)
          Abator will supply a list to this method.
 

Method Detail

setWarnings

void setWarnings(java.util.List warnings)
Abator will supply a list to this method. The implementation class may add strings to the list that will be treated as warning messages and displayed to the user. The concept of a warning is that code generation can continue, but that the results may not be what is expected.

Parameters:
warnings -

addConfigurationProperties

void addConfigurationProperties(java.util.Map properties)
Adds properties for this instance from any properties configured in the SqlMapGeneratorConfiguration. This method will be called before any of the get methods.

Parameters:
properties - All properties from the configuration

addContextProperties

void addContextProperties(java.util.Map properties)
Adds properties for this instance from any properties configured in the current context. This method will be called before any of the get methods.

Parameters:
properties - All properties from the configuration

setTargetPackage

void setTargetPackage(java.lang.String targetPackage)

setTargetProject

void setTargetProject(java.lang.String targetProject)

setJavaModelGenerator

void setJavaModelGenerator(JavaModelGenerator javaModelGenerator)

getSqlMapNamespace

java.lang.String getSqlMapNamespace(FullyQualifiedTable table)

getInsertStatementId

java.lang.String getInsertStatementId()

getUpdateByPrimaryKeyWithBLOBsStatementId

java.lang.String getUpdateByPrimaryKeyWithBLOBsStatementId()

getUpdateByPrimaryKeySelectiveStatementId

java.lang.String getUpdateByPrimaryKeySelectiveStatementId()

getUpdateByPrimaryKeyStatementId

java.lang.String getUpdateByPrimaryKeyStatementId()

getDeleteByPrimaryKeyStatementId

java.lang.String getDeleteByPrimaryKeyStatementId()

getDeleteByExampleStatementId

java.lang.String getDeleteByExampleStatementId()

getSelectByPrimaryKeyStatementId

java.lang.String getSelectByPrimaryKeyStatementId()

getSelectByExampleStatementId

java.lang.String getSelectByExampleStatementId()

getSelectByExampleWithBLOBsStatementId

java.lang.String getSelectByExampleWithBLOBsStatementId()

getGeneratedXMLFiles

java.util.List getGeneratedXMLFiles(IntrospectedTable introspectedTable,
                                    ProgressCallback callback)