org.beetl.sql.core.engine.template

类 BeetlTemplateEngine

java.lang.Object

org.beetl.sql.core.engine.template.BeetlTemplateEngine

所有已实现的接口:

SQLTemplateEngine

public class BeetlTemplateEngine
extends Object
implements SQLTemplateEngine

beetl模板引擎实现

字段概要

字段

限定符和类型	字段和说明
String	HOLDER_END
String	HOLDER_START
String	STATEMENT_END
String	STATEMENT_START

构造器概要

构造器

构造器和说明
BeetlTemplateEngine()

方法概要

限定符和类型	方法和说明
protected void	appendStatement(ConcatBuilder concatBuilder, String statement)
protected void	appendVar(ConcatBuilder concatBuilder, String express)
String	appendVar(String express)
void	clear()
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中，是#{}.
Beetl	getBeetl()
SQLTemplate	getSqlTemplate(SqlId id) 根据sqlId得到模板
SQLTemplate	getSqlTemplate(SqlId id, TemplateContext parent) 模板渲染使用了include，包含别的sql片段
void	init(SQLLoader loader, Properties ps) 初始化模板引擎
SQLErrorInfo	validate(String sqlTemplate) 校验模板是否正确
String	wrapString(String str) 模板sql增加一一段字符串，需要考虑到str 不能包含模板的一些特殊符号，主要是定界符

从类继承的方法 java.lang.Object

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

字段详细资料

STATEMENT_START

public String STATEMENT_START

STATEMENT_END

public String STATEMENT_END

HOLDER_START

public String HOLDER_START

HOLDER_END

public String HOLDER_END

构造器详细资料

BeetlTemplateEngine

public BeetlTemplateEngine()

方法详细资料

init

public void init(SQLLoader loader,
                 Properties ps)

从接口复制的说明: SQLTemplateEngine

初始化模板引擎

指定者:

init 在接口中 SQLTemplateEngine

getSqlTemplate

public SQLTemplate getSqlTemplate(SqlId id)

从接口复制的说明: SQLTemplateEngine

根据sqlId得到模板

指定者:

getSqlTemplate 在接口中 SQLTemplateEngine

返回:

getSqlTemplate

public SQLTemplate getSqlTemplate(SqlId id,
                                  TemplateContext parent)

从接口复制的说明: SQLTemplateEngine

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

指定者:

getSqlTemplate 在接口中 SQLTemplateEngine

返回:

validate

public SQLErrorInfo validate(String sqlTemplate)

从接口复制的说明: SQLTemplateEngine

校验模板是否正确

指定者:

validate 在接口中 SQLTemplateEngine

返回:

genVar

public void genVar(ConcatBuilder concatBuilder,
                   String var)

从接口复制的说明: SQLTemplateEngine

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

指定者:

genVar 在接口中 SQLTemplateEngine

appendVar

public String appendVar(String express)

指定者:

appendVar 在接口中 SQLTemplateEngine

genTrimStart

public void genTrimStart(ConcatBuilder concatBuilder)

从接口复制的说明: SQLTemplateEngine

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

     trim(){

     }
 

指定者:

genTrimStart 在接口中 SQLTemplateEngine

genTrimStart

public void genTrimStart(ConcatBuilder concatBuilder,
                         String keyword)

指定者:

genTrimStart 在接口中 SQLTemplateEngine

genTrimEnd

public void genTrimEnd(ConcatBuilder concatBuilder)

指定者:

genTrimEnd 在接口中 SQLTemplateEngine

genIfNotEmptyStart

public void genIfNotEmptyStart(ConcatBuilder concatBuilder,
                               String var)

从接口复制的说明: SQLTemplateEngine

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

     if(isNotEmpty(xxx)){

     }
 

指定者:

genIfNotEmptyStart 在接口中 SQLTemplateEngine

genIfNotEmptyEnd

public void genIfNotEmptyEnd(ConcatBuilder concatBuilder)

指定者:

genIfNotEmptyEnd 在接口中 SQLTemplateEngine

genForStart

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

指定者:

genForStart 在接口中 SQLTemplateEngine

genForEnd

public void genForEnd(ConcatBuilder concatBuilder)

指定者:

genForEnd 在接口中 SQLTemplateEngine

genTestVar

public void genTestVar(ConcatBuilder concatBuilder,
                       String var)

从接口复制的说明: SQLTemplateEngine

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

指定者:

genTestVar 在接口中 SQLTemplateEngine

genTestVar

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

从接口复制的说明: SQLTemplateEngine

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

指定者:

genTestVar 在接口中 SQLTemplateEngine

genTestVarOrDefault

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

指定者:

genTestVarOrDefault 在接口中 SQLTemplateEngine

wrapString

public String wrapString(String str)

从接口复制的说明: SQLTemplateEngine

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

指定者:

wrapString 在接口中 SQLTemplateEngine

返回:

另请参阅:

wrapString(java.lang.String)

appendVar

protected void appendVar(ConcatBuilder concatBuilder,
                         String express)

appendStatement

protected void appendStatement(ConcatBuilder concatBuilder,
                               String statement)

getBeetl

public Beetl getBeetl()

clear

public void clear()

指定者:

clear 在接口中 SQLTemplateEngine