org.redkale.source.FilterColumn Maven / Gradle / Ivy

/*
 * To change this license header, choose License Headers in Project Properties.
 * To change this template file, choose Tools | Templates
 * and open the template in the editor.
 */
package org.redkale.source;

import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.*;

/**
 * 过滤字段标记
 *
 * 
 * 详情见: https://redkale.org
 *
 * @author zhangjx
 */
@Inherited
@Documented
@Target({FIELD})
@Retention(RUNTIME)
public @interface FilterColumn {

    /**
     * 对应Entity Class中字段的名称， 而不是SQL字段名称
     *
     * @return 字段名
     */
    String name() default "";

    /**
     * 当字段类型是Number时， 如果值>=least() 则需要过滤， 否则跳过该字段
     *
     * @return 最小可过滤值
     */
    long least() default 1;

    /**
     * express的默认值根据字段类型的不同而不同:  

     * 数组 --> IN  

     * Range --> Between  

     * 其他 --> =  

     *
     * @return 字段表达式
     */
    FilterExpress express() default FilterExpress.EQUAL;

    /**
     * 当标记的字段类型是数组/Collection类型且express不是IN/NOTIN时，则构建过滤条件时会遍历字段值的元素来循环构建表达式，元素之间的关系是AND或OR由该值来确定
     *
     * @return 数组元素间的表达式是否AND关系
     */
    boolean itemand() default true;

    /**
     * 备注描述
     *
     * @return 备注描述
     */
    String comment() default "";

}