de.hpi.isg.profiledb.store.model.Subject Maven / Gradle / Ivy

Go to download
package de.hpi.isg.profiledb.store.model;

import java.util.HashMap;
import java.util.Map;
import java.util.Objects;

/**
 * The subject of an {@link Experiment}, e.g., an application or algorithm.
 */
public class Subject {

    /**
     * Should identify the subject.
     */
    private String id;

    /**
     * The optional version of this subject.
     */
    private String version;

    /**
     * Configuration of this object.
     */
    private Map configuration = new HashMap<>();

    /**
     * Creates a new instance.
     *
     * @param id      should identify the new instance
     * @param version should distinguish versions among instances with the same {@code id}
     */
    public Subject(String id, String version) {
        this.id = id;
        this.version = version;
    }

    /**
     * Adds a configuration entry.
     *
     * @param key   the key of the configuration entry
     * @param value the value of the configuration entry; should be JSON-compatible, e.g. {@link Integer} or {@link String}
     * @return this instance
     */
    public Subject addConfiguration(String key, Object value) {
        this.configuration.put(key, value);
        return this;
    }

    @Override
    public String toString() {
        return String.format("%s[%s:%s]", this.getClass().getSimpleName(), this.id, this.version);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Subject subject = (Subject) o;
        return Objects.equals(id, subject.id) &&
                Objects.equals(version, subject.version) &&
                Objects.equals(configuration, subject.configuration);
    }

    @Override
    public int hashCode() {
        return Objects.hash(id, version, configuration);
    }
}