org.apache.ibatis.abator.api
Interface SqlMapGenerator

All Known Implementing Classes:
SqlMapGeneratorDefaultImpl, SqlMapGeneratorIterateImpl

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
 java.lang.String getDeleteByExampleStatementId()
           
 java.lang.String getDeleteByPrimaryKeyStatementId()
           
 java.util.List getGeneratedXMLFiles(ColumnDefinitions columnDefinitions, TableConfiguration tableConfiguration, 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 getUpdateByPrimaryKeyStatementId()
           
 java.lang.String getUpdateByPrimaryKeyWithBLOBsStatementId()
           
 void setJavaModelGenerator(JavaModelGenerator javaModelGenerator)
           
 void setProperties(java.util.Map properties)
           
 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 -

setProperties

public void setProperties(java.util.Map properties)

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()

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()

getGeneratedXMLFiles

public java.util.List getGeneratedXMLFiles(ColumnDefinitions columnDefinitions,
                                           TableConfiguration tableConfiguration,
                                           ProgressCallback callback)