LookupTableEntry.java

/*
 * Made with all the love in the world
 * by scireum in Remshalden, Germany
 *
 * Copyright by scireum GmbH
 * http://www.scireum.de - info@scireum.de
 */

package sirius.biz.codelists;

import com.fasterxml.jackson.databind.node.ObjectNode;
import org.yaml.snakeyaml.DumperOptions;
import org.yaml.snakeyaml.Yaml;
import sirius.kernel.commons.Json;
import sirius.kernel.commons.Limit;
import sirius.kernel.commons.Strings;
import sirius.web.controller.AutocompleteHelper;

import javax.annotation.Nullable;

/**
 * Represents an entry within a {@link LookupTable}.
 * <p>
 * This is mainly used by {@link LookupTable#suggest(String)}, {@link LookupTable#search(String, Limit)} and
 * {@link LookupTable#scan(String, Limit)}.
 */
public class LookupTableEntry {

    private final String code;
    private final String name;
    private final String description;
    private boolean deprecated;
    private String source;

    /**
     * Creates a new entry.
     *
     * @param code        the code of the entry
     * @param name        the name of the entry
     * @param description a description of the entry
     */
    public LookupTableEntry(String code, String name, String description) {
        this.code = code;
        this.name = Strings.isEmpty(name) ? null : name;
        this.description = Strings.isEmpty(description) ? null : description;
    }

    protected LookupTableEntry markDeprecated() {
        this.deprecated = true;
        return this;
    }

    protected LookupTableEntry withSource(ObjectNode source) {
        DumperOptions options = new DumperOptions();
        options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK);
        options.setPrettyFlow(true);
        Yaml yaml = new Yaml(options);
        this.source = yaml.dump(Json.convertToMap(source));

        return this;
    }

    public String getCode() {
        return code;
    }

    @Nullable
    public String getName() {
        return name;
    }

    @Nullable
    public String getDescription() {
        return description;
    }

    public boolean isDeprecated() {
        return deprecated;
    }

    public String getSource() {
        return source;
    }

    @Override
    public String toString() {
        return code + " (" + name + ")";
    }

    /**
     * Transforms this entry into a completion to be supplied to a {@link AutocompleteHelper}.
     *
     * @param fieldDisplay      the  {@link sirius.biz.codelists.LookupValue.Display display mode} for the field label
     * @param completionDisplay the  {@link sirius.biz.codelists.LookupValue.Display display mode} for the completion label
     * @return the completion which represents this entry
     */
    public AutocompleteHelper.Completion toAutocompletion(LookupValue.Display fieldDisplay,
                                                          LookupValue.Display completionDisplay) {
        return AutocompleteHelper.suggest(code)
                                 .withFieldLabel(fieldDisplay.makeDisplayString(this))
                                 .withCompletionLabel(completionDisplay.makeDisplayString(this))
                                 .withCompletionDescription(description);
    }
}