BeanShellWhereBuilder (sql2java pagehelper 3.12.9 API)

java.lang.Object
- gu.sql2java.wherehelper.BeanShellWhereBuilder

```
public class BeanShellWhereBuilder
extends java.lang.Object
```
基于调用者提供的表达式生成动态执行脚本(BeanShell)

作者:

guyadong

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`DT_MYSQL`
`static java.lang.String`	`IGNORE_EMPTY`
`static java.lang.String`	`KEYWORD_COND_COUNT`
`static java.lang.String`	`KEYWORD_EXP_BUFFER`
`static java.lang.String`	`KEYWORD_WHERE_BUFFER`
`static java.lang.String`	`NOT_EQUAL`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`BeanShellWhereBuilder`	`and()` 指定与前一个表达式的连接方式为AND
`WhereHelper`	`build()` 根据指定的条件生成`WhereHelper`实例
`boolean`	`debuglog()`
`BeanShellWhereBuilder`	`debuglog(boolean debuglog)` 设置是否输出调试信息
`BeanShellWhereBuilder`	`equal(java.lang.String field)` 创建一个等价表达式，如`column_name = $<column_name>`, 如果column_name为`null`或空,则表达式为 `column_name IS NULL` 如果column_name为集合,则为IN表达式 `column_name IN (...)`
`BeanShellWhereBuilder`	`equalIf(java.lang.String test, java.lang.String field, boolean not)` 当满足`test`指定的条件时,创建一个等价表达式输入参数为`null`或空则忽略,不生成表达式
`BeanShellWhereBuilder`	`equalIfNonEmpty(java.lang.String field)` 参见`equal(String)`,不之处在于如果column_name为`null`或空则忽略,不生成表达式
`BeanShellWhereBuilder`	`equalIfNonEmpty(java.lang.String field, boolean not)` 参见`equal(String)`,不之处在于如果column_name为`null`或空则忽略,不生成表达式
`BeanShellWhereBuilder`	`equalNot(java.lang.String field)` 创建一个不等价表达式，如{@code column_name !
`BeanShellWhereBuilder`	`exp(java.lang.String exp)` 生成一般表达式
`BeanShellWhereBuilder`	`from(java.lang.annotation.Annotation[] annots)` 从注解中创建表达式
`java.lang.String`	`getGroupByColumns()`
`java.lang.String`	`getGroupByVarname()`
`java.lang.String`	`getOrderByColumns()`
`java.lang.String`	`getOrderByVarname()`
`java.util.Set<java.lang.String>`	`getReferenceVariables()`
`java.lang.Class<? extends gu.sql2java.BaseRow>`	`getTargetClass()`
`java.util.Map<java.lang.String,java.lang.Class<?>>`	`getVarTypes()`
`BeanShellWhereBuilder`	`groupBy(java.lang.String... columnNames)` 指定GROUP BY 的字段名
`BeanShellWhereBuilder`	`groupByVar(java.lang.String varName)` 指定GROUP BY 的字段变量名
`BeanShellWhereBuilder`	`ifelse(java.lang.String test, java.lang.String doStatement, java.lang.String elseStatement)` 输入条件`test`为`true`则生成`doStatement`指定的表达式, 否则生成`elseStatement`指定的表达式,`elseStatement`为`null`时不生成表达式
`BeanShellWhereBuilder`	`onlyif(java.lang.String test, java.lang.String doStatement)` 同`ifelse(String, String, String)`,只是没有`elseStatement`
`BeanShellWhereBuilder`	`or()` 指定与前一个表达式的连接方式为OR
`BeanShellWhereBuilder`	`orderBy(java.lang.String columnName)` 指定ORDER BY 的字段名,格式要求 ${字段名}[ DESC\|ASC]
`BeanShellWhereBuilder`	`orderBy(java.lang.String columnName, boolean desc)` 指定ORDER BY 的字段名
`BeanShellWhereBuilder`	`orderByVar(java.lang.String varName)` 指定ORDER BY 的字段变量名
`BeanShellWhereBuilder`	`pagequery(boolean pagequery)` 设置是否支持生成分页查询语句(如MySQL LIMIT ${row_count} OFFSET ${offset})
`BeanShellWhereBuilder`	`selectFrom(java.lang.String selectFrom)` 指定SELECT ....

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - NOT_EQUAL
```
public static final java.lang.String NOT_EQUAL
```
    另请参阅:
    
    常量字段值
  - IGNORE_EMPTY
```
public static final java.lang.String IGNORE_EMPTY
```
    另请参阅:
    
    常量字段值
  - KEYWORD_COND_COUNT
```
public static final java.lang.String KEYWORD_COND_COUNT
```
    另请参阅:
    
    常量字段值
  - KEYWORD_WHERE_BUFFER
```
public static final java.lang.String KEYWORD_WHERE_BUFFER
```
    另请参阅:
    
    常量字段值
  - KEYWORD_EXP_BUFFER
```
public static final java.lang.String KEYWORD_EXP_BUFFER
```
    另请参阅:
    
    常量字段值
  - DT_MYSQL
```
public static final java.lang.String DT_MYSQL
```
    另请参阅:
    
    常量字段值
- 方法详细资料
  - debuglog
```
public boolean debuglog()
```
  - debuglog
```
public BeanShellWhereBuilder debuglog(boolean debuglog)
```
    设置是否输出调试信息
    
    参数:
    
    debuglog -
    
    返回:
    
    当前对象
  - pagequery
```
public BeanShellWhereBuilder pagequery(boolean pagequery)
```
    设置是否支持生成分页查询语句(如MySQL LIMIT ${row_count} OFFSET ${offset})
    
    参数:
    
    pagequery -
    
    返回:
    
    当前对象
  - getReferenceVariables
```
public java.util.Set<java.lang.String> getReferenceVariables()
```
  - getTargetClass
```
public java.lang.Class<? extends gu.sql2java.BaseRow> getTargetClass()
```
  - getVarTypes
```
public java.util.Map<java.lang.String,java.lang.Class<?>> getVarTypes()
```
  - getOrderByVarname
```
public java.lang.String getOrderByVarname()
```
    返回:
    
    orderByVarname
  - getGroupByVarname
```
public java.lang.String getGroupByVarname()
```
    返回:
    
    groupByVarname
  - getOrderByColumns
```
public java.lang.String getOrderByColumns()
```
    返回:
    
    orderByColumns
  - getGroupByColumns
```
public java.lang.String getGroupByColumns()
```
    返回:
    
    groupByColumns
  - exp
```
public BeanShellWhereBuilder exp(java.lang.String exp)
```
    生成一般表达式
    
    参数:
    
    exp -
    
    返回:
    
    当前对象
  - or
```
public BeanShellWhereBuilder or()
```
    指定与前一个表达式的连接方式为OR
    
    返回:
    
    当前对象
  - and
```
public BeanShellWhereBuilder and()
```
    指定与前一个表达式的连接方式为AND
    
    返回:
    
    当前对象
  - equal
```
public BeanShellWhereBuilder equal(java.lang.String field)
```
    创建一个等价表达式，如column_name = $<column_name>,
    如果column_name为null或空,则表达式为 column_name IS NULL
    如果column_name为集合,则为IN表达式 column_name IN (...)
    
    参数:
    
    field -
    
    返回:
    
    当前对象
  - equalNot
```
public BeanShellWhereBuilder equalNot(java.lang.String field)
```
    创建一个不等价表达式，如column_name != $<column_name>,
    如果column_name为null或空,则表达式为 column_name IS NOT NULL
    如果column_name为集合,则为IN表达式 column_name NOT IN (...)
    
    参数:
    
    field -
    
    返回:
    
    当前对象
  - equalIfNonEmpty
```
public BeanShellWhereBuilder equalIfNonEmpty(java.lang.String field,
                                             boolean not)
```
    参见equal(String),不之处在于如果column_name为null或空则忽略,不生成表达式
    
    参数:
    
    field -
    
    not - 为true执行不等价比较
    
    返回:
    
    当前对象
  - equalIfNonEmpty
```
public BeanShellWhereBuilder equalIfNonEmpty(java.lang.String field)
```
    参见equal(String),不之处在于如果column_name为null或空则忽略,不生成表达式
    
    参数:
    
    field -
    
    返回:
    
    当前对象
  - equalIf
```
public BeanShellWhereBuilder equalIf(java.lang.String test,
                                     java.lang.String field,
                                     boolean not)
```
    当满足test指定的条件时,创建一个等价表达式
    输入参数为null或空则忽略,不生成表达式
    
    参数:
    
    test - 判断条件
    
    field -
    
    not - 为true执行不等价比较
    
    返回:
    
    当前对象
    
    另请参阅:
    
    equal(String)
  - ifelse
```
public BeanShellWhereBuilder ifelse(java.lang.String test,
                                    java.lang.String doStatement,
                                    java.lang.String elseStatement)
```
    输入条件test为true则生成doStatement指定的表达式, 否则生成elseStatement指定的表达式,elseStatement为null时不生成表达式
    
    参数:
    
    test - 判断条件
    
    doStatement - 判断条件为真时的执行语句
    
    elseStatement - 判断条件为假时的执行语句,为null忽略
    
    返回:
    
    当前对象
  - onlyif
```
public BeanShellWhereBuilder onlyif(java.lang.String test,
                                    java.lang.String doStatement)
```
    同ifelse(String, String, String),只是没有elseStatement
    
    参数:
    
    test - 判断条件
    
    doStatement - 判断条件为真时的执行语句
    
    返回:
    
    当前对象
  - selectFrom
```
public BeanShellWhereBuilder selectFrom(java.lang.String selectFrom)
```
    指定SELECT .... FROM 语句,如果不指定，则只生成 WHERE ....部分语句
    
    参数:
    
    selectFrom - select 语句(不含 WHERE部分),为null忽略
    
    返回:
    
    当前对象
  - orderBy
```
public BeanShellWhereBuilder orderBy(java.lang.String columnName,
                                     boolean desc)
```
    指定ORDER BY 的字段名
    
    参数:
    
    columnName - order by 字段名
    
    desc - 排序方式,为true降序
    
    返回:
    
    当前对象
  - orderBy
```
public BeanShellWhereBuilder orderBy(java.lang.String columnName)
```
    指定ORDER BY 的字段名,格式要求 ${字段名}[ DESC|ASC]
    
    参数:
    
    columnName - order by 字段名,为null或空忽略
    
    返回:
    
    当前对象
  - orderByVar
```
public BeanShellWhereBuilder orderByVar(java.lang.String varName)
```
    指定ORDER BY 的字段变量名
    
    参数:
    
    varName - order by 字段字段名,为null或空忽略
    
    返回:
    
    当前对象
  - groupBy
```
public BeanShellWhereBuilder groupBy(java.lang.String... columnNames)
```
    指定GROUP BY 的字段名
    
    参数:
    
    columnNames - group by 字段名列表,为null忽略
    
    返回:
    
    当前对象
  - groupByVar
```
public BeanShellWhereBuilder groupByVar(java.lang.String varName)
```
    指定GROUP BY 的字段变量名
    
    参数:
    
    varName - group by 字段变量名,为null或空忽略
    
    返回:
    
    当前对象
  - from
```
public BeanShellWhereBuilder from(java.lang.annotation.Annotation[] annots)
```
    从注解中创建表达式
    
    参数:
    
    annots -
    
    返回:
    
    当前对象
  - build
```
public WhereHelper build()
```
    根据指定的条件生成WhereHelper实例
    
    返回:
    
    WhereHelper 实例

类 BeanShellWhereBuilder

字段概要

方法概要

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

字段详细资料

NOT_EQUAL

IGNORE_EMPTY

KEYWORD_COND_COUNT

KEYWORD_WHERE_BUFFER

KEYWORD_EXP_BUFFER

DT_MYSQL

方法详细资料

debuglog

debuglog

pagequery

getReferenceVariables

getTargetClass

getVarTypes

getOrderByVarname

getGroupByVarname

getOrderByColumns

getGroupByColumns

exp

or

and

equal

equalNot

equalIfNonEmpty

equalIfNonEmpty

equalIf

ifelse

onlyif

selectFrom

orderBy

orderBy

orderByVar

groupBy

groupByVar

from

build