Javadoc

GSBapplication/src/Metier/Medicament.java

@@ -26,7 +26,7 @@ public class Medicament {
 
     
     /** LE CONSTRUCTEUR DEFAULT
-     * 
+     * Constructeur de médicament avec tous les attribut définis
      * @param id
      * @param nom
      * @param composition
@@ -52,6 +52,7 @@ public class Medicament {
     }
 
     /**
+     * Getteur du nom du médicament
      * @return the nom
      */
     public String getNom() {
@@ -59,6 +60,7 @@ public class Medicament {
     }
 
     /**
+     * Getteur de la Composition du médicament
      * @return the composition
      */
     public String getComposition() {
@@ -66,6 +68,7 @@ public class Medicament {
     }
 
     /**
+     * Guetteur des effets de médicament
      * @return the effet
      */
     public String getEffet() {
@@ -73,16 +76,25 @@ public class Medicament {
     }
 
     /**
+     * Guetteur des contres Indications du médicament
      * @return the contreindication
      */
     public String getContreindication() {
         return contreindication;
     }
 
+    /**
+     * Getteur de l'adresse de l'image du médicament
+     * @return the img
+     */
     public String getImg() {
         return img;
     }
-    
+    /**
+     * Méthode toString permettant connaitre la valeur 
+     * de chaque attribut de l'objet Médicament
+     * @return retourne de façon structuré tout les attributs
+     */
     @Override
     public String toString() {
         return "Medicament{" + "id=" + id + ", nom=" + nom + ", composition=" + composition + ", effet=" + effet + ", contreindication=" + contreindication + ",img=" + img + '}';

GSBapplication/src/Metier/famille.java

@@ -22,14 +22,21 @@ public class famille {
         this.id = id;
     }
 
-    // LES SETTEUR 
+    //      LES Guetteurs
     /**
+     * Getteur de l'id de la famille
      * @return the id
      */
     public String getId() {
         return id;
     }
 
+    //       Méthodes
+    /**
+     * Méthode toString permettant connaitre la valeur 
+     * de chaque attribut de l'objet famille
+     * @return retourne de façon structuré tout les attributs
+     */
     @Override
     public String toString() {
         return "famille{" + "id=" + id + '}';

GSBapplication/src/Metier/praticien.java

@@ -22,7 +22,7 @@ public class praticien {
     
     
     /** LE CONSTRUCTEUR DEFAULT
-     * 
+     * Constructeur de praticien complétant chaque attributs
      * @param id
      * @param nom
      * @param prenom
@@ -38,6 +38,7 @@ public class praticien {
     
     //LES GETTEUR
     /**
+     * Guetteur de l'id du praticien
      * @return the id
      */
     public int getId() {
@@ -45,6 +46,7 @@ public class praticien {
     }
 
     /**
+     * Guetteur du nom du praticien
      * @return the nom
      */
     public String getNom() {
@@ -52,6 +54,7 @@ public class praticien {
     }
 
     /**
+     * Guetteur du prénom du praticien
      * @return the prenom
      */
     public String getPrenom() {
@@ -59,13 +62,18 @@ public class praticien {
     }
 
     /**
+     * Guetteur du type de praticien
      * @return the type_praticien
      */
     public String getType_praticien() {
         return type_praticien;
     }
 
-    
+    /**
+     * Méthode toString permettant connaitre la valeur 
+     * de chaque attribut de l'objet praticien
+     * @return retourne de façon structuré tout les attributs
+     */
     @Override
     public String toString() {
         return "Praticien{" + "id=" + id + ", nom=" + nom + ", prenom=" + prenom + ", type_praticien=" + type_praticien + '}';

GSBapplication/src/Metier/visiteur_medicaux.java

@@ -21,8 +21,7 @@ public class visiteur_medicaux {
     private String region;
     
     /** LE CONSTRUCTEUR DEFAULT
-     * 
+     * Constructeur de visiteur_médicaux complétant chaque attributs
-     * 
      * @param id
      * @param nom
      * @param prenom
@@ -38,6 +37,7 @@ public class visiteur_medicaux {
     
     //LES GETTEUR
     /**
+     * Guetteur de l'id du visiteur médical
      * @return the id
      */
     public int getId() {
@@ -45,6 +45,7 @@ public class visiteur_medicaux {
     }
 
     /**
+     * Guetteur du nom du visiteur médical
      * @return the nom
      */
     public String getNom() {
@@ -52,17 +53,11 @@ public class visiteur_medicaux {
     }
 
     /**
+     * Guetteur du prénom du visiteur médical
      * @return the prenom
      */
     public String getPrenom() {
         return prenom;
     }
 
-    /**
-     * @return the region
-     */
-    public String getRegion() {
-        return region;
-    }
-
 }

GSBapplication/src/acces_aux_donnes/MedicamentSQL.java

@@ -18,10 +18,19 @@ public class MedicamentSQL {
     private Statement stmt = 	null;
     private ResultSet result = 	null;
 
+    /**
+     * Constructeur de la classe médicamentSQL
+     */
     public MedicamentSQL() {
         connexionTest = connexionSQL.getConnect("10.121.38.69","bdgsb","appliGSB","(Uq1XV0Tr01s2H9Z");
     }
     
+    /**
+     * Méthode permettant la recherche d'un médicament dans une base données
+     * suivant le nom commercial de celui-ci
+     * @param nomCo 
+     * @return ArrayList<String> infoMedoc avec toutes les informations du médicament
+     */
     public ArrayList<String> rechercherMedicament (String nomCo){
         ArrayList<String> infoMedoc = new ArrayList<String>();
         

GSBapplication/src/acces_aux_donnes/connexionSQL.java

@@ -10,7 +10,7 @@ public class connexionSQL {
     private static Connection connect;      // Variable de connexion
   
   /**
-   * Constructeur
+   * Constructeur d'une connexion avec une base de données
    * @param serveur     nom du serveur, localhost si local
    * @param bdd         nom de la base de données
    * @param nomUtil     nom utilisateur

GSBapplication/src/acces_aux_donnes/familleMedocSQL.java

@@ -20,6 +20,9 @@ public class familleMedocSQL {
     private Statement stmt = 	null;
     private ResultSet result = 	null;
     
+    /**
+     * Constructeur de la classe familleMedocSQL
+     */
     public familleMedocSQL(){
         connexionTest = connexionSQL.getConnect("10.121.38.69","bdgsb","appliGSB","(Uq1XV0Tr01s2H9Z");
     }
@@ -44,6 +47,12 @@ public class familleMedocSQL {
         return famille;
     }
     
+    /**
+     * Méthode permettant la recherche d'un code de famille de médicament
+     * à l'aide d'un libelle
+     * @param libelle nom de la famille de médicament
+     * @return code de la famille de médicament
+     */
     public String rechercheCodeFamille(String libelle){
         String code = "";  
         try {
@@ -63,6 +72,12 @@ public class familleMedocSQL {
         return code;    
     }
     
+    /**
+     * Methode permettant de rechercher dans une base de données 
+     * les médicaments faisant partie de la même famille grâce à un code de famille
+     * @param libelle
+     * @return Tableau avec tous les noms des médicaments concernés
+     */
     public Vector<String> rechercherMedocFamille(String libelle){
         Vector<String> famille = new Vector<String>();  
         try {

GSBapplication/src/acces_aux_donnes/observationSQL.java

@@ -20,10 +20,18 @@ public class observationSQL {
     private Statement stmt = 	null;
     private ResultSet result = 	null;
     
+    /**
+     * Constructeur de observationSQL
+     */
     public observationSQL() {
         connexionTest = connexionSQL.getConnect("10.121.38.69","bdgsb","appliGSB","(Uq1XV0Tr01s2H9Z");
     }
     
+    /**
+     * Méthode permettant de compter le nombre d'observations 
+     * présente dans la Table observation 
+     * @return nombre de lignes
+     */
     public int compterLignes(){
         int nbLignes = 0;
         try {
@@ -43,7 +51,13 @@ public class observationSQL {
         return nbLignes;
     }
     
-
+    /**
+     * Méthode permattant d'inserer dans la base de données une nouvelle observation
+     * @param idMedoc
+     * @param idPraticien
+     * @param observation
+     * @return int
+     */
     public int ajouterObservation(String idMedoc, int idPraticien, String observation){
         int passer = 1000;
         int nbLignes = this.compterLignes();
@@ -63,6 +77,11 @@ public class observationSQL {
         return passer;
     }
     
+    /**
+     * Méthode permettant de sélectionner les observations se rapportant au médicament sélectionné
+     * @param idMedoc
+     * @return Tableau des différentes observations
+     */
     public ArrayList<String> selectionObservation(String idMedoc){
         ArrayList<String> observationMedoc = new ArrayList<String>();
         try {

GSBapplication/src/acces_aux_donnes/praticienSQL.java

@@ -19,11 +19,20 @@ public class praticienSQL {
     private Statement stmt = 	null;
     private ResultSet result = 	null;
     
-     public praticienSQL() {
+    /**
+     * Constructeur de praticienSQL
+     */
+    public praticienSQL() {
         connexionTest = connexionSQL.getConnect("10.121.38.69","bdgsb","appliGSB","(Uq1XV0Tr01s2H9Z");
     }
-     
+    
-      public ArrayList<String> rechercherPraticien(String login, String mdp) {
+    /**
+     * Méthode permattant de rechercher un praticien dans une base de données
+     * @param login
+     * @param mdp
+     * @return Tableau avec les informations du praticien
+     */
+    public ArrayList<String> rechercherPraticien(String login, String mdp) {
         ArrayList<String> praticienCherche = new ArrayList<String>();
         try {
             stmt = connexionTest.createStatement();

GSBapplication/src/acces_aux_donnes/visiteurSQL.java

@@ -19,7 +19,10 @@ public class visiteurSQL {
     private Statement stmt = 	null;
     private ResultSet result = 	null;
     
-     public visiteurSQL() {
+    /**
+     * Constructeur de visiteurSQL
+     */
+    public visiteurSQL() {
         connexionTest = connexionSQL.getConnect("10.121.38.69","bdgsb","appliGSB","(Uq1XV0Tr01s2H9Z");
     }