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.Properties properties)
          Adds properties for this instance from any properties configured in the SqlMapGeneratorConfiguration.
 java.lang.String getCountByExampleStatementId()
           
 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 getUpdateByExampleSelectiveStatementId()
           
 java.lang.String getUpdateByExampleStatementId()
           
 java.lang.String getUpdateByExampleWithBLOBsStatementId()
           
 java.lang.String getUpdateByPrimaryKeySelectiveStatementId()
           
 java.lang.String getUpdateByPrimaryKeyStatementId()
           
 java.lang.String getUpdateByPrimaryKeyWithBLOBsStatementId()
           
 void setAbatorContext(AbatorContext abatorContext)
          Sets the instance of the AbatorConfiguration object associated with this instance.
 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

public 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

public void addConfigurationProperties(java.util.Properties 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

setAbatorContext

public void setAbatorContext(AbatorContext abatorContext)
Sets the instance of the AbatorConfiguration object associated with this instance. This method will be called before any of the get methods.

Parameters:
abatorContext - The current AbatorContext

setTargetPackage

public void setTargetPackage(java.lang.String targetPackage)

setTargetProject

public void setTargetProject(java.lang.String targetProject)

setJavaModelGenerator

public void setJavaModelGenerator(JavaModelGenerator javaModelGenerator)

getSqlMapNamespace

public java.lang.String getSqlMapNamespace(FullyQualifiedTable table)

getInsertStatementId

public java.lang.String getInsertStatementId()

getUpdateByPrimaryKeyWithBLOBsStatementId

public java.lang.String getUpdateByPrimaryKeyWithBLOBsStatementId()

getUpdateByPrimaryKeySelectiveStatementId

public java.lang.String getUpdateByPrimaryKeySelectiveStatementId()

getUpdateByPrimaryKeyStatementId

public java.lang.String getUpdateByPrimaryKeyStatementId()

getDeleteByPrimaryKeyStatementId

public java.lang.String getDeleteByPrimaryKeyStatementId()

getDeleteByExampleStatementId

public java.lang.String getDeleteByExampleStatementId()

getSelectByPrimaryKeyStatementId

public java.lang.String getSelectByPrimaryKeyStatementId()

getSelectByExampleStatementId

public java.lang.String getSelectByExampleStatementId()

getSelectByExampleWithBLOBsStatementId

public java.lang.String getSelectByExampleWithBLOBsStatementId()

getCountByExampleStatementId

public java.lang.String getCountByExampleStatementId()

getUpdateByExampleSelectiveStatementId

public java.lang.String getUpdateByExampleSelectiveStatementId()

getUpdateByExampleStatementId

public java.lang.String getUpdateByExampleStatementId()

getUpdateByExampleWithBLOBsStatementId

public java.lang.String getUpdateByExampleWithBLOBsStatementId()

getGeneratedXMLFiles

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