...
Het doel van het SDD is om een gedetailleerde technische beschrijving te geven van het ontwerp van de ontwikkelde Klukkluk applicatie. Dit document bevat een schema van de databasestructuur, gepaard met diagrammen die de structuur van de Java-applicatie detailleren. Ook is dit document bedoeld voor toekomstige ontwikkelaars om een beeld te scheppen van de opbouw van de applicatie, en om gemaakte keuzes door de projectgroep toe te lichten.
Architectural Overview
<Provide a high level overview of the architectural design, for instance by means of an architectural sketch. Make sure you show at least all sub-systems, and links to external systems. The sketch can be informal. The use of UML is not required.>
Detailed Design Description
...
Klukkluk is ontwikkelt op windows 10 en 11, KDE plasma 6 onder fedora linux 40. Het is ook bedoelt om te draaien op MacOS Ventura en Ubuntu linux (22.04).
...
Package Diagram
Zie hier het gemaakte PDM. Samen met het PDM bestand in de bestandenlijst dat o.a. te openen is via Powerdesigner zou het duidelijkheid moeten brengen over hoe het systeem in elkaar staat.
Package Diagram
Voor de packages zijn een aantal Voor de packages zijn een aantal keuzes gemaakt. Als eerste is er per klasse type een package gemaakt. Voor de repository klassen is dus een repositories package gemaakt, en voor de mapper klassen is een mappers package gemaakt. In de app package zitten alle controllers, zoals te heeft deze een connectie met services en repositories. Normaal gesproken zouden de controllers via de service een connectie hebben met de repositories. Bij ons was dit in het begin ook het geval, maar in sommige service klassen zat eigenlijk totaal geen functionaliteit en riepen deze alleen de repository aan, dit vonden wij niet echt nuttig en daarom zijn er enkele repositories zonder services waardoor de app package een directe connectie met de service package moet hebben. Ook is er gekozen om een algemeen utils package te maken, hierin staan vooral wat losse klassen die niet echt bij een andere package passen. In de repositories package zit ook een utils package, dit is gedaan voor de EntityManagerFactory. De EntityManagerFactory hoort niet echt direct bij de repositories en daarom zit deze in een aparte package.
Design Class Diagrams
App package
In de App package zitten vooral de main klassen van de applicatie zoals de MainWrapper en de Controller klassen. Om de applicatie te starten moet de main methode van de MainWrapper klasse aangroepen worden. In de Controller klassen staat alle code waarmee de front-end geregeld wordt. Voor elk scherm in de applicatie is een aparte controller gemaakt die communiceert met het front-end bestand. Op deze manier is de code van elke scherm gescheiden van elkaar.
DTO package
De methodes die in de classes klassen zitten van de DTO package zijn niet opgenomen in het bovenstaande diagram. Dit is niet opgenomen aangezien dit alleen maar getters en setters zijn en voor de rest geen lastige methodes bevatten. De DTO's zijn de Data Transfer Objects en bestaan om de data vanuit de database over te dragen naar de applicatie. De getters en setters zijn dus nodig om de variabelen binnen de classes klassen te vullen zodat deze data gebonden kan worden aan deze classesklassen.
Entities
De Entity klassen zijn eigenlijk een soort representatie van de database. De attributen van de entity klassen moeten overeen komen met de kolommen uit de database. De repositories gebruiken deze entities om data uit de database op te halen en daarom zijn deze entities dus gemaakt. Door entities samen met JPA te gebruiken kan er makkelijker gewisseld worden tussen database systemen omdat de JPA taal zelf regelt met welk database systeem gecommuniceert wordt.
Exceptions
In dit class diagram staan de exceptions die binnen het systeem gebruikt worden. De DatabaseException wordt gebruikt voor foutmeldingen die omhoogkomen bij het gebruik van de database. Naast de DatabaseException is er ook nog een ResourceException en een UserInputException. De ResourceException is net zoals de DatabaseException een RuntimeException en handelt foutmeldingen af die ontstaan door ontbrekende data. Stel dat er bijvoorbeeld een FXML bestand mist binnen de applicatie moet er wel een manier zijn om deze error op te vangen. Hierbij wordt dan dus de ResourceException gebruikt. Als laatste is er ook nog een UserInputException. Deze exception wordt gebruikt voor foutmeldingen die te maken hebben met de input die de gebruiker van de applicatie (onbedoeld) creëert. Stel dat de gebruiker een fout maakt met het invoeren van een rating, bijvoorbeeld dat deze per ongeluk wat letters invoert waar die niet de bedoeling is, dan wordt er met de UserInputException gewerkt om deze error af te handelen.
Mappers
De mappers zijn verschillende classes klassen die inkomende objecten omzetten naar een ander type object. Neem bijvoorbeeld de CompetitionTypeManger, deze class heeft een methode genaamd setCompetitionType die een entity ontvangt en een CompetitionTypeDTO teruggeeft. Een entity is informatie direct uit de database, een DTO bevat informatie die nog naar de database moet gaan. Om deze informatie te manipuleren wordt een entity dus eerst naar een DTO omgezet zodat er binnen de applicatie mee kan worden gewerkt. Vervolgens kan dit dan weer in de database worden gezet. Om dit zo te laten werken moet er dus wel een mogelijkheid zijn om de entities om te zetten naar DTO's. Daar zijn deze classes klassen dus voor.
Repositories
De repository functies beheren alle queries die uitgevoerd moeten worden op de database. Geen van de andere klassen kunnen direct op de database queries uitvoeren. Deze klassen kunnen gebruik maken van de methodes binnen de repository klassen om deze taken uit te voeren. De klassen kunnen ook de foutmeldingen van de database afhandelen door de exceptions te gebruiken uit de exceptions package binnen ons systeem. Dit zou dan de DatabaseException zijn.
Services
De services zijn de connectie tussen de controllers en de repositories ofwel de database. Deze laag zit er tussen om bijvoorbeeld te valideren of de data wel klopt.
Utils
In de Utils package staan verschillende soorten klassen. Er is bijvoorbeeld voor gekozen om hier de RatingCalculator klasse in te zetten omdat deze niet echt bij een andere package past. De RatingCalculator is gemaakt op basis van het sequence diagram van hoofdstuk 3.5.3. Omdat het maken van de indeling voor een toernooi gebruik maakt van een aparte java applicatie moesten er een aantal klassen gemaakt worden om tussen de twee systemen te kunnen communiceren. De gemaakte communicatie klassen zijn hierdoor opgenomen in de "Swiss" package binnen de utils.
...
In dit diagram word uitgelegd hoe het uploaden van de verschillende tabellen zit. Wanneer de gebruiker op de upload knop drukt wordt de pageservice aangeroepen met de geselecteerde competitie. De pageservice roept de methodes aan die horen bij het competitietypen. Deze methodes geven html files terug. Aan het einde wordt ook nog de globale ranglijst gemaakt aangezien dit voor alle typen gemaakt moet worden. Daarna worden de files geupload met behulp van de htmlservice.
Activity and State Diagrams
Database Design
Zie hier het gemaakte PDM. Samen met het PDM bestand in de bestandenlijst dat o.a. te openen is via Powerdesigner zou het duidelijkheid moeten brengen over hoe het systeem in elkaar staat.<This section is optional. If useful, provide activity and/or state diagrams to describe complex work flows and system state transitions>
Design decisions for the sub-systems
...
Voor het indelingsysteem is er gekozen om gebruik te maken van een strategy pattern. De meegevoerde data en verwachte resultaten zijn immers hetzelfde, maar de manier waarop de indelingen gemaakt worden verschilt. Er is dus voor gekozen om een strategy te maken die voor nu drie implementaties heeft: Toernooi, Periodecompetities en Meerkamp. Door gebruik te maken van het strategy pattern zouden er in de toekomst nieuwe indelingssysytemen kunnen worden toegevoegd, zonder dat de backend veranderd hoeft te worden.
...
Binnen de applicatie is gebruik gemaakt van layered architecture, waarbij we ervoor hebben gekozen om het project in te delen in de packages die in het eerder getoonde package diagram te zien zijn. De packages zijn opgesplitst op basis van functionaliteit, waarbij de controller-klassen bijvoorbeeld bij elkaar in het app-package staan en de repositories in het repository-package. Op deze manier vonden wij het als projectgroep makkelijk om binnen het project de juiste klassen terug te vinden, en is het duidelijk waar nieuwe klassen zouden worden toegevoegd.
MVC pattern
TODO
USECASE 9 - Gegevens publiceren op website
...
Voor het uitprinten publiceren van de rondes hebben wij besloten het op een eigen pagina te zetten. Vanuit deze pagina moet er worden geselecteerd voor welke CompetitieDTO de rondes uit moeten worden geprint via een dropdown. Met de getCompetitions functie binnen MatchRepository worden de CompetitionDTO's opgehaald. Met de gekozen Competitie kunnen de rondes opgehaald worden die dan in de volgende dropdown kunnen worden gezet met hun rondenummers. Via de getMatchesByRoundId functie worden alle individuele matches opgehaald waardoor alle informatie voor het uitprinten van de indeling er is.gegevens hebben wij gekozen om de tabellen die rokade maakt na te maken zover als dit mogelijk is. Aangezien niet elke competitietype dezelfde tabellen vereist hebben wij ervoor gezorgd dat alleen de tabellen aangemaakt worden die nodig zijn voor het geselecteerde type. Dit hebben we gedaan door gebruik te maken van een switch functie. Wanneer je een competitie meegeeft aan de publicatie service kiest deze service de goede tabellen. Daarnaast word de globale ranglijst altijd aangemaakt aangezien deze iedere keer geüpdatet moet worden wanneer er nieuwe wedstrijden zijn gespeeld.
USECASE 10 - Printen ronde indeling
Voor het uitprinten van de rondes hebben wij besloten het op een eigen pagina te zetten. Op deze pagina kan er voor twee werkwijzen gekozen worden. Er kan namelijk per competitie en per ronde een PDF gegenereerd worden of per datum.
Per datum
Als er voor de datum optie gekozen wordt, wordt de datum meegegeven aan de generateMatchesPerDatePDF methode. Deze methode is beschikbaar door de instantie van de PDFService die de methodes bevat voor alles wat met het genereren van de PDF te maken heeft. Aan de methode moeten ook nog het pad waar het bestand opgeslagen gaat worden (pdfPath) en de datum die geselecteerd is door de gebruiker (datePicker) meegegeven worden. In de PDFService worden vervolgens binnen de generateMatchesPerDatePDF methode alle competities (competitions) en competitiegroepen opgehaald (competitionGroups). Om namelijk alle data van een dag op te halen moet dit wel gedaan worden per competitie. De wedstrijden worden zo dus per ronde, per groep en per competitie opgehaald. Dit is een stuk duidelijker dan alle data door elkaar te hebben binnen de PDF. Vervolgens worden de rondes gecontroleerd om te kijken of deze ook wel echt op de ingevoerde datum gehouden worden. Zodra de wedstrijden per group en per competitie opgehaald zijn wordt de naam van het document gegenereerd aangezien deze naam de eerder genoemde informatie nodig heeft. Voor het maken van de naam in de methode generatePDFName wordt de huidige tijd opgehaald om altijd een unieke bestandsnaam te hebben. Als deze namelijk niet uniek is wordt het vorige bestand met die naam overschreven. Vervolgens wordt er gecontroleerd of er daadwerkelijk wedstrijden zijn op de datum die ingevuld is en als dit zo is wordt er een PDF opgesteld met de drawPDF methode. Stel dat er geen rondes op de ingevoerde dag of competitiegroepen of wedstrijden zijn wordt er een melding in het scherm gebracht met een foutmelding. De drawPDF methode wordt dan ook niet aangeroepen. Iedere keer dat de drawPDF methode aangeroepen wordt telt de pdfCounter 1 bij zichzelf op. Dit is later belangrijk voor het weergeven van het aantal gegenereerde PDF's. Anders is het namelijk nogal onduidelijk of er überhaupt wel PDF's gegenereerd zijn. In de drawPDF methode wordt er met iText een PDF gegenereerd met de wedstrijddata van de eerder ingevoerde dag. Als het bestand niet aangemaakt kan worden wordt er een exceptie gegooid die aangeeft dat er geen bestand aangemaakt kan worden.
Per competitie en ronde
Als er voor de optie wordt gekozen om de PDF te genereren per competitie en ronde wordt er voor iedere keer dat de combobox die alle competities bevat (competitionSelector) geopend en gesloten word een if statement uitgevoerd om te kijken of er een competitie is geselecteerd is of niet. Als er geen een geselecteerd is wordt automatisch de eerste optie uit de lijst gekozen. Dit is gedaan om errors te voorkomen die te maken hebben met het ophalen van de rondes. Als er namelijk geen competitie is opgehaald in de combobox is deze null. Er bestaan natuurlijk geen rondes voor een competitie die null is dus wordt er een error gegooid. Ook wordt voor dezelfde reden eerst de ronde selectie combobox (roundSelector) button uitgezet. Deze wordt aangezet als er een competitie geselecteerd is. Als de competitie geselecteerd is worden alle rondes die binnen de competitie vallen opgehaald en in de combobox neergezet. Ook worden dubbele waardes eruit gefilterd, want dit was een bug die omhoog kwam tijdens het maken van de code. Iedere keer dat dit alles gebeurd wordt eerst de ronde combobox leeggegooid zodat er geen rondes van een andere competitie in het veld blijven staan. Als alle velden ingevuld zijn en er een pad gekozen is waar het bestand opgeslagen gaat worden veranderd de button voor het genereren van de PDF van onklikbaar naar klikbaar. Vervolgens wordt er een PDF gegenereerd met deze informatie. Vanuit de CompetitionDTO kan de CompetitionNaam worden gehaald, de datum van de ronde uit RondeDTO en de wit en zwartspeler namen uit MatchDTO.
Overig
JaVaFo
Voor het genereren van een competitionlayout van een toernooi is een extern programma gebruikt, omdat het genereren van een zwitserse indeling wellicht te foutgevoelig zou zijn als het geprogrammeerd werd door iemand die niet volledig thuis is in het domein. JaVaFo, gemaakt door Roberto Ricca, is een in Java geprogrammeerde matchmaking software. Het heeft als input een document nodig dat specifiek is aan de schaakorganisatie Fide (.trf). Om dit te genereren zijn er een aantal classes klassen aangemaakt om dit te regelen. "DocumentMaker" kan met wat speciale DTOs waar de data in is opgeslagen een string genereren waarmee JaVaFo een indeling kan maken. "JaVaFoDocuPlayer" en "JaVaFoDocuResult" zijn DTO's om de data van spelers en ronderesultaten op te slaan. JaVaFo maakt van de input van DocumentMaker een output string die vervolgens vertaald kan worden naar match DTO's.
...