namespace Dpz.Core.Entity.Base.ExpressTreeQuery;

/// <summary>
/// 定义查询过滤条件的枚举
/// 用于指定在生成表达式树时，如何验证和处理请求参数的值
/// </summary>
public enum FilterCondition
{
    /// <summary>
    /// 验证值不为 null
    /// 适用于所有可空类型
    /// </summary>
    NotNull,

    /// <summary>
    /// 验证字符串不为 null 且不为空字符串
    /// 仅适用于 <see cref="string"/> 类型
    /// 等同于  <![CDATA[value != null && value != ""]]>
    /// </summary>
    NotNullOrEmpty,

    /// <summary>
    /// 验证字符串不为 null 且不为空字符串且不为纯空白字符
    /// 仅适用于 <see cref="string"/> 类型
    /// 等同于 <![CDATA[value != null && value.Trim() != ""]]>
    /// </summary>
    NotNullOrWhiteSpace,

    /// <summary>
    /// 验证集合不为 null 且包含至少一个元素
    /// 适用于实现了 <see cref="System.Collections.ICollection"/> 接口的类型
    /// 等同于 <![CDATA[value != null && value.Count > 0]]>
    /// </summary>
    LeftAny,

    /// <summary>
    /// 验证数组不为 null 且包含至少一个元素
    /// 适用于 <see cref="System.Array"/> 类型
    /// 等同于 <![CDATA[value != null && value.Length > 0]]>
    /// </summary>
    RightAny,

    /// <summary>
    /// 验证值等于指定的比较值
    /// 适用于所有可比较的类型
    /// 等同于 <![CDATA[value == comparisonValue]]>
    /// </summary>
    EqualValue,

    /// <summary>
    /// 验证值不等于指定的比较值
    /// 适用于所有可比较的类型
    /// 等同于 <![CDATA[value != comparisonValue]]>
    /// </summary>
    NotEqualValue,

    /// <summary>
    /// 验证值大于指定的比较值
    /// 适用于实现了 IComparable 接口的类型
    /// 等同于 <![CDATA[value > comparisonValue]]>
    /// </summary>
    GtValue,

    /// <summary>
    /// 验证值小于指定的比较值
    /// 适用于实现了 IComparable 接口的类型
    /// 等同于 <![CDATA[value < comparisonValue]]>
    /// </summary>
    LtValue,

    /// <summary>
    /// 验证值大于或等于指定的比较值
    /// 适用于实现了 IComparable 接口的类型
    /// 等同于 <![CDATA[value >= comparisonValue]]>
    /// </summary>
    GtOrEqualValue,

    /// <summary>
    /// 验证值小于或等于指定的比较值
    /// 适用于实现了 IComparable 接口的类型
    /// 等同于 <![CDATA[value <= comparisonValue]]>
    /// </summary>
    LtOrEqualValue,
}