src/ecoparasite/svg/SVGFactory.java

@@ -15,6 +15,11 @@ public class SVGFactory {
     static final private String EXPORT_PATH = "export/";
     static final private String EXTENSION = ".svg";
 
+    /**
+     * Permet la création du fichier SVG
+     * @param mesElements un array des elements à ajouter dans le svg
+     * @return True si la création est un succès, False sinon
+     */
     public static boolean createSVG(ArrayList<Element> mesElements){
 
         String code = createSVGCode(mesElements);
@@ -28,6 +33,12 @@ public class SVGFactory {
         return true;
     }
 
+    /**
+     * Permet la création du fichier SVG (Polymorphisme pour ajouter un nom de fichier)
+     * @param mesElements un Array des elements à ajouter dans le SVG
+     * @param filename une String représentant le nom du fichier choisi
+     * @return True si la création est un succès, False sinon
+     */
     public static boolean createSVG(ArrayList<Element> mesElements, String filename) {
 
         String code = createSVGCode(mesElements);
@@ -41,6 +52,11 @@ public class SVGFactory {
         return true;
     }
 
+    /**
+     * Fonction basique de transformation des éléments en code SVG
+     * @param mesElements un array contenant les éléments à mettre dans le svg
+     * @return une String contenant la totalité du code SVG de notre graphique
+     */
     public static String createSVGCode(ArrayList<Element> mesElements){
 
         String code = "<svg height=\"800\" width=\"800\" >";
@@ -56,11 +72,22 @@ public class SVGFactory {
         return code;
     }
 
+    /**
+     * fonction qui créer le fichier, ici avec une ID random comme nom de fichier
+     * @param data une String contenant le contenue du fichier désiré (ici pour le SVG)
+     * @throws IOException Déclenché par un échec de la création du fichier
+     */
     public static void createFile(String data) throws IOException {
         String id = UUID.randomUUID().toString();
         createFile(data,id);
     }
 
+    /**
+     * Permet la création du fichier
+     * @param data une String contenant le contenue du fichier désiré
+     * @param filename une String contenant le nom du fichier voulu
+     * @throws IOException Déclenché par un échec de la création du fichier
+     */
     public static void createFile(String data, String filename) throws IOException {
 
         // create a FileWriter object with the file name
@@ -76,6 +103,15 @@ public class SVGFactory {
 
     }
 
+    /**
+     * Permet de renvoyer des valeurs "clean" pour l'affichage des axes
+     * @param h Contient les Coordonnées de chacun des points de nos données
+     * @return une HashMap de String et de Hashset de Double.
+     *         Avec la String "AxeX", un Hashset de Double contenant les valeurs des gradations de l'axe X
+     *         Avec la String "AxeY", un Hashset de Double contenant les valeurs des gragations de l'axe Y
+     *         Avec la String "OffsetX", un Hashset de Double contenant uniquement la valeur de l'offset des points par rapport à l'axe X
+     *         Avec la String "OffsetY", un Hashset de Double contenant uniquement la valeur de l'offset des points par rapport à l'axe Y
+     */
     public static HashMap< String ,HashSet<Double>> PointAXES(HashSet<ValeursXY> h){
 
         HashMap< String, HashSet<Double> > map = new HashMap<>();