Update UML + Update Comments

src/ecoparasite/svg/Coordonnees.java

@@ -1,5 +1,8 @@
 package ecoparasite.svg;
 
+/**
+ * Classe qui permet de stocker les coordonnées utilisées pour le positionnement sur le fichier SVG.
+ */
 public class Coordonnees {
 
     private double x;

src/ecoparasite/svg/IncorrectAxesPointsException.java

@@ -1,4 +1,7 @@
 package ecoparasite.svg;
 
+/**
+ * Exception déclenchée lorsque le format des Axes est incorrect par rapport à ce que la fonction attend.
+ */
 public class IncorrectAxesPointsException extends Exception{
 }

src/ecoparasite/svg/SVGBuilder.java

@@ -7,6 +7,10 @@ import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.HashSet;
 
+/**
+ * Classe qui permet de construire les éléments présents sur le SVG.
+ * Axes, Points, Regression, Ticks.
+ */
 public class SVGBuilder {
 
     final int SIZE_TICK_TEXT = ElementsFactory.AXES_TEXT_SIZE - 3;
@@ -22,6 +26,14 @@ public class SVGBuilder {
     private Double maxPointsX;
     private Double maxPointsY;
 
+    /**
+     * Constructeur.
+     * Initialise les différentes variables tirées de axesPoints.
+     * @param axesPoints Paramètre tiré de la fonction calcPointsAxes.
+     * @throws IncorrectAxesPointsException Si le format de axesPoints est incorrect.
+     *
+     * @see SVGBuilder::calcPointsAxes
+     */
     public SVGBuilder(HashMap<String, ArrayList<Double>> axesPoints ) throws IncorrectAxesPointsException {
 
         if( axesPoints.get("AxeX") == null ||  axesPoints.get("AxeY") == null || axesPoints.get("OffsetX") == null || axesPoints.get("OffsetY") == null ){
@@ -56,6 +68,10 @@ public class SVGBuilder {
         return offsetY;
     }
 
+    /**
+     * Permet d'obtenir un resizer ou bien le crée s'il n'existe pas déjà.
+     * @return
+     */
     public SVGResizing getResizer() {
         if( this.resizer == null ){
             this.resizer = new SVGResizing( this.minPointsX, this.minPointsY, this.maxPointsX, this.maxPointsY );
@@ -67,6 +83,15 @@ public class SVGBuilder {
         this.resizer = resizer;
     }
 
+    /**
+     * Permet de tout construire d'un seul coup.
+     * @param XLabel Le nom de l'axe X.
+     * @param YLabel Le nom de l'axe Y.
+     * @param points Les points pour le nuage de points.
+     * @param A Le coefficient A de la regression
+     * @param B Le coefficient B de la regression
+     * @return Une liste d'éléments pour la génération du SVG.
+     */
     public ArrayList<Element> buildAll(String XLabel, String YLabel, HashSet<ValeursXY> points, double A, double B){
 
         ArrayList<Element> elements = new ArrayList<>();
@@ -80,8 +105,15 @@ public class SVGBuilder {
         return elements;
     }
 
+    /**
+     * Permet de construire les axes au format SVG.
+     * @param XLabel Le nom de l'axe X.
+     * @param YLabel Le nom de l'axe Y.
+     * @return La liste d'éléments SVG pour les axes.
+     */
     public ArrayList<Element> buildAxes(String XLabel, String YLabel){
 
+        // Offsets/Configuration.
         final int OFFSET_TEXT_AXISX_X = -20;
         final int OFFSET_TEXT_AXISX_Y = -10;
         final int OFFSET_TEXT_AXISY_X = +5;
@@ -115,8 +147,15 @@ public class SVGBuilder {
 
     }
 
+    /**
+     * Permet de construire les batons de l'axe X.
+     * Utilise this.pointsX
+     *
+     * @return La liste d'éléments des points X.
+     */
     public ArrayList<Element> buildXTicks(){
 
+        // Offsets/Configuration.
         final int OFFSET_TICK = -5;
         final int OFFSET_TEXT_X = -10;
         final int OFFSET_TEXT_Y = +15;
@@ -143,6 +182,12 @@ public class SVGBuilder {
         return elements;
     }
 
+    /**
+     * Permet de construire les batons de l'axe Y.
+     * Utilise this.pointsY
+     *
+     * @return La liste d'éléments des points Y.
+     */
     public ArrayList<Element> buildYTicks(){
 
         final int OFFSET_TICK = +5;
@@ -171,6 +216,11 @@ public class SVGBuilder {
         return elements;
     }
 
+    /**
+     * Construire le nuage de points sur le SVG.
+     * @param points La liste des points.
+     * @return La liste des éléments pour le nuage de points SVG.
+     */
     public ArrayList<Element> buildPoints( HashSet<ValeursXY> points ){
 
         ArrayList<Element> elements = new ArrayList<>();
@@ -182,6 +232,12 @@ public class SVGBuilder {
         return elements;
     }
 
+    /**
+     * Construire la droite de regression linéaire.
+     * @param A Coefficient a
+     * @param B Coefficient B
+     * @return La liste des éléments pour la droite.
+     */
     public ArrayList<Element> buildRegression( double A, double B ){
         ArrayList<Element> elements = new ArrayList<>();
 
@@ -195,10 +251,18 @@ public class SVGBuilder {
         return elements;
     }
 
+    /**
+     * Permet de savoir à quel point l'axe X doit débuter.
+     * @return Le double de début de l'axe X.
+     */
     private double getBeginAxeX(){
         return ( minPointsX > 0 ) ? minPointsX : ( maxPointsX < 0 ? maxPointsX : 0 );
     }
 
+    /**
+     * Permet de savoir à quel point l'axe Y doit débuter.
+     * @return Le double du début de l'axe Y.
+     */
     private double getBeginAxeY(){
         return ( minPointsY > 0 ) ? minPointsY : ( maxPointsY < 0 ? maxPointsY : 0 );
     }

src/ecoparasite/svg/SVGFactory.java

@@ -2,7 +2,9 @@ package ecoparasite.svg;
 
 import ecoparasite.representation.ValeursXY;
 import ecoparasite.svg.elements.Element;
+import ecoparasite.svg.elements.ElementsFactory;
 
+import javax.lang.model.util.ElementScanner14;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.util.ArrayList;
@@ -59,7 +61,7 @@ public class SVGFactory {
      */
     public static String createSVGCode(ArrayList<Element> mesElements){
 
-        String code = "<svg height=\"800\" width=\"800\" >";
+        String code = "<svg height=\"" + ElementsFactory.SVG_SIZE + "\" width=\"" + ElementsFactory.SVG_SIZE + "\" >";
 
         for (Element e : mesElements){
 

src/ecoparasite/svg/SVGResizing.java

@@ -3,13 +3,25 @@ package ecoparasite.svg;
 import ecoparasite.representation.ValeursXY;
 import ecoparasite.svg.elements.ElementsFactory;
 
+/**
+ * Classe qui permet de convertir des doubles en dimension SVG.
+ */
 public class SVGResizing {
 
+
     private double minX;
     private double maxX;
     private double minY;
     private double maxY;
 
+    /**
+     * Constructeur.
+     * Définit les minimum et maximum X et Y.
+     * @param minXGrad
+     * @param minYGrad
+     * @param maxXGrad
+     * @param maxYGrad
+     */
     public SVGResizing(
         double minXGrad,
         double minYGrad,
@@ -42,6 +54,12 @@ public class SVGResizing {
         return this.resize( vxy.getX(), vxy.getY() );
     }
 
+    /**
+     * Permet de redimensionner quelconque valeur X Y (Provenant de ValeursXY par exemple) en Coordonnées SVG.
+     * @param X
+     * @param Y
+     * @return La coordonnée SVG équivalente.
+     */
     public Coordonnees resize( double X, double Y ){
         double surface = ElementsFactory.SVG_SIZE - 2 * ElementsFactory.SVG_OFFSET;
 

src/ecoparasite/svg/elements/Circle.java

@@ -4,11 +4,20 @@ import ecoparasite.svg.Coordonnees;
 
 import java.util.Locale;
 
+/**
+ * Element Cercle SVG.
+ */
 public class Circle extends Element {
 
     private int rayon;
     private String color;
 
+    /**
+     * Constructeur.
+     * @param coordonnees
+     * @param rayon
+     * @param color - Couleur provenant de ElementsFactory.
+     */
     public Circle(Coordonnees coordonnees, int rayon, String color) {
         super(coordonnees);
         this.rayon = rayon;
@@ -37,6 +46,10 @@ public class Circle extends Element {
         this.color = color;
     }
 
+    /**
+     * Crée la string SVG.
+     * @return La string SVG.
+     */
     @Override
     public String toSVG() {
         StringBuilder svg = new StringBuilder();

src/ecoparasite/svg/elements/Element.java

@@ -2,10 +2,18 @@ package ecoparasite.svg.elements;
 
 import ecoparasite.svg.Coordonnees;
 
+/**
+ * Classe abstraite qui permet de définir des éléments SVG.
+ */
 abstract public class Element {
 
     protected Coordonnees coordonnees;
 
+    /**
+     * Constructeur par défaut.
+     * Inscrit juste les coordonnées.
+     * @param coordonnees Les coordonnées.
+     */
     public Element(Coordonnees coordonnees) {
         this.coordonnees = coordonnees;
     }
@@ -24,7 +32,7 @@ abstract public class Element {
 
     /**
      * Méthode abstraite qui va permettre de transformer notre élément en SVG.
-     * @return La String SVF
+     * @return La String SVG
      */
     abstract public String toSVG();
 

src/ecoparasite/svg/elements/ElementsFactory.java

@@ -5,13 +5,29 @@ import ecoparasite.svg.Coordonnees;
 import java.util.ArrayList;
 import java.util.HashSet;
 
+/**
+ * Contient divers éléments utiles pour les fichiers SVG.
+ */
 public class ElementsFactory {
 
+    /**
+     * Taille du fichier SVG.
+     * SVG_SIZE * SVG_SIZE
+     */
     final public static int SVG_SIZE = 800;
+
+    /**
+     * Le décalage de cadre du fichier SVG.
+     */
     final public static int SVG_OFFSET = 50;
 
+    /**
+     * La taille du texte pour les axes.
+     */
     final public static int AXES_TEXT_SIZE = 10;
 
+    // Définition de couleurs.
+
     final public static String COLOR_WHITE = "white";
     final public static String COLOR_RED = "red";
     final public static String COLOR_BLUE = "blue";

src/ecoparasite/svg/elements/Line.java

@@ -4,12 +4,22 @@ import ecoparasite.svg.Coordonnees;
 
 import java.util.Locale;
 
+/**
+ * Permet de construire une droite/ligne en SVG.
+ */
 public class Line extends Element {
 
     private Coordonnees coordonneesB;
     private String color;
     private int lineWidth;
 
+    /**
+     * Constructeur
+     * @param coordonneesA Coordonnées de départ
+     * @param coordonneesB Coordonnées d'arrivé.
+     * @param color Couleur provenant de ElementsFactory
+     * @param lineWidth Epaisseur de la ligne.
+     */
     public Line(Coordonnees coordonneesA, Coordonnees coordonneesB, String color, int lineWidth) {
         super(coordonneesA);
         this.coordonneesB = coordonneesB;
@@ -56,6 +66,10 @@ public class Line extends Element {
         this.lineWidth = lineWidth;
     }
 
+    /**
+     * Génère la string SVG de l'élément.
+     * @return
+     */
     @Override
     public String toSVG() {
         StringBuilder svg = new StringBuilder();

src/ecoparasite/svg/elements/Text.java

@@ -4,12 +4,22 @@ import ecoparasite.svg.Coordonnees;
 
 import java.util.Locale;
 
+/**
+ * Élement qui permet de générer un texte sur le SVG.
+ */
 public class Text extends Element {
 
     private String text;
     private String color;
     private int size;
 
+    /**
+     * Constructeur
+     * @param coordonnees Les coordonnées du texte
+     * @param text
+     * @param color Provenant de ElementsFactory
+     * @param size La taille du texte
+     */
     public Text(Coordonnees coordonnees, String text, String color,  int size) {
         super(coordonnees);
         this.text = text;
@@ -48,6 +58,10 @@ public class Text extends Element {
         this.size = size;
     }
 
+    /**
+     * Génère la string SVG.
+     * @return
+     */
     @Override
     public String toSVG() {
         StringBuilder svg = new StringBuilder();