com.houkunlin.system.dict.starter.bean.DictValueVo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of system-dict-starter Show documentation

系统数据字典自动翻译成字典文本。可集合系统数据库中存储的用户数据字典，也可使用枚举做系统数据字典，主要用在返回数据给前端时自动把字典值翻译成字典文本信息； The system data dictionary is automatically translated into dictionary text. The user data dictionary stored in the system database can be aggregated, and the enumeration can also be used as the system data dictionary. It is mainly used to automatically translate dictionary values into dictionary text information when returning data to the front end.

The newest version!

package com.houkunlin.system.dict.starter.bean;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.houkunlin.system.dict.starter.notice.RefreshDictTypeEvent;
import com.houkunlin.system.dict.starter.notice.RefreshDictValueEvent;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.SuperBuilder;

import java.io.Serializable;
import java.util.List;

/**
 * 字典值信息对象
 *
 * @author HouKunLin
 */
@SuppressWarnings("all")
@ApiModel("字典值信息")
@Schema(name = "字典值信息")
@Data
@SuperBuilder
@AllArgsConstructor
@NoArgsConstructor
public class DictValueVo implements Serializable {
    /**
     * 字典类型代码
     */
    @ApiModelProperty(value = "字典类型代码", hidden = true)
    @Schema(title = "字典类型代码", hidden = true)
    @JsonIgnore
    private String dictType;
    /**
     * 父级字典值，由父级字典值可以组成一个类似树形结构数据的字典信息。
     * 构建树形结构字典数据所需要的一个父级值；
     *
     * @since 1.4.6
     */
    @ApiModelProperty("父级字典值")
    @Schema(title = "父级字典值")
    private Object parentValue;
    /**
     * 字典值
     */
    @ApiModelProperty("字典值")
    @Schema(title = "字典值")
    private Object value;
    /**
     * 字典名称。
     * 在使用 {@link RefreshDictValueEvent} 事件时，此值为 null 意为删除这个字典值文本信息
     */
    @ApiModelProperty("字典名称")
    @Schema(title = "字典名称")
    private String title;
    /**
     * 数据字典值列表排序值（系统不会使用此字段进行排序和维护排序，需要前端根据此字段来自行排序展示）
     */
    @ApiModelProperty(value = "排序值", notes = "系统不会执行排序后再返回给前端，系统不会使用此字段进行排序和维护排序，需要前端根据此字段来自行排序展示")
    @Schema(title = "排序值", description = "系统不会执行排序后再返回给前端，系统不会使用此字段进行排序和维护排序，需要前端根据此字段来自行排序展示")
    private int sorted;
    /**
     * 是否禁用，禁用的字典文本不会从缓存中删除，因为禁用的字典文本可能在之前的数据中被使用。
     * 并且禁用的字典文本也不会从缓存的字典类型对象中删除，需要在调用 {@link RefreshDictTypeEvent} 时明确的把字典文本移除才能从字典类型缓存中删除。
     *
     * @since 1.4.9
     */
    @ApiModelProperty("是否禁用")
    @Schema(title = "是否禁用")
    private boolean disabled;
    /**
     * 子字典值列表
     *
     * @since 1.4.9
     */
    @ApiModelProperty("子字典值列表")
    @Schema(title = "子字典值列表")
    private List children;

    public DictValueVo(final String dictType, final Object value, final String title, final int sorted) {
        this.dictType = dictType;
        this.value = value;
        this.title = title;
        this.sorted = sorted;
    }

    public DictValueVo(final String dictType, final Object parentValue, final Object value, final String title, final int sorted) {
        this.dictType = dictType;
        this.parentValue = parentValue;
        this.value = value;
        this.title = title;
        this.sorted = sorted;
    }
}