From ba685f92a3bb0167f6ccaa87557d0ab4918ea6e3 Mon Sep 17 00:00:00 2001
From: Matisse DEKEISER <matisse.dekeiser.etu@univ-lille.fr>
Date: Fri, 29 Nov 2024 15:53:21 +0100
Subject: [PATCH] Javadoc view et autres (v1)
---
.../sae/classification/ClassificationApp.java | 4 ++--
.../fr/univlille/sae/classification/Main.java | 2 +-
.../sae/classification/utils/Observable.java | 13 ++++++++---
.../sae/classification/utils/Observer.java | 6 ++---
.../sae/classification/utils/ViewUtil.java | 15 ++++++------
.../sae/classification/view/AddDataView.java | 17 +++++++++++---
.../classification/view/AxesSettingsView.java | 17 +++++++++++---
.../view/ChooseAttributesView.java | 23 +++++++++++++------
8 files changed, 68 insertions(+), 29 deletions(-)
diff --git a/src/main/java/fr/univlille/sae/classification/ClassificationApp.java b/src/main/java/fr/univlille/sae/classification/ClassificationApp.java
index c3c9cd7..1cdf30c 100644
--- a/src/main/java/fr/univlille/sae/classification/ClassificationApp.java
+++ b/src/main/java/fr/univlille/sae/classification/ClassificationApp.java
@@ -18,7 +18,7 @@ public class ClassificationApp extends Application {
* Point d'entrée principal pour l'initialisation de l'interface utilisateur.
* Cette méthode configure la vue principale en utilisant une instance du modèle
* de classification, puis affiche la fenêtre principale.
- * @param stage la fenêtre principale de l'application.
+ * @param stage La fenêtre principale de l'application.
*/
public void start(Stage stage) throws IOException {
ClassificationModel model = ClassificationModel.getClassificationModel();
@@ -30,7 +30,7 @@ public class ClassificationApp extends Application {
/**
* Point d'entrée principal de l'application.
* Cette méthode lance l'application JavaFX.
- * @param args les arguments de ligne de commande.
+ * @param args Les arguments de ligne de commande.
*/
public static void main(String[] args) {
Application.launch(args);
diff --git a/src/main/java/fr/univlille/sae/classification/Main.java b/src/main/java/fr/univlille/sae/classification/Main.java
index 84adac9..d30364d 100644
--- a/src/main/java/fr/univlille/sae/classification/Main.java
+++ b/src/main/java/fr/univlille/sae/classification/Main.java
@@ -12,7 +12,7 @@ import java.io.IOException;
public class Main {
/**
* Point d'entrée principal de l'application.
- * @param args les arguments de ligne de commande.
+ * @param args Les arguments de ligne de commande.
*/
public static void main(String[] args) {
ClassificationApp.main(args);
diff --git a/src/main/java/fr/univlille/sae/classification/utils/Observable.java b/src/main/java/fr/univlille/sae/classification/utils/Observable.java
index 00a0d47..8dd8c8f 100644
--- a/src/main/java/fr/univlille/sae/classification/utils/Observable.java
+++ b/src/main/java/fr/univlille/sae/classification/utils/Observable.java
@@ -8,12 +8,19 @@ import java.util.HashSet;
*/
public abstract class Observable {
+ /**
+ * Liste des observateurs attachés.
+ */
protected Collection<Observer> attached = new HashSet<>();
+
+ /**
+ * Liste des observateurs à détacher.
+ */
protected Collection<Observer> toDetach = new HashSet<>();
/**
* Attache un observateur à l'objet observable.
- * @param obs observateur à attacher.
+ * @param obs Observateur à attacher
*/
public void attach(Observer obs) {
attached.add(obs);
@@ -21,7 +28,7 @@ public abstract class Observable {
/**
* Détache un observateur de l'objet observable.
- * @param obs observateur à détacher.
+ * @param obs Observateur à détacher
*/
public void detach(Observer obs) {
this.toDetach.add(obs);
@@ -39,7 +46,7 @@ public abstract class Observable {
/**
* Notifie tous les observateurs attachés avec des données supplémentaires.
- * @param data données à transmettre aux observateurs.
+ * @param data Données à transmettre aux observateurs
*/
protected void notifyObservers(Object data) {
this.updateList();
diff --git a/src/main/java/fr/univlille/sae/classification/utils/Observer.java b/src/main/java/fr/univlille/sae/classification/utils/Observer.java
index 0f7f208..fcedd98 100644
--- a/src/main/java/fr/univlille/sae/classification/utils/Observer.java
+++ b/src/main/java/fr/univlille/sae/classification/utils/Observer.java
@@ -13,15 +13,15 @@ public interface Observer {
/**
* Méthode appelée pour notifier l'observateur qu'un changement s'est produit
* dans l'objet observé.
- * @param observable l'objet observé qui a subi un changement.
+ * @param observable L'objet observé qui a subi un changement
*/
void update(Observable observable);
/**
* Méthode appelée pour notifier l'observateur qu'un changement s'est produit
* dans l'objet observé, avec des données supplémentaires.
- * @param observable l'objet observé qui a subi un changement.
- * @param data des informations supplémentaires concernant le changement.
+ * @param observable L'objet observé qui a subi un changement
+ * @param data Informations supplémentaires concernant le changement
*/
void update(Observable observable, Object data);
diff --git a/src/main/java/fr/univlille/sae/classification/utils/ViewUtil.java b/src/main/java/fr/univlille/sae/classification/utils/ViewUtil.java
index 01357ad..1cbe640 100644
--- a/src/main/java/fr/univlille/sae/classification/utils/ViewUtil.java
+++ b/src/main/java/fr/univlille/sae/classification/utils/ViewUtil.java
@@ -27,10 +27,10 @@ import java.util.Map;
public class ViewUtil {
/**
- * Définit la couleur de la forme
- * @param form forme à configurer.
- * @param controller contrôleur principale pour le menu contextuel.
- * @return forme configurée.
+ * Définit la couleur de la forme.
+ * @param form Forme à configurer
+ * @param controller Contrôleur principal pour le menu contextuel.
+ * @return Forme configurée
*/
public static Shape getForm(LoadableData dataLoaded, Shape form, Object controller) {
try {
@@ -57,7 +57,10 @@ public class ViewUtil {
return form;
}
-
+ /**
+ * Configuration de la légende.
+ * @return Le conteneur contenant la légende
+ */
public static VBox loadLegend() {
//Color
@@ -109,6 +112,4 @@ public class ViewUtil {
return legend;
}
-
-
}
diff --git a/src/main/java/fr/univlille/sae/classification/view/AddDataView.java b/src/main/java/fr/univlille/sae/classification/view/AddDataView.java
index 5acf706..aa924f7 100644
--- a/src/main/java/fr/univlille/sae/classification/view/AddDataView.java
+++ b/src/main/java/fr/univlille/sae/classification/view/AddDataView.java
@@ -16,15 +16,26 @@ import java.net.URL;
*/
public class AddDataView {
+ /**
+ * Modèle de classification utilisé pour gérer les données.
+ */
private ClassificationModel model;
+
+ /**
+ * Fenêtre parente de la vue.
+ */
private Stage owner;
+
+ /**
+ * La vue principale.
+ */
private MainStageView mainStageView;
/**
* Constructeur pour initialiser la vue d'ajout de données.
- * @param model le modèle de classification utilisé pour gérer les données.
- * @param owner la fenêtre parente de cette vue.
- * @param mainStageView la vue principale associée.
+ * @param model Le modèle de classification utilisé pour gérer les données
+ * @param owner La fenêtre parente de cette vue
+ * @param mainStageView La vue principale associée
*/
public AddDataView(ClassificationModel model, Stage owner, MainStageView mainStageView) {
this.model = model;
diff --git a/src/main/java/fr/univlille/sae/classification/view/AxesSettingsView.java b/src/main/java/fr/univlille/sae/classification/view/AxesSettingsView.java
index 041cafc..6cfc168 100644
--- a/src/main/java/fr/univlille/sae/classification/view/AxesSettingsView.java
+++ b/src/main/java/fr/univlille/sae/classification/view/AxesSettingsView.java
@@ -19,15 +19,26 @@ import java.util.ArrayList;
*/
public class AxesSettingsView {
+ /**
+ * Modèle de classification utilisé pour gérer les données.
+ */
private ClassificationModel model;
+
+ /**
+ * Fenêtre parente de la vue.
+ */
private Stage owner;
+
+ /**
+ * Vue de visualisation des données.
+ */
private DataVisualizationView dataVisualizationView;
/**
* Constructeur pour initialiser la vue de configuration des axes.
- * @param model modèle de classification utilisé pour gérer les données.
- * @param owner fenêtre parente de cette vue.
- * @param dataVisualizationView vue de visualisation des données associée.
+ * @param model Modèle de classification utilisé pour gérer les données
+ * @param owner Fenêtre parente de cette vue
+ * @param dataVisualizationView Vue de visualisation des données associée
*/
public AxesSettingsView(ClassificationModel model, Stage owner, DataVisualizationView dataVisualizationView) {
this.model = model;
diff --git a/src/main/java/fr/univlille/sae/classification/view/ChooseAttributesView.java b/src/main/java/fr/univlille/sae/classification/view/ChooseAttributesView.java
index a454322..0262ac3 100644
--- a/src/main/java/fr/univlille/sae/classification/view/ChooseAttributesView.java
+++ b/src/main/java/fr/univlille/sae/classification/view/ChooseAttributesView.java
@@ -12,25 +12,34 @@ import java.io.File;
import java.io.IOException;
import java.net.URL;
+/**
+ * Classe responsable du choix des attributs.
+ */
public class ChooseAttributesView {
-
-
+ /**
+ * Modèle de classification utilisé pour gérer les données.
+ */
private ClassificationModel model;
+
+ /**
+ * Fenêtre parente de la vue.
+ */
private Stage owner;
/**
- * Constructeur pour initialiser la vue de choix des attributs
- * @param model le modèle de classification
- * @param owner la fenêtre parente de cette vue.
+ * Constructeur pour initialiser la vue de choix des attributs.
+ * @param model Le modèle de classification
+ * @param owner La fenêtre parente de cette vue
*/
public ChooseAttributesView(ClassificationModel model, Stage owner) {
this.model = model;
this.owner = owner;
}
-
-
+ /**
+ * Affiche la vue du choix des attributs.
+ */
public void show() {
FXMLLoader loader = new FXMLLoader();
URL fxmlFileUrl = getClass().getClassLoader().getResource("stages"+ File.separator+"choose-attributes.fxml");
--
GitLab