gu.sql2java.wherehelper

类 WhereHelper

java.lang.Object

gu.sql2java.wherehelper.WhereHelper

public class WhereHelper
extends java.lang.Object

基于 BeanShell 脚本引擎实现动态生成SQL where 语句

作者:

guyadong

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	TIMESTAMP_FORMATTER_STR 默认用于SQL语句的时间戳格式转换格式
static java.lang.String	VAR_GROUP_BY_COLUMN 内置变量名:指定 GROUP BY 分组查询指定的字段名
static java.lang.String	VAR_LIMIT_OFFSET 内置变量名:指定分页查询 offset 参数
static java.lang.String	VAR_LIMIT_ROW_COUNT 内置变量名:指定分页查询 row_count 参数
static java.lang.String	VAR_ORDER_BY_COLUMN 内置变量名:指定 ORDER BY 排序的字段名

构造器概要

构造器

构造器和说明
WhereHelper(java.lang.String bshScript) 构造方法

方法概要

限定符和类型	方法和说明
java.lang.String	asCond(java.lang.Object value, boolean not)
static BeanShellWhereBuilder	builder()
WhereHelper	defineVariable(java.lang.String varname, java.lang.Object value) 定义脚本执行变量,在with(Object)方法之后调用有效
boolean	isEmpty(java.lang.Object value) BeanShell运行环境调用的方法:判断一个对象是否为null或空,参见BeanPropertyUtils.isEmpty(Object)
boolean	isFalse(java.lang.Object value) BeanShell运行环境调用的方法:判断一个对象是否为false 类型为Boolean,Number,String都可以, 当为Number类型时,转为整数为0即判定为false, 当为String类型时 false|off|0|no?
boolean	isTrue(java.lang.Object value) BeanShell运行环境调用的方法:判断一个对象是否为true 类型为Boolean,Number,String都可以, 当为Number类型时,转为整数不为0即判定为true, 当为String类型时 true|on|1|y(es)?
java.lang.String	op(java.lang.String field)
java.lang.String	op(java.lang.String field, boolean not) BeanShell运行环境调用的方法:根据指定的字段名field，计算比较表达式 当field对应的值为普通数据类型时,返回表达式 field = vlaue 当field对应的值为数组,集合类型时,返回表达式 field in (v1,v2,v3),
WhereHelper	timeFormatter(java.lang.String timeFormatter) 设置日期对象的格式，默认为TIMESTAMP_FORMATTER_STR
java.lang.String	toString()
java.lang.String	where() 根据with(Object)提供的SQL查询要求的字段参数执行BeanShell脚本创建SQL Where语句 WhereHelper执行BeanShellWhereBuilder生成的BeanShell脚本，脚本根据with(Object)提供的参数，生成SQL WHERE语句
WhereHelper	with(com.google.common.base.Function<java.lang.String,java.lang.String> valueSupplier) 从valueSupplier中获取WhereHelper所有引用变量的值定义定义 到WhereHelper的BeanShell脚本执行空间, 自动匹配变量命名格式
WhereHelper	with(java.lang.Object params) 根据输入的参数对象提供的SQL查询要求的字段参数定义脚本执行变量 SQL查询字段参数可以封装在Java Bean或Map对象，不可为null

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

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

字段详细资料

TIMESTAMP_FORMATTER_STR

public static final java.lang.String TIMESTAMP_FORMATTER_STR

默认用于SQL语句的时间戳格式转换格式

另请参阅:

常量字段值

VAR_ORDER_BY_COLUMN

public static final java.lang.String VAR_ORDER_BY_COLUMN

内置变量名:指定 ORDER BY 排序的字段名

另请参阅:

常量字段值

VAR_GROUP_BY_COLUMN

public static final java.lang.String VAR_GROUP_BY_COLUMN

内置变量名:指定 GROUP BY 分组查询指定的字段名

另请参阅:

常量字段值

VAR_LIMIT_ROW_COUNT

public static final java.lang.String VAR_LIMIT_ROW_COUNT

内置变量名:指定分页查询 row_count 参数

另请参阅:

常量字段值

VAR_LIMIT_OFFSET

public static final java.lang.String VAR_LIMIT_OFFSET

内置变量名:指定分页查询 offset 参数

另请参阅:

常量字段值

构造器详细资料

WhereHelper

public WhereHelper(java.lang.String bshScript)

构造方法

参数:

bshScript - BeanShell 脚本

方法详细资料

timeFormatter

public WhereHelper timeFormatter(java.lang.String timeFormatter)

设置日期对象的格式，默认为TIMESTAMP_FORMATTER_STR

参数:

timeFormatter -

返回:

当前对象

defineVariable

public WhereHelper defineVariable(java.lang.String varname,
                                  java.lang.Object value)

定义脚本执行变量,在with(Object)方法之后调用有效

参数:

varname - 变量名,为空或null忽略

value - 变量的值

返回:

当前对象

with

public WhereHelper with(java.lang.Object params)

根据输入的参数对象提供的SQL查询要求的字段参数定义脚本执行变量
SQL查询字段参数可以封装在Java Bean或Map对象，不可为null

参数:

params -

返回:

当前对象

with

public WhereHelper with(com.google.common.base.Function<java.lang.String,java.lang.String> valueSupplier)

从valueSupplier中获取WhereHelper所有引用变量的值定义定义 到WhereHelper的BeanShell脚本执行空间, 自动匹配变量命名格式

参数:

valueSupplier - 字段变量值提供对象,为null忽略

返回:

当前对象

where

public java.lang.String where()

根据with(Object)提供的SQL查询要求的字段参数执行BeanShell脚本创建SQL Where语句
WhereHelper执行BeanShellWhereBuilder生成的BeanShell脚本，脚本根据with(Object)提供的参数，生成SQL WHERE语句

返回:

动态生成的SQL语句

isEmpty

public boolean isEmpty(java.lang.Object value)

BeanShell运行环境调用的方法:判断一个对象是否为null或空,参见BeanPropertyUtils.isEmpty(Object)

参数:

value -

isTrue

public boolean isTrue(java.lang.Object value)

BeanShell运行环境调用的方法:判断一个对象是否为true
类型为Boolean,Number,String都可以, 当为Number类型时,转为整数不为0即判定为true, 当为String类型时 true|on|1|y(es)? 都判定为true, 为null不判定为true

参数:

value -

isFalse

public boolean isFalse(java.lang.Object value)

BeanShell运行环境调用的方法:判断一个对象是否为false 类型为Boolean,Number,String都可以, 当为Number类型时,转为整数为0即判定为false, 当为String类型时 false|off|0|no? 都判定为false, 为null不判定为true

参数:

value -

op

public java.lang.String op(java.lang.String field,
                           boolean not)

BeanShell运行环境调用的方法:根据指定的字段名field，计算比较表达式
当field对应的值为普通数据类型时,返回表达式 field = vlaue
当field对应的值为数组,集合类型时,返回表达式 field in (v1,v2,v3),

参数:

field -

op

public java.lang.String op(java.lang.String field)

asCond

public java.lang.String asCond(java.lang.Object value,
                               boolean not)

builder

public static BeanShellWhereBuilder builder()

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object