From 884724bf8d0657bce974d35f2d61e798ea7092d4 Mon Sep 17 00:00:00 2001
From: "hugo.debuyser.etu" <hugo.debuyser.etu@univ-lille.fr>
Date: Fri, 25 Oct 2024 14:50:50 +0200
Subject: [PATCH] Ajout de javadoc pour les controllers
---
.../controller/AddDataController.java | 20 +++++++--
.../controller/AxesSettingsController.java | 22 ++++++++-
.../controller/DataStageController.java | 45 +++++++++----------
.../controller/LoadDataController.java | 15 ++++---
.../controller/MainStageController.java | 33 ++++++++++----
.../sae/classification/model/Iris.java | 8 ----
6 files changed, 91 insertions(+), 52 deletions(-)
diff --git a/src/main/java/fr/univlille/sae/classification/controller/AddDataController.java b/src/main/java/fr/univlille/sae/classification/controller/AddDataController.java
index 1a690a0..ea7510e 100644
--- a/src/main/java/fr/univlille/sae/classification/controller/AddDataController.java
+++ b/src/main/java/fr/univlille/sae/classification/controller/AddDataController.java
@@ -1,17 +1,16 @@
package fr.univlille.sae.classification.controller;
import fr.univlille.sae.classification.model.ClassificationModel;
-import fr.univlille.sae.classification.model.Iris;
-import fr.univlille.sae.classification.view.DataVisualizationView;
import fr.univlille.sae.classification.view.MainStageView;
import javafx.fxml.FXML;
import javafx.scene.control.*;
import javafx.stage.Stage;
import java.io.IOException;
-import java.text.ParseException;
-import java.util.function.UnaryOperator;
+/**
+ * Controlleur pour le FXML add-data-stage, pour ajouter une nouvelle donnée
+ */
public class AddDataController {
@FXML
@@ -32,8 +31,14 @@ public class AddDataController {
@FXML
private Spinner<Double> petalWidthSpinner;
+ /**
+ * MainStageView associé au controlleur
+ */
MainStageView mainStageView;
+ /**
+ * Méthode d'intitialisation du controlleur
+ */
@FXML
public void initialize() {
sepalLengthSpinner.setValueFactory(new SpinnerValueFactory.DoubleSpinnerValueFactory(0.0, 200.0, 3.0,0.1));
@@ -49,10 +54,17 @@ public class AddDataController {
}
+ /**
+ * Méthode permettante d'attribuer la mainStageView associer à la classe
+ * @param mainStageView mainStageView à attribuer
+ */
public void setMainStageView(MainStageView mainStageView) {
this.mainStageView = mainStageView;
}
+ /**
+ * Validation des données à ajouter
+ */
public void validate() throws IOException {
System.out.println("validé");
mainStageView.getController().getClassifyData().setDisable(false);
diff --git a/src/main/java/fr/univlille/sae/classification/controller/AxesSettingsController.java b/src/main/java/fr/univlille/sae/classification/controller/AxesSettingsController.java
index 16c52b1..c04f311 100644
--- a/src/main/java/fr/univlille/sae/classification/controller/AxesSettingsController.java
+++ b/src/main/java/fr/univlille/sae/classification/controller/AxesSettingsController.java
@@ -7,7 +7,9 @@ import javafx.scene.control.Button;
import javafx.scene.control.ChoiceBox;
import javafx.stage.Stage;
-
+/**
+ * Controlleur pour le FXML axes-settings-stage, pour gérer les axes de la vue
+ */
public class AxesSettingsController{
@FXML
Stage stage;
@@ -21,24 +23,42 @@ public class AxesSettingsController{
@FXML
Button confirmAxes;
+ /**
+ * DataVisualizationView associé au controlleur
+ */
DataVisualizationView dataVisualizationView;
+ /**
+ * Ajout des éléments à sélectionner pour les ordonnées de la grille
+ * @param fields Éléments à ajouter
+ */
public void setSelectOrd(String[] fields){
selectOrd.getItems().clear();
selectOrd.getItems().addAll(fields);
selectOrd.setValue(dataVisualizationView.getActualY());
}
+ /**
+ * Ajout des éléments à sélectionner pout les abscisses de la grille
+ * @param fields Éléments à ajouter
+ */
public void setSelectAbs(String[] fields){
selectAbs.getItems().clear();
selectAbs.getItems().addAll(fields);
selectAbs.setValue(dataVisualizationView.getActualX());
}
+ /**
+ * Méthode permettante d'attribuer la dataVisualizationView associer à la classe
+ * @param dataVisualizationView dataVisualizationView à attribuer
+ */
public void setdataVisualizationView(DataVisualizationView dataVisualizationView) {
this.dataVisualizationView = dataVisualizationView;
}
+ /**
+ * Validation des paramètres des axes
+ */
public void validate(){
dataVisualizationView.setActualX(selectAbs.getValue().toString());
dataVisualizationView.setActualY(selectOrd.getValue().toString());
diff --git a/src/main/java/fr/univlille/sae/classification/controller/DataStageController.java b/src/main/java/fr/univlille/sae/classification/controller/DataStageController.java
index 2c561a9..926b167 100644
--- a/src/main/java/fr/univlille/sae/classification/controller/DataStageController.java
+++ b/src/main/java/fr/univlille/sae/classification/controller/DataStageController.java
@@ -11,23 +11,13 @@ import javafx.stage.Stage;
import java.io.IOException;
-
+/**
+ * Controlleur pour le FXML data-view-stage, pour gérer la vue supplémentaire
+ */
public class DataStageController {
@FXML
Stage stage;
- @FXML
- NumberAxis absAxe;
-
- @FXML
- NumberAxis ordAxe;
-
- @FXML
- Button settings;
-
- @FXML
- Button loadData;
-
@FXML
Button classifyData;
@@ -37,42 +27,47 @@ public class DataStageController {
@FXML
Label AxesSelected;
- Stage loadStage;
+ /**
+ * DataStageView associé au controlleur
+ */
private DataStageView dataStageView;
/**
- * Ouvre l'interface de chargement des données.
- * @throws IOException
+ * Ouvrir les paramètres des axes de la vue
*/
- public void openLoadData() throws IOException {
- LoadDataView loadDataView = new LoadDataView(ClassificationModel.getClassificationModel(), stage);
- loadDataView.show();
- }
-
public void openAxesSetting()throws IOException {
AxesSettingsView axesSettingsView = new AxesSettingsView(ClassificationModel.getClassificationModel(), stage, dataStageView);
axesSettingsView.show();
}
+ /**
+ * Associe la dataStageView associer à la classe
+ * @param dataStageView
+ */
public void setDataStageView (DataStageView dataStageView) {
this.dataStageView = dataStageView;
}
+
public void classifyDatas() {
ClassificationModel.getClassificationModel().classifierDonnees();
classifyData.setDisable(true);
}
-
+ /**
+ * Renvoie la grille associé à la classe
+ * @return grille de la classe
+ */
public ScatterChart getScatterChart() {
return this.scatterChart;
}
+ /**
+ * Attribut une valeur à l'axe de la grille
+ * @param texte Valeur de l'axe
+ */
public void setAxesSelected(String texte) {
this.AxesSelected.setText(texte);
}
- public Button getClassifyData() {
- return this.classifyData;
- }
}
diff --git a/src/main/java/fr/univlille/sae/classification/controller/LoadDataController.java b/src/main/java/fr/univlille/sae/classification/controller/LoadDataController.java
index 902fb93..8ca5ee8 100644
--- a/src/main/java/fr/univlille/sae/classification/controller/LoadDataController.java
+++ b/src/main/java/fr/univlille/sae/classification/controller/LoadDataController.java
@@ -27,11 +27,14 @@ public class LoadDataController {
@FXML
TextField filePath;
+ /**
+ * Fichier sélectionné
+ */
File file;
-
-
-
+ /**
+ * Ouvre un explorateur de fichiers pour sélectionner le fichier à étudier
+ */
public void openFileChooser() {
FileChooser fileChooser = new FileChooser();
fileChooser.setTitle("Choisissez le fichier à importer");
@@ -43,6 +46,9 @@ public class LoadDataController {
}
+ /**
+ * Valide le fichier sélectionné au préalable
+ */
public void validate() throws IOException {
if (file == null) {
@@ -59,7 +65,4 @@ public class LoadDataController {
ClassificationModel.getClassificationModel().loadData(file);
stage.close();
}
-
-
-
}
diff --git a/src/main/java/fr/univlille/sae/classification/controller/MainStageController.java b/src/main/java/fr/univlille/sae/classification/controller/MainStageController.java
index bf8ab81..4013b83 100644
--- a/src/main/java/fr/univlille/sae/classification/controller/MainStageController.java
+++ b/src/main/java/fr/univlille/sae/classification/controller/MainStageController.java
@@ -49,55 +49,72 @@ public class MainStageController {
/**
* Ouvre l'interface de chargement des données.
- * @throws IOException
*/
public void openLoadData() throws IOException {
LoadDataView loadDataView = new LoadDataView(ClassificationModel.getClassificationModel(), stage);
loadDataView.show();
}
+ /**
+ * Ouvre l'interface d'une nouvelle vue.
+ */
public void openDataView() throws IOException {
DataStageView dataStageView = new DataStageView(ClassificationModel.getClassificationModel());
dataStageView.show();
}
+ /**
+ * Ouvre l'interface de la configuration des axes.
+ */
public void openAxesSetting()throws IOException {
AxesSettingsView axesSettingsView = new AxesSettingsView(ClassificationModel.getClassificationModel(), stage, mainStageView);
axesSettingsView.show();
}
+ /**
+ * Associe la mainStageView associer à la classe
+ * @param mainStageView
+ */
public void setMainStageView(MainStageView mainStageView) {
this.mainStageView = mainStageView;
}
/**
* Ouvre l'interface d'ajout de donnée.
- * @throws IOException
*/
public void openAddData() throws IOException {
-
AddDataView addDataView = new AddDataView(ClassificationModel.getClassificationModel(), stage, mainStageView);
addDataView.show();
-
-
}
-
-
+ /**
+ * Appelle de la méthode de la classe ClassificationModel afin de classifier les nouvelles données
+ */
public void classifyDatas() {
ClassificationModel.getClassificationModel().classifierDonnees();
classifyData.setDisable(true);
}
-
+ /**
+ * Renvoie la grille associé à la classe
+ * @return grille de la classe
+ */
public ScatterChart getScatterChart() {
return this.scatterChart;
}
+ /**
+ * Attribut une valeur à l'axe de la grille
+ * @param texte Valeur de l'axe
+ */
public void setAxesSelected(String texte) {
this.AxesSelected.setText(texte);
}
+ /**
+ * Renvoie le bouton de classification de données
+ * @return Bouton de classification
+ */
public Button getClassifyData() {
return this.classifyData;
}
diff --git a/src/main/java/fr/univlille/sae/classification/model/Iris.java b/src/main/java/fr/univlille/sae/classification/model/Iris.java
index 9912b9b..f71fe89 100644
--- a/src/main/java/fr/univlille/sae/classification/model/Iris.java
+++ b/src/main/java/fr/univlille/sae/classification/model/Iris.java
@@ -100,14 +100,6 @@ public class Iris extends LoadableData{
return names;
}
- public String[] getTypesName() {
- return new String[]{
- "Setosa",
- "Versicolor",
- "Virginica"
- };
- }
-
@Override
public String toString() {
return "Iris{" +
--
GitLab