org.beetl.sql.core.engine.template

接口 SQLTemplateEngine

所有已知实现类:

BeetlTemplateEngine

public interface SQLTemplateEngine

模板引擎，可以采用其他模板引擎来执行sql模板，默认是用Beetl， 因为Beetl的执行速度快，错误提示友好，最主要的原因是我写的:)

作者:

xiandafu

方法概要

限定符和类型	方法和说明
String	appendVar(String epxression)
void	genForEnd(ConcatBuilder concatBuilder)
void	genForStart(ConcatBuilder concatBuilder, String collection, String var)
void	genIfNotEmptyEnd(ConcatBuilder concatBuilder)
void	genIfNotEmptyStart(ConcatBuilder concatBuilder, String var) 输出一个if语句，用来判断变量是否为空 if(isNotEmpty(xxx)){ }
void	genTestVar(ConcatBuilder concatBuilder, String var) 如果某个变量存在，且不为空，输出此变量
void	genTestVar(ConcatBuilder concatBuilder, String var, String col) 如果某个变量存在，且不为空，输出列名
void	genTestVarOrDefault(ConcatBuilder concatBuilder, String var, String defaultValue)
void	genTrimEnd(ConcatBuilder concatBuilder)
void	genTrimStart(ConcatBuilder concatBuilder) 输出一个trim，会去掉尾部多余的逗号,beetl中是 trim(){ }
void	genTrimStart(ConcatBuilder concatBuilder, String keyword)
void	genVar(ConcatBuilder concatBuilder, String var) 输出一个变量，比如在beetl中，是#{}.
SQLTemplate	getSqlTemplate(SqlId id) 根据sqlId得到模板
default SQLTemplate	getSqlTemplate(SqlId id, TemplateContext parent) 模板渲染使用了include，包含别的sql片段
void	init(SQLLoader loader, Properties ps) 初始化模板引擎
SQLErrorInfo	validate(String sqlTemplate) 校验模板是否正确
default String	wrapString(String str) 模板sql增加一一段字符串，需要考虑到str 不能包含模板的一些特殊符号，主要是定界符

方法详细资料

init

void init(SQLLoader loader,
          Properties ps)

初始化模板引擎

参数:

loader -

ps -

getSqlTemplate

SQLTemplate getSqlTemplate(SqlId id)

根据sqlId得到模板

参数:

id -

返回:

getSqlTemplate

default SQLTemplate getSqlTemplate(SqlId id,
                                   TemplateContext parent)

模板渲染使用了include，包含别的sql片段

参数:

id -

parent -

返回:

validate

SQLErrorInfo validate(String sqlTemplate)

校验模板是否正确

参数:

sqlTemplate -

返回:

genVar

void genVar(ConcatBuilder concatBuilder,
            String var)

输出一个变量，比如在beetl中，是#{}.

参数:

concatBuilder -

var -

appendVar

String appendVar(String epxression)

genTrimStart

void genTrimStart(ConcatBuilder concatBuilder)

输出一个trim，会去掉尾部多余的逗号,beetl中是

     trim(){

     }
 

参数:

concatBuilder -

genTrimStart

void genTrimStart(ConcatBuilder concatBuilder,
                  String keyword)

genTrimEnd

void genTrimEnd(ConcatBuilder concatBuilder)

genIfNotEmptyStart

void genIfNotEmptyStart(ConcatBuilder concatBuilder,
                        String var)

输出一个if语句，用来判断变量是否为空

     if(isNotEmpty(xxx)){

     }
 

参数:

concatBuilder -

var -

genIfNotEmptyEnd

void genIfNotEmptyEnd(ConcatBuilder concatBuilder)

genForStart

void genForStart(ConcatBuilder concatBuilder,
                 String collection,
                 String var)

genForEnd

void genForEnd(ConcatBuilder concatBuilder)

genTestVar

void genTestVar(ConcatBuilder concatBuilder,
                String var)

如果某个变量存在，且不为空，输出此变量

参数:

concatBuilder -

var -

genTestVar

void genTestVar(ConcatBuilder concatBuilder,
                String var,
                String col)

如果某个变量存在，且不为空，输出列名

参数:

concatBuilder -

var -

genTestVarOrDefault

void genTestVarOrDefault(ConcatBuilder concatBuilder,
                         String var,
                         String defaultValue)

wrapString

default String wrapString(String str)

模板sql增加一一段字符串，需要考虑到str 不能包含模板的一些特殊符号，主要是定界符

参数:

str -

返回:

另请参阅:

BeetlTemplateEngine.wrapString(java.lang.String)