Introduction

Overall Description

Zie 1.1. Algemene beschrijving van het SRS.

Purpose of this document

In dit document worden ontwerpbeslissingen beargumenteerd en wordt laten zien hoe het systeem in elkaar zit. Onze applicatie bestaat alleen uit java code en dit is dus ook het enige systeem dat uitgewerkt zal worden. 

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

Deployment Diagram

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.

Package Diagram

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 controlers, 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 roepte het alleen de repository aan, dit vonden wij niet echt nutting 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 algemene 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. DeEntityManagerFactory 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 bestandje. Op deze manier is de code van elke scherm gescheiden van elkaar.

DTO package

De methodes die in de classes 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 te vullen zodat deze data gebonden kan worden aan deze classes. 

 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 geswitcht 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, zo kan het zijn dat hij bijvoorbeeld per ongeluk wat letters invoert, wordt er met de UserInputException gewerkt om deze error af te handelen. 

Mappers

De mappers zijn verschillende classes 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 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.

Sequence Diagrams

SD UC1.2 createPlayer

SD UC2.1 createCompetition

CalculateNewRating

Voor het berekenen van de score heb je drie waarden nodig: rating1, rating2 en de score van rating1. De functie berekent altijd de score voor rating1. Als eerste wordt een expected score berekend, dit is een getal tussen 0 en 1. Met de rating, K-factor, score en expected score wordt de nieuwe rating berekend.

Dit systeem is gemaakt op basis van informatie uit de wikipedia pagina van een "Elo rating system": (Hoofdstuk Mathematical_details). Het gebruikte systeem wordt bij de FIDE (International Chess Federation) ook gebruikt. 

Activity and State Diagrams

<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

Usecases

USECASE 1 - Beheren van spelers

Op het scherm voor het beheren van de spelers is gekozen voor een tabel waarin alle informatie over spelers staat, met daarboven een aantal invulvelden en knoppen waarmee de data bewerkt kan worden. Dit is volgens de projectgroep de meest overzichtelijke manier om een grote lijst met spelers snel en eenvoudig te beheren. Indien nodig kan de tabel namelijk per kolom gesorteerd worden, waardoor het vinden van specifieke spelers gestroomlijnd kan verlopen. Het verwijderen van spelers en het vastleggen van de startrating zijn belangrijke handelingen, en zijn daardoor voorzien van een pop-up die om bevestiging van de actie vraagt, zodat bijvoorbeeld een speler niet per ongeluk uit de database verwijderd kan worden.

Voor deze implementatie wordt gebruikgemaakt van een servicelaag die de inputs van de gebruiker controleert op een aantal afgestelde regels, bijvoorbeeld of alle velden vereiste velden zijn ingevuld bij het invoeren van een nieuw lid of gast.

USECASE 2 - Beheren van competities

Het beheren van een competitie werkt in essentie hetzelfde als het beheren van spelers, maar een competitie heeft meer opties die de gebruiker moet kunnen bewerken, en deze opties hoeven niet in de tabel zichtbaar te zijn. Er is voor gekozen om alle instellingen voor een competitie in een kolom naast de tabel met competities te zetten. Ook is ervoor gekozen om op basis van welke soort competitie wordt gekozen bepaalde waarden automatisch in te vullen met een standaardwaarde. Dit allemaal om het gebruiken van de applicatie zo gestroomlijnd en gemakkelijk mogelijk te maken.

Ondanks dat er geen gebruik van wordt gemaakt is er ook voor gekozen om het aantal punten dat kan worden verdiend met een winst, verlies, gelijkspel etc. aanpasbaar te maken. Dit maakt Klukkluk flexibel mocht deze functionaliteit later gewenst zijn.

Ook deze usecase maakt gebruik van een servicelaag om de inputs van de gebruiker te controleren.

USECASE 3 & 4 - Beheren van competitiegroepen & Beheren van spelers in competitiegroep

Het scherm voor het beheren van competitiegroepen bevat veel informatie. Hierom is ervoor gekozen om de data weer te geven in een drietal tabellen, waarbij er onderscheid gemaakt wordt tussen de spelers die niet in een groep zitten, de groepen van de competitie, en de spelers die in de geselecteerde groep zitten. Op deze manier heeft de gebruiker overzicht over in welke groep deze bezig is, welke spelers hierin zitten en welke niet.

Als een competitie wordt aangemaakt worden aan de hand van het op het competitiescherm gekozen aantal, een aantal groepen automatisch aangemaakt, gelabeld "A, B, C" enzovoort.

Er is voor deze implementatie geen servicelaag aanwezig, er is namelijk bij het aanmaken van de groepen geen data aanwezig die de gebruiker op dit scherm aan kan passen. Het enige wat de gebruiker aan kan passen is de naam van de gegenereerde groepen.

USECASE 6 - Ronde resultaat invoeren

Bij het invoeren van ronde resultaten is gekozen om een scherm te maken waar je op basis van een groep de ronden en wedstrijden kunt zien, zodat duidelijk is waar een wedstrijd bij hoort. Voor het invoeren van resultaten zijn er keyboard shortcuts gemaakt voor Winst, Verlies en Gelijk, deze knoppen kun je activeren door op F1, F2 of F3 te drukken. Dit maakt het makkelijker voor de gebruiker om resultaten in te voeren, omdat er niet steeds op een knop gedrukt hoeft te worden. In de tabel is ook nog een systeem gemaakt waarmee de geselecteerde rij automatisch één naar beneden springt nadat er een resultaat ingevoert wordt, hierdoor hoef je dus niet steeds opnieuw op een tabel rij te drukken om een resultaat in te voeren.

USECASE 7 - Resultaat externe ronde invoeren

Het invoeren van resultaten bij extern gespeelde rondes werkt op basis van de rating van de externe speler. De gebruiker kan een searchable combobox (drop-down menu) gebruiken om de juiste speler uit de database te selecteren, waarna er in een invulveld de rating van de externe speler ingevuld kan worden. Daarna kan de uitslag van de match uit een drop-down menu gekozen worden.

Het aanpassen van de rating van een speler is een belangrijke actie, daarom wordt er zodra de gebruiker op "opslaan" drukt een pop-up weergegeven met de vraag of de aanpassing bevestigt moet worden. Op deze pop-up wordt ook de nieuwe rating van de speler al getoond. De pop-up wordt gebruikt om te voorkomen dat de gebruiker per ongeluk de rating van de interne speler updatet wanneer dit niet de bedoeling is.

Er is gekozen voor een searchable combobox omdat deze in het geval van deze usecase voldoende informatie kan tonen, en het zoeken van enkele spelers eenvoudiger maakt dan een gehele tabel door moeten spitten.

USECASE 8 - Indeling genereren voor competitie

Het genereren van indelingen gaat op basis van vooraf gedefiniëerde systemen. Dit betekent dat de gebruiker, nadat deze groepen heeft gemaakt, alleen maar aan Klukkluk hoeft aan te geven dat deze indelingen wil laten genereren. De applicatie zal hierna op basis van het competitietype en de geselecteerde manier van indelen (relevant bij Heller-tabellen, waarbij er verschillende varianten zijn) de spelers in de groepen automatisch in rondes indelen.

Meerkamp

Het indelingssysteem voor Meerkamp maakt gebruik van een ideling op basis van de tabellenstructuur zoals beschreven in het door ons verrichtte onderzoek. Om deze indelingen te generen worden de spelers in zowel een lijst voor witte als zwarte spelers ingedeeld. Daarna worden deze lijsten gehusseld en wordt er daarna per ronde voor de matches een indeling gemaakt op basis van deze twee lijsten. Elke gemaakte matchup wordt tijdelijk opgeslagen om te voorkomen dat dezelfde indeling twee keer voorkomt.

Indien een groep een oneven aantal spelers heeft wordt degene die overblijft ingedeeld tegenover een niet-ingevulde zwarte speler en wordt de match oneven verklaard. Nog steeds word ernaar gekeken dat elke speler tegen elkaar speelt.

Periodecompetitie

tekst

Toernooi

tekst

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 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.

Bij het maken van de inputstring is de spacing van alle waardes erg belangrijk, waarvoor "inflate" functies zijn gemaakt. Deze functies voegen white space (' ') tekens toe, tot de input string gelijk is aan de lengte die voor dat stuk nodig is. Bij nummers wordt inflate left gebruikt (want 0-9 moeten op de meest rechtse plaats staan, en moeten naar links uitbreiden) en bij letters wordt inflate right gebruikt (want het eerste teken moet zo links mogelijk staan en naar rechts uitbreiden).