模块 org.redkale

程序包 org.redkale.source

注释类型 FilterColumn

@Documented
@Target(FIELD)
@Retention(RUNTIME)
public @interface FilterColumn

过滤字段标记

详情见: https://redkale.org

作者:

zhangjx

另请参阅:

FilterBean

可选元素概要

可选元素

修饰符和类型	可选元素	说明
String	comment	已过时。
String	example	for OpenAPI Specification 3.1.0
FilterExpress	express	express的默认值根据字段类型的不同而不同: 数组 --> IN Range --> Between 其他 --> =
boolean	ignore	生成过滤条件时是否屏蔽该字段
long	least	当字段类型是Number时， 如果值>=least() 则需要过滤， 否则跳过该字段 当字段类型是String时， 如果字符串.length == 0 且 least() == 0 则需要过滤， 否则跳过该字段
String	name	对应Entity Class中字段的名称， 而不是SQL字段名称
boolean	required	判断字段是否必需，for OpenAPI Specification 3.1.0

元素详细资料

name

String name

对应Entity Class中字段的名称， 而不是SQL字段名称

返回:

字段名

默认值:

""

least

long least

当字段类型是Number时， 如果值>=least() 则需要过滤， 否则跳过该字段
当字段类型是String时， 如果字符串.length == 0 且 least() == 0 则需要过滤， 否则跳过该字段

返回:

最小可过滤值

默认值:

1L

ignore

boolean ignore

生成过滤条件时是否屏蔽该字段

返回:

是否屏蔽该字段

从以下版本开始:

2.4.0

默认值:

false

express

FilterExpress express

express的默认值根据字段类型的不同而不同:
数组 --> IN
Range --> Between
其他 --> =

返回:

字段表达式

默认值:

org.redkale.source.FilterExpress.EQ

required

boolean required

判断字段是否必需，for OpenAPI Specification 3.1.0

返回:

是否必需

默认值:

false

example

String example

for OpenAPI Specification 3.1.0

返回:

String

默认值:

""

comment

@Deprecated(since="2.8.0")
String comment

已过时。

备注描述

返回:

备注描述

另请参阅:

Comment

默认值:

""