de.svws_nrw.data.schule.DataSchuljahresabschnitte Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of svws-db-utils Show documentation
Diese Bibliothek unterstützt bei dem Zugriff auf Datenbanken für die Schulverwaltungssoftware in NRW
There is a newer version: 1.0.1
package de.svws_nrw.data.schule;

import java.io.InputStream;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Map;
import java.util.function.Function;
import java.util.stream.Collectors;

import de.svws_nrw.core.data.schule.Schuljahresabschnitt;
import de.svws_nrw.data.DataManager;
import de.svws_nrw.db.DBEntityManager;
import de.svws_nrw.db.dto.current.schild.schule.DTOSchuljahresabschnitte;
import de.svws_nrw.db.utils.ApiOperationException;
import jakarta.validation.constraints.NotNull;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.Response.Status;


/**
 * Diese Klasse erweitert den abstrakten {@link DataManager} für den
 * Core-DTO {@link Schuljahresabschnitt}.
 */
public final class DataSchuljahresabschnitte extends DataManager {

	/**
	 * Erstellt einen neuen {@link DataManager} für den Core-DTO {@link Schuljahresabschnitt}.
	 *
	 * @param conn   die Datenbank-Verbindung für den Datenbankzugriff
	 */
	public DataSchuljahresabschnitte(final DBEntityManager conn) {
		super(conn);
	}

	/**
	 * Lambda-Ausdruck zum Umwandeln eines Datenbank-DTOs {@link DTOSchuljahresabschnitte} in einen Core-DTO {@link Schuljahresabschnitt}.
	 */
	public static final Function dtoMapper = (final DTOSchuljahresabschnitte abschnitt) -> {
		final Schuljahresabschnitt daten = new Schuljahresabschnitt();
		daten.id = abschnitt.ID;
		daten.schuljahr = abschnitt.Jahr;
		daten.abschnitt = abschnitt.Abschnitt;
		daten.idVorigerAbschnitt = abschnitt.VorigerAbschnitt_ID;
		daten.idFolgeAbschnitt = abschnitt.FolgeAbschnitt_ID;
		return daten;
	};

	/**
	 * Lambda-Ausdruck zum Vergleichen/Sortieren der Core-DTOs {@link Schuljahresabschnitt}.
	 */
	private final Comparator dataComparator = (a, b) -> {
		final int tmp = Integer.compare(a.schuljahr, b.schuljahr);
		return (tmp == 0) ? Integer.compare(a.abschnitt, b.abschnitt) : tmp;
	};


	@Override
	public Response getAll() {
		return this.getList();
	}


	@Override
	public Response getList() {
		final List daten = this.getAbschnitte();
		return Response.status(Status.OK).type(MediaType.APPLICATION_JSON).entity(daten).build();
	}


	/**
	 * Gibt die Liste aller Datenbank-DTOs für die Schuljahresabschnitte zurück.
	 *
	 * @param conn   die Datenbank-Verbindung für den Zugriff auf die DTOs
	 *
	 * @return die Liste der Datenbank-DTOs für die Schuljahresabschnitte
	 */
	public static @NotNull List<@NotNull DTOSchuljahresabschnitte> getDTOList(final @NotNull DBEntityManager conn) {
		return conn.queryAll(DTOSchuljahresabschnitte.class);
	}


	/**
	 * Gibt die Map für das Mapping der IDs auf alle Datenbank-DTOs der Schuljahresabschnitte zurück.
	 *
	 * @param conn   die Datenbank-Verbindung für den Zugriff auf die DTOs
	 *
	 * @return die Map für das Mapping der IDs auf alle Datenbank-DTOs der Schuljahresabschnitte
	 */
	public static @NotNull Map<@NotNull Long, @NotNull DTOSchuljahresabschnitte> getDTOMap(final @NotNull DBEntityManager conn) {
		return conn.queryAll(DTOSchuljahresabschnitte.class).stream().collect(Collectors.toMap(k -> k.ID, k -> k));
	}


	/**
	 * Gibt alle Schuljahresabschnitte der Schule in einer sortierten Liste zurück.
	 *
	 * @return die Liste der Schuljahresabschnitt
	 */
	public List getAbschnitte() {
		// Schuljahresabschnitte aus den Leistungsdaten bestimmen
		final List abschnitte = conn.queryAll(DTOSchuljahresabschnitte.class);
		if ((abschnitte == null) || abschnitte.isEmpty())
			return new ArrayList<>();
		return abschnitte.stream().map(dtoMapper).sorted(dataComparator).toList();
	}

	/**
	 * Ermittelt den Schuljahresabschnitt für die angegebene ID. Existiert kein Schuljahresabschnitt, so
	 * wird null zurückgegeben.
	 *
	 * @param id     die ID des Schuljahresabschnitts
	 *
	 * @return der Schuljahresabschnitt
	 */
	public Schuljahresabschnitt getByID(final Long id) throws ApiOperationException {
		if (id == null)
			throw new ApiOperationException(Status.BAD_REQUEST, "Die ID des Schuljahresabschnittes darf nicht null sein.");

		final DTOSchuljahresabschnitte abschnitt = conn.queryByKey(DTOSchuljahresabschnitte.class, id);
		if (abschnitt == null)
			throw new ApiOperationException(Status.NOT_FOUND, "Der Schuljahresabschnitt mit der ID %d wurde nicht gefunden.".formatted(id));

		return dtoMapper.apply(abschnitt);
	}

	@Override
	public Response get(final Long id) throws ApiOperationException {
		final Schuljahresabschnitt daten = getByID(id);
		return Response.status(Status.OK).type(MediaType.APPLICATION_JSON).entity(daten).build();
	}

	@Override
	public Response patch(final Long id, final InputStream is) {
		throw new UnsupportedOperationException();
	}

	/**
	 * Ermittelt den Schuljahresabschnitt für das angegebene Schuljahr und den angegebenen Abschnitt,
	 * sofern dieses existiert.
	 *
	 * @param conn        die Datenbankverbindung
	 * @param schuljahr   das Schuljahr
	 * @param abschnitt   der Abschnitt
	 *
	 * @return der Schuljahresabschnitt oder null
	 */
	public static Schuljahresabschnitt getFromSchuljahrUndAbschnitt(final DBEntityManager conn, final int schuljahr, final int abschnitt) {
		final List liste = conn.queryList("SELECT e FROM DTOSchuljahresabschnitte e WHERE e.Jahr = ?1 AND e.Abschnitt = ?2",
				DTOSchuljahresabschnitte.class, schuljahr, abschnitt);
		if ((liste == null) || (liste.size() != 1))
			return null;
		return dtoMapper.apply(liste.get(0));
	}

}