Range (sql2java pagehelper 5.5.0-patch2 API)

@Retention(value=RUNTIME)
 @Target(value={METHOD,TYPE})
 @Documented
 @Repeatable(value=Ranges.class)
public @interface Range

WhereHelper 数值范围算述比较表达式注解

从以下版本开始:: 3.25.0
作者:: guyadong

必需元素概要

所需元素
限定符和类型	必需的元素和说明
`java.lang.String`	`field` 执行范围算术比较的(数据库)字段名
`boolean`	`quote` 为`true`生成表达式对数值以字符串对象头尾增加单引号

可选元素概要

限定符和类型可选元素和说明

boolean[]

checkFieldEmpty

是否对field()指定的变量执行判断空检查,此参数对于类型为String的参数有影响

值	说明 `true` `field()`指定的变量执行判断空检查 `false`只需要判断是否为`null` 空使用`quote()`的值
`boolean`	`lowerRefValue` 为`true`生成SQL表达式对`lowerVar()`视为变量名,否则视为常量
`java.lang.String`	`lowerSuffix` 左侧范围(较小值)变量名后缀,参见`lowerVar()`
`java.lang.String`	`lowerVar` 左侧范围(较小值)变量名,为空时如果`lowerSuffix()`不为空使用默认值:`field+lowerVarSuffix`,否则忽略
`RangeType`	`rangeType` 数值范围类型
`java.lang.String`	`test` test表达式执行为true时生成的数值范围比较表达式
`java.lang.String[]`	`testEmptyVars` 要求为`null`或空的变量名列表,['var1','var2'],等价于'isEmpty(${var1}) && isEmpty(${var2})',为空则默认为'true'
`java.lang.String[]`	`testFalseVars` 要求为`false`的变量名列表,['var1','var2'],等价于'isFalse(${var1}) && isFalse(${var2})',为空则默认为'true'
`java.lang.String[]`	`testNoEmptyVars` 要求不为`null`或空的变量名列表,['var1','var2'],等价于!'
`java.lang.String[]`	`testNonullVars` 要求不为null的变量名列表,['var1','var2'],等价于'null!
`java.lang.String[]`	`testNullVars` 要求为null的变量名列表,['var1','var2'],等价于'null==${var1} && null==${var2}',为空则默认为'true'
`CompareOp`	`testOp` 条件测试操作符
`boolean`	`testQuote` 为`true`生成表达式对`testValue()` 以字符串对头尾增加单引号, `testRefValue()`为`true`时忽略
`boolean`	`testRefValue` 为`true`生成表达式对`testValue()` 视为变量名
`java.lang.String[]`	`testTrueVars` 要求为`true`的变量名列表,['var1','var2'],等价于'isTrue(${var1)} && isTrue(${var2})',为空则默认为'true'
`VarTestType`	`testType` 变量测试类型
`java.lang.String`	`testValue` 变量条件测试的目标值
`java.lang.String`	`testVar` 定义基于`testType()`的条件测试表达式变量名
`boolean`	`upperRefValue` 为`true`生成SQL表达式对`upperVar()` 视为变量名,否则视为常量
`java.lang.String`	`upperSuffix` 右侧范围(较大值)变量名后缀,参见`lowerVar()`
`java.lang.String`	`upperVar` 右侧范围(较大值)变量名,为空时如果`upperSuffix()`不为空使用默认值:`field+upperVarSuffix`,否则忽略

- 元素详细资料
  - field
```
public abstract java.lang.String field
```
    执行范围算术比较的(数据库)字段名
- - quote
```
public abstract boolean quote
```
    为true生成表达式对数值以字符串对象头尾增加单引号
- - test
```
public abstract java.lang.String test
```
    test表达式执行为true时生成的数值范围比较表达式
    
    默认值:
    
    "true"
- - testNullVars
```
public abstract java.lang.String[] testNullVars
```
    要求为null的变量名列表,['var1','var2'],等价于'null==${var1} && null==${var2}',为空则默认为'true'
    
    默认值:
    
    {}
- - testNonullVars
```
public abstract java.lang.String[] testNonullVars
```
    要求不为null的变量名列表,['var1','var2'],等价于'null!=${var1} && null!=${var2}',为空则默认为'true'
    
    默认值:
    
    {}
- - testEmptyVars
```
public abstract java.lang.String[] testEmptyVars
```
    要求为null或空的变量名列表,['var1','var2'],等价于'isEmpty(${var1}) && isEmpty(${var2})',为空则默认为'true'
    
    默认值:
    
    {}
- - testNoEmptyVars
```
public abstract java.lang.String[] testNoEmptyVars
```
    要求不为null或空的变量名列表,['var1','var2'],等价于!'isEmpty(${var1}) && !isEmpty(${var2})',为空则默认为'true'
    
    默认值:
    
    {}
- - testTrueVars
```
public abstract java.lang.String[] testTrueVars
```
    要求为true的变量名列表,['var1','var2'],等价于'isTrue(${var1)} && isTrue(${var2})',为空则默认为'true'
    
    默认值:
    
    {}
- - testFalseVars
```
public abstract java.lang.String[] testFalseVars
```
    要求为false的变量名列表,['var1','var2'],等价于'isFalse(${var1}) && isFalse(${var2})',为空则默认为'true'
    
    默认值:
    
    {}
- - testVar
```
public abstract java.lang.String testVar
```
    定义基于testType()的条件测试表达式变量名
    
    默认值:
    
    ""
- - testType
```
public abstract VarTestType testType
```
    变量测试类型
    
    默认值:
    
    gu.sql2java.wherehelper.VarTestType.EQUAL
- - testOp
```
public abstract CompareOp testOp
```
    条件测试操作符
    
    默认值:
    
    gu.sql2java.wherehelper.CompareOp.EQ
- - testValue
```
public abstract java.lang.String testValue
```
    变量条件测试的目标值
    
    默认值:
    
    ""
- - testQuote
```
public abstract boolean testQuote
```
    为true生成表达式对testValue() 以字符串对头尾增加单引号, testRefValue()为true时忽略
    
    从以下版本开始:
    
    3.25.0
    
    默认值:
    
    false
- - testRefValue
```
public abstract boolean testRefValue
```
    为true生成表达式对testValue() 视为变量名
    
    默认值:
    
    false
- - lowerVar
```
public abstract java.lang.String lowerVar
```
    左侧范围(较小值)变量名,为空时如果lowerSuffix()不为空使用默认值:field+lowerVarSuffix,否则忽略
    
    默认值:
    
    ""
- - lowerSuffix
```
public abstract java.lang.String lowerSuffix
```
    左侧范围(较小值)变量名后缀,参见lowerVar()
    
    默认值:
    
    "_min"
- - lowerRefValue
```
public abstract boolean lowerRefValue
```
    为true生成SQL表达式对lowerVar()视为变量名,否则视为常量
    
    默认值:
    
    true
- - upperVar
```
public abstract java.lang.String upperVar
```
    右侧范围(较大值)变量名,为空时如果upperSuffix()不为空使用默认值:field+upperVarSuffix,否则忽略
    
    默认值:
    
    ""
- - upperSuffix
```
public abstract java.lang.String upperSuffix
```
    右侧范围(较大值)变量名后缀,参见lowerVar()
    
    默认值:
    
    "_max"
- - upperRefValue
```
public abstract boolean upperRefValue
```
    为true生成SQL表达式对upperVar() 视为变量名,否则视为常量
    
    默认值:
    
    true
- - rangeType
```
public abstract RangeType rangeType
```
    数值范围类型
    
    默认值:
    
    gu.sql2java.wherehelper.RangeType.OPENCLOSE
- - checkFieldEmpty
```
public abstract boolean[] checkFieldEmpty
```
    是否对field()指定的变量执行判断空检查,此参数对于类型为String的参数有影响
    
    值说明
    
    true field()指定的变量执行判断空检查
    
    false 只需要判断是否为null
    
    空使用quote()的值
    
    默认值:
    
    {}

跳过导航链接

所有类

概要:
字段 |
必需 |
可选

详细资料:
字段 |
元素

注释类型 Range

必需元素概要

可选元素概要

元素详细资料

field

quote

test

testNullVars

testNonullVars

testEmptyVars

testNoEmptyVars

testTrueVars

testFalseVars

testVar

testType

testOp

testValue

testQuote

testRefValue

lowerVar

lowerSuffix

lowerRefValue

upperVar

upperSuffix

upperRefValue

rangeType

checkFieldEmpty