edu.kit.kastel.sdq.artemis4j.grading.model.RatingGroup Maven / Gradle / Ivy

Go to download

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

Artemis4J is a Java library for interacting with the Artemis teaching system.

There is a newer version: 7.5.6

/* Licensed under EPL-2.0 2022-2023. */
package edu.kit.kastel.sdq.artemis4j.grading.model;

import edu.kit.kastel.sdq.artemis4j.api.grading.IMistakeType;
import edu.kit.kastel.sdq.artemis4j.api.grading.IRatingGroup;
import edu.kit.kastel.sdq.artemis4j.util.Pair;

import com.fasterxml.jackson.annotation.JsonProperty;

import java.io.Serial;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Objects;

public class RatingGroup implements IRatingGroup, Serializable {

	@Serial
	private static final long serialVersionUID = 8116874549849287171L;

	@JsonProperty("shortName")
	private String identifier;
	@JsonProperty("displayName")
	private String displayName;

	/**
	 * Map of additional languages for the display name. Format of map: {@code {"en"
	 * -> "Name in English"}}
	 */
	@JsonProperty("additionalDisplayNames")
	private Map additionalDisplayNames;

	@JsonProperty
	private Double positiveLimit;
	@JsonProperty
	private Double negativeLimit;

	private final transient List mistakeTypes = new ArrayList<>();

	public RatingGroup() {
		// NOP
	}

	public void addMistakeType(MistakeType mistakeType) {
		this.mistakeTypes.add(mistakeType);
	}

	@Override
	public String getDisplayName(String languageKey) {
		if (languageKey == null || additionalDisplayNames == null || !additionalDisplayNames.containsKey(languageKey))
			return this.displayName;
		return additionalDisplayNames.get(languageKey);
	}

	@Override
	public List getMistakeTypes() {
		return this.mistakeTypes.stream().map(IMistakeType.class::cast).toList();
	}

	@Override
	public String getIdentifier() {
		return this.identifier;
	}

	@Override
	public Pair getRange() {
		return new Pair<>(this.negativeLimit, this.positiveLimit);
	}

	@Override
	public double setToRange(double points) {
		if (negativeLimit != null && points < negativeLimit) {
			return negativeLimit;
		}
		if (positiveLimit != null && points > positiveLimit) {
			return positiveLimit;
		}
		return points;
	}

	@Override
	public int hashCode() {
		return Objects.hash(identifier);
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null || getClass() != obj.getClass())
			return false;
		RatingGroup other = (RatingGroup) obj;
		return Objects.equals(identifier, other.identifier);
	}

}