Package org.mybatis.scripting.thymeleaf

Class SqlGenerator

java.lang.Object

org.mybatis.scripting.thymeleaf.SqlGenerator

public class SqlGenerator
extends Object

The sql template engine for integrating with Thymeleaf.

Version:

1.0.2

Author:

Kazuki Shimizu

Constructor Summary

Constructors

Constructor	Description
SqlGenerator()	Constructor for creating instance with default TemplateEngine.
SqlGenerator(SqlGeneratorConfig config)	Constructor for creating instance with user specified SqlGenerator.
SqlGenerator(org.thymeleaf.ITemplateEngine templateEngine)	Constructor for creating instance with user defined ITemplateEngine.

Method Summary

Modifier and Type	Method	Description
String	generate(CharSequence sqlTemplate, Object parameter)	Generate a sql using Thymeleaf template engine.
String	generate(CharSequence sqlTemplate, Object parameter, BiConsumer<String,Object> customBindVariableBinder)	Generate a sql using Thymeleaf template engine.
String	generate(CharSequence sqlTemplate, Object parameter, BiConsumer<String,Object> customBindVariableBinder, Map<String,Object> customVariables)	Generate a sql using Thymeleaf template engine.
String	generate(CharSequence sqlTemplate, Object parameter, Map<String,Object> customVariables)	Generate a sql using Thymeleaf template engine.
Map<String,Object>	getDefaultCustomVariables()	Get specified default custom variables.
void	setDefaultCustomVariables(Map<String,Object> defaultCustomVariables)	Set default custom variables.
void	setPropertyAccessor(PropertyAccessor propertyAccessor)	Set a property accessor.

Methods inherited from class java.lang.Object

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

Constructor Details

SqlGenerator

public SqlGenerator()

Constructor for creating instance with default TemplateEngine.

SqlGenerator

public SqlGenerator(SqlGeneratorConfig config)

Constructor for creating instance with user specified SqlGenerator.

Parameters:

config - A user defined SqlGeneratorConfig instance

SqlGenerator

public SqlGenerator(org.thymeleaf.ITemplateEngine templateEngine)

Constructor for creating instance with user defined ITemplateEngine.

Parameters:

templateEngine - A user defined ITemplateEngine instance

Method Details

setDefaultCustomVariables

public void setDefaultCustomVariables(Map<String,Object> defaultCustomVariables)

Set default custom variables.

Parameters:

defaultCustomVariables - a default custom variables for passing to template engine

getDefaultCustomVariables

public Map<String,Object> getDefaultCustomVariables()

Get specified default custom variables.

Returns:

specified default custom variables

setPropertyAccessor

public void setPropertyAccessor(PropertyAccessor propertyAccessor)

Set a property accessor.

Default is PropertyAccessor.BuiltIn.STANDARD.

Parameters:

propertyAccessor - a property accessor

generate

public String generate(CharSequence sqlTemplate,
 Object parameter)

Generate a sql using Thymeleaf template engine.

Parameters:

sqlTemplate - a template SQL

parameter - a parameter object

Returns:

a processed SQL by template engine

generate

public String generate(CharSequence sqlTemplate,
 Object parameter,
 BiConsumer<String,Object> customBindVariableBinder)

Generate a sql using Thymeleaf template engine.

Parameters:

sqlTemplate - a template SQL

parameter - a parameter object

customBindVariableBinder - a binder for a custom bind variable that generated with mb:bind or mb:param

Returns:

a processed SQL by template engine

generate

public String generate(CharSequence sqlTemplate,
 Object parameter,
 Map<String,Object> customVariables)

Generate a sql using Thymeleaf template engine.

Parameters:

sqlTemplate - a template SQL

parameter - a parameter object

customVariables - a custom variables for passing to template engine

Returns:

a processed SQL by template engine

generate

public String generate(CharSequence sqlTemplate,
 Object parameter,
 BiConsumer<String,Object> customBindVariableBinder,
 Map<String,Object> customVariables)

Generate a sql using Thymeleaf template engine.

Parameters:

sqlTemplate - a template SQL

parameter - a parameter object

customBindVariableBinder - a binder for a custom bind variable that generated with mb:bind or mb:param

customVariables - a custom variables for passing to template engine

Returns:

a processed SQL by template engine