Update UML + Update Comments

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 );
     }