berlin.yuna.survey.model.HistoryItemBase Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of surveys Show documentation

Survey is a plain java library to provide a base for surveys / questionnaires. It also provides a function to generate diagrams and to measure answer times.

There is a newer version: 0.1.103

Show newest version

package berlin.yuna.survey.model;

import berlin.yuna.survey.model.types.FlowItem;

import java.time.LocalDateTime;
import java.util.Objects;

import static berlin.yuna.survey.logic.CommonUtils.getTime;

/**
 * The {@link HistoryItem} is used to keep track of all answers/transitions in the flow
 */
@SuppressWarnings({"unused", "UnusedReturnValue"})
public abstract class HistoryItemBase implements Comparable> {
    private String label;
    private T answer;
    private LocalDateTime createdAt;
    private State state = State.CURRENT;

    public HistoryItemBase() {
        this.createdAt = getTime();
    }

    public HistoryItemBase(final String label, final T answer, final State state) {
        this(label);
        this.answer = answer;
        this.state = state;
    }

    public HistoryItemBase(final String label) {
        this();
        this.label = label;
        this.answer = null;
        this.state = State.DRAFT;
    }

    protected HistoryItemBase(final String label, final T answer, final LocalDateTime createdAt, final State state) {
        this.label = label;
        this.answer = answer;
        this.createdAt = createdAt;
        this.state = state;
    }

    public HistoryItemBase setLabel(final String label) {
        this.label = label;
        return this;
    }

    public HistoryItemBase setAnswer(final T answer) {
        this.answer = answer;
        return this;
    }

    public HistoryItemBase setCreatedAt(final LocalDateTime createdAt) {
        this.createdAt = createdAt;
        return this;
    }

    public String getLabel() {
        return label;
    }

    public T getAnswer() {
        return answer;
    }

    public LocalDateTime getCreatedAt() {
        return createdAt;
    }

    public State getState() {
        return state;
    }

    public HistoryItemBase setState(final State state) {
        this.state = state;
        return this;
    }

    public boolean isNotDraft() {
        return !isDraft();
    }

    public boolean isDraft() {
        return state == State.DRAFT;
    }

    public boolean isNotCurrent() {
        return !isCurrent();
    }

    public boolean isCurrent() {
        return state == State.CURRENT;
    }

    public boolean isNotAnswered() {
        return !isAnswered();
    }

    public boolean isAnswered() {
        return answer != null;
    }

    public boolean match(final FlowItem question) {
        return question != null && question.label().equals(label);
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        final HistoryItemBase that = (HistoryItemBase) o;

        return Objects.equals(label, that.label);
    }

    @Override
    public int hashCode() {
        return label != null ? label.hashCode() : 0;
    }

    @Override
    public String toString() {
        return getClass().getSimpleName() + "{" +
                "label='" + label + '\'' +
                ", answer='" + answer + '\'' +
                ", createdAt=" + createdAt +
                ", state='" + state + '\'' +
                '}';
    }

    @Override
    public int compareTo(final HistoryItemBase o) {
        if (o.getCreatedAt() == null) {
            return 1;
        } else if (getCreatedAt() == null) {
            return -1;
        } else {
            return (o.getCreatedAt().compareTo(getCreatedAt()));
        }
    }

    public enum State {
        ANSWERED,
        CURRENT,
        DRAFT,
    }
}