Skip to content
Snippets Groups Projects
Commit ba685f92 authored by Matisse DEKEISER's avatar Matisse DEKEISER
Browse files

Javadoc view et autres (v1)

parent 5216b5d7
No related branches found
No related tags found
No related merge requests found
...@@ -18,7 +18,7 @@ public class ClassificationApp extends Application { ...@@ -18,7 +18,7 @@ public class ClassificationApp extends Application {
* Point d'entrée principal pour l'initialisation de l'interface utilisateur. * 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 * Cette méthode configure la vue principale en utilisant une instance du modèle
* de classification, puis affiche la fenêtre principale. * 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 { public void start(Stage stage) throws IOException {
ClassificationModel model = ClassificationModel.getClassificationModel(); ClassificationModel model = ClassificationModel.getClassificationModel();
...@@ -30,7 +30,7 @@ public class ClassificationApp extends Application { ...@@ -30,7 +30,7 @@ public class ClassificationApp extends Application {
/** /**
* Point d'entrée principal de l'application. * Point d'entrée principal de l'application.
* Cette méthode lance l'application JavaFX. * 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) { public static void main(String[] args) {
Application.launch(args); Application.launch(args);
......
...@@ -12,7 +12,7 @@ import java.io.IOException; ...@@ -12,7 +12,7 @@ import java.io.IOException;
public class Main { public class Main {
/** /**
* Point d'entrée principal de l'application. * 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) { public static void main(String[] args) {
ClassificationApp.main(args); ClassificationApp.main(args);
......
...@@ -8,12 +8,19 @@ import java.util.HashSet; ...@@ -8,12 +8,19 @@ import java.util.HashSet;
*/ */
public abstract class Observable { public abstract class Observable {
/**
* Liste des observateurs attachés.
*/
protected Collection<Observer> attached = new HashSet<>(); protected Collection<Observer> attached = new HashSet<>();
/**
* Liste des observateurs à détacher.
*/
protected Collection<Observer> toDetach = new HashSet<>(); protected Collection<Observer> toDetach = new HashSet<>();
/** /**
* Attache un observateur à l'objet observable. * Attache un observateur à l'objet observable.
* @param obs observateur à attacher. * @param obs Observateur à attacher
*/ */
public void attach(Observer obs) { public void attach(Observer obs) {
attached.add(obs); attached.add(obs);
...@@ -21,7 +28,7 @@ public abstract class Observable { ...@@ -21,7 +28,7 @@ public abstract class Observable {
/** /**
* Détache un observateur de l'objet observable. * Détache un observateur de l'objet observable.
* @param obs observateur à détacher. * @param obs Observateur à détacher
*/ */
public void detach(Observer obs) { public void detach(Observer obs) {
this.toDetach.add(obs); this.toDetach.add(obs);
...@@ -39,7 +46,7 @@ public abstract class Observable { ...@@ -39,7 +46,7 @@ public abstract class Observable {
/** /**
* Notifie tous les observateurs attachés avec des données supplémentaires. * 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) { protected void notifyObservers(Object data) {
this.updateList(); this.updateList();
......
...@@ -13,15 +13,15 @@ public interface Observer { ...@@ -13,15 +13,15 @@ public interface Observer {
/** /**
* Méthode appelée pour notifier l'observateur qu'un changement s'est produit * Méthode appelée pour notifier l'observateur qu'un changement s'est produit
* dans l'objet observé. * 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); void update(Observable observable);
/** /**
* Méthode appelée pour notifier l'observateur qu'un changement s'est produit * Méthode appelée pour notifier l'observateur qu'un changement s'est produit
* dans l'objet observé, avec des données supplémentaires. * dans l'objet observé, avec des données supplémentaires.
* @param observable l'objet observé qui a subi un changement. * @param observable L'objet observé qui a subi un changement
* @param data des informations supplémentaires concernant le changement. * @param data Informations supplémentaires concernant le changement
*/ */
void update(Observable observable, Object data); void update(Observable observable, Object data);
......
...@@ -27,10 +27,10 @@ import java.util.Map; ...@@ -27,10 +27,10 @@ import java.util.Map;
public class ViewUtil { public class ViewUtil {
/** /**
* Définit la couleur de la forme * Définit la couleur de la forme.
* @param form forme à configurer. * @param form Forme à configurer
* @param controller contrôleur principale pour le menu contextuel. * @param controller Contrôleur principal pour le menu contextuel.
* @return forme configurée. * @return Forme configurée
*/ */
public static Shape getForm(LoadableData dataLoaded, Shape form, Object controller) { public static Shape getForm(LoadableData dataLoaded, Shape form, Object controller) {
try { try {
...@@ -57,7 +57,10 @@ public class ViewUtil { ...@@ -57,7 +57,10 @@ public class ViewUtil {
return form; return form;
} }
/**
* Configuration de la légende.
* @return Le conteneur contenant la légende
*/
public static VBox loadLegend() { public static VBox loadLegend() {
//Color //Color
...@@ -109,6 +112,4 @@ public class ViewUtil { ...@@ -109,6 +112,4 @@ public class ViewUtil {
return legend; return legend;
} }
} }
...@@ -16,15 +16,26 @@ import java.net.URL; ...@@ -16,15 +16,26 @@ import java.net.URL;
*/ */
public class AddDataView { public class AddDataView {
/**
* Modèle de classification utilisé pour gérer les données.
*/
private ClassificationModel model; private ClassificationModel model;
/**
* Fenêtre parente de la vue.
*/
private Stage owner; private Stage owner;
/**
* La vue principale.
*/
private MainStageView mainStageView; private MainStageView mainStageView;
/** /**
* Constructeur pour initialiser la vue d'ajout de données. * 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 model Le modèle de classification utilisé pour gérer les données
* @param owner la fenêtre parente de cette vue. * @param owner La fenêtre parente de cette vue
* @param mainStageView la vue principale associée. * @param mainStageView La vue principale associée
*/ */
public AddDataView(ClassificationModel model, Stage owner, MainStageView mainStageView) { public AddDataView(ClassificationModel model, Stage owner, MainStageView mainStageView) {
this.model = model; this.model = model;
......
...@@ -19,15 +19,26 @@ import java.util.ArrayList; ...@@ -19,15 +19,26 @@ import java.util.ArrayList;
*/ */
public class AxesSettingsView { public class AxesSettingsView {
/**
* Modèle de classification utilisé pour gérer les données.
*/
private ClassificationModel model; private ClassificationModel model;
/**
* Fenêtre parente de la vue.
*/
private Stage owner; private Stage owner;
/**
* Vue de visualisation des données.
*/
private DataVisualizationView dataVisualizationView; private DataVisualizationView dataVisualizationView;
/** /**
* Constructeur pour initialiser la vue de configuration des axes. * Constructeur pour initialiser la vue de configuration des axes.
* @param model modèle de classification utilisé pour gérer les données. * @param model Modèle de classification utilisé pour gérer les données
* @param owner fenêtre parente de cette vue. * @param owner Fenêtre parente de cette vue
* @param dataVisualizationView vue de visualisation des données associée. * @param dataVisualizationView Vue de visualisation des données associée
*/ */
public AxesSettingsView(ClassificationModel model, Stage owner, DataVisualizationView dataVisualizationView) { public AxesSettingsView(ClassificationModel model, Stage owner, DataVisualizationView dataVisualizationView) {
this.model = model; this.model = model;
......
...@@ -12,25 +12,34 @@ import java.io.File; ...@@ -12,25 +12,34 @@ import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.net.URL; import java.net.URL;
/**
* Classe responsable du choix des attributs.
*/
public class ChooseAttributesView { public class ChooseAttributesView {
/**
* Modèle de classification utilisé pour gérer les données.
*/
private ClassificationModel model; private ClassificationModel model;
/**
* Fenêtre parente de la vue.
*/
private Stage owner; private Stage owner;
/** /**
* Constructeur pour initialiser la vue de choix des attributs * Constructeur pour initialiser la vue de choix des attributs.
* @param model le modèle de classification * @param model Le modèle de classification
* @param owner la fenêtre parente de cette vue. * @param owner La fenêtre parente de cette vue
*/ */
public ChooseAttributesView(ClassificationModel model, Stage owner) { public ChooseAttributesView(ClassificationModel model, Stage owner) {
this.model = model; this.model = model;
this.owner = owner; this.owner = owner;
} }
/**
* Affiche la vue du choix des attributs.
*/
public void show() { public void show() {
FXMLLoader loader = new FXMLLoader(); FXMLLoader loader = new FXMLLoader();
URL fxmlFileUrl = getClass().getClassLoader().getResource("stages"+ File.separator+"choose-attributes.fxml"); URL fxmlFileUrl = getClass().getClassLoader().getResource("stages"+ File.separator+"choose-attributes.fxml");
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment