From ad8d796c8939c94b73b1c9fa3b7d4fe74613578d Mon Sep 17 00:00:00 2001
From: Sunguin Peng <spe76@uclive.ac.nz>
Date: Mon, 26 Sep 2016 12:32:11 +1300
Subject: [PATCH] Javadoc added for airline raw data

---
 res/userdb.db                                 | Bin 8387584 -> 8387584 bytes
 .../java/seng202/group9/Core/Airline.java     |   2 +-
 .../group9/GUI/AirlineAddController.java      |  24 +++++---
 .../group9/GUI/AirlineEditController.java     |  56 +++++++++++-------
 .../group9/GUI/AirlineFilterController.java   |  23 ++++---
 .../group9/GUI/AirlineRDController.java       |   8 ++-
 6 files changed, 73 insertions(+), 40 deletions(-)

diff --git a/res/userdb.db b/res/userdb.db
index fbc27185bd10a0ac2344ccdda676e96947037e14..617c8baa949074f8def53406844509c1e3e1681c 100644
GIT binary patch
delta 1165
zcmZ9~Nla5g7zgl~`C1-SmRD$brA4JsL_`#ARa`160u=<*ihGqxaTk@MbwP1CG{%@<
zh|UEK2jj)WxW9{d(1eRIK}}o^8jXaQ7!#w!kSNiAs}W-+znSmN<y+<*AO1<lq0_<J
z&SjVLwi}J@8Qgd4bw<Gl%3x2slpih{W>2NF)OuR(Ej2jId3QZVP2=v!zUD|I91I1!
zf)A{=!n<x`mJ_$Qh=gK-TUx{6P*-q=<&<kA>Kfr7fWQDo-8GW%Hj~egMvD?qshY~z
z7dFVAvxn>!yP~&Rl#t-N<cmyYn`R<S#1lF^V<=1f&f;+Et2E`R%|ZdD@IgkoqF=NN
z4<Dr4B%K54K3P&~J^arWYe28QUKimO##l0|uj}=jSiLX4Ynp6!D-)9bHWux1D|(MR
zG1NFNg;Yjg=?y)j`_x12)Iyu6mgZ71Ws~}QI{)SR`<a7ONhiXjrNyQdZb&`RO3t*=
z5j8}MWg;Z$#nRNhQt>iI`PZgK`#+lW{*PlkmnnsdsM47XDUb?jy3(nRH07jnFXNB+
z8Q#df^oTCd9`X_wkHuxtBuWJ7t|2vx%Xyv2eL8(pc^?(=lTx{7_8a(FMDb^hSBlX%
z9kDUTi)3HZ$SFo^WMA})z2>cULx9_u%t<bY$c~rhauXZ=vp&mdKJL1(eVuW<PxC1x
zgjS_hp>vy7sa4`swF<2QXJXXy$_(j{0T!@ACTL)TEU<$EvSBQYgYl39PRNBka6vvy
zfC8APTV54@O0d%aOAy_RZqk05F20K=qMHWdOPbeMUylA1=S$LO%d#Q0$bjmW%a$Q^
zax8M{mxk149t*Se5AO>DGZPk9`27plMQiMnpa>>IF-(D}Py*9nI=I0DGhimnf>M|b
zb6_sa124>nGFSi$VG)$WVyJ*hr~)4>foiCMrBDlXP!G#sIjjIbtb_(w1*>5Vtc6$)
z>tO=~U?XgTMhL=YXo3(l!xq>I+h9BFfSs@lc0&v7fxWN~S|JQ=upbUU1P;O>I1ERi
O9ge~=y~f^g=iM*jFKj6Q

delta 895
zcmZ|LyHAs07>4op>-%BLL8U@D6i^PuidsaeSOpd3Py|7ggNRm&ip3LxClsrYFjO}U
zB<~`LgRz4N(V%{dy67K3VxkPyXf%X`h2YXbq8CmW<M4aN=T5Gn=r1{hdl_2berAOh
zc;*i#Y2JxXNzNH*)f^+{pAMDlvE5Nc9$VkAV<F^N&|rduju^wSu<T2UR;*%@&AtRN
zFQ&x@@m5TT$41XwO}9xKRv+hU294HK^OLk>A%t0*7Bbf~X$qR$+O&KwRZeeQ+2X{&
zlGE$aoks1`hJH=?MjFB)-E9u*Zj0X@FI__Zke}sy`9?mJLD?faWW6kvE|uf4-CgqH
z-;a)vOIZ+WxK!MOW^=U=GJm`{G&vh*OwPu;ABFX{W<8{jCSW;MU}abzP4tKL#uh!S
zM-$)40&Ps0Us;>}-YYl8URwipy;DSm%1&_htHJK}S}m$NJ$j*<o3h48Z>smDtt%o!
zk%$$mkc4E|kb+dCAsu#PAQM?wjWx(d4swwP2lBBNPOLK`k%D|_p|vKz3#qJawyFPj
z`ICv<d6ukkZ)`e@nQsNYl4XremDN?1p*s6|Y`{jiP>4+^!e(qiG2GaS5^RG9+pz<s
zD8o+d!fupf5B8!0i(6Hwh8H#1hg#HOKkCtd18BrS96}SC(SlYSMjMWx9Y=8tJ{(5}
z{OH69oWv<~;WPs1#u=Q&Ih@A@^xz_T(T7X8j4QZ`Yv{*y+`s^CB8XeKZPeKZUwr)y
DMgcpF

diff --git a/src/main/java/seng202/group9/Core/Airline.java b/src/main/java/seng202/group9/Core/Airline.java
index 76f9765..820b419 100644
--- a/src/main/java/seng202/group9/Core/Airline.java
+++ b/src/main/java/seng202/group9/Core/Airline.java
@@ -278,7 +278,7 @@ public class Airline{
 		if (!this.ICAO.equals("") && this.ICAO.equals(airline.getICAO())){
 			throw new DataException("This ICAO Code already Exists, Please Choose Another.");
 		}
-		if (!this.alias.equals("") && this.alias.equals(airline.getAlias())){
+		if (!this.alias.equals("") && !this.alias.equals("\\N") && !this.alias.equals("\\n") && this.alias.equals(airline.getAlias())){
 			throw new DataException("This Alias already Exists, Please Choose Another.");
 		}
 		if (!this.callSign.equals("") && this.callSign.equals(airline.getCallSign())){
diff --git a/src/main/java/seng202/group9/GUI/AirlineAddController.java b/src/main/java/seng202/group9/GUI/AirlineAddController.java
index 8d08691..c736075 100644
--- a/src/main/java/seng202/group9/GUI/AirlineAddController.java
+++ b/src/main/java/seng202/group9/GUI/AirlineAddController.java
@@ -1,6 +1,5 @@
 package seng202.group9.GUI;
 
-import javafx.collections.FXCollections;
 import javafx.fxml.FXML;
 import javafx.scene.control.Alert;
 import javafx.scene.control.Button;
@@ -9,10 +8,12 @@ import javafx.stage.Stage;
 import seng202.group9.Controller.Dataset;
 
 /**
- * Created by Sunguin on 2016/09/22.
+ * The GUI controller class for airline_add_form.fxml.
+ * Extends from the abstract class {@link Controller}.
+ * Created by Sunguin
  */
 public class AirlineAddController extends Controller {
-    //Setting up text fields for adding data
+    //Setting up text fields for adding data.
     @FXML
     private TextField airlNameAdd;
     @FXML
@@ -30,8 +31,16 @@ public class AirlineAddController extends Controller {
     @FXML
     private Button addButton;
 
+    //Set an empty Dataset to be assigned to the current dataset.
     private Dataset theDataSet = null;
 
+    /**
+     * Loads up the current dataset.
+     */
+    public void load() {
+        theDataSet = getParent().getCurrentDataset();
+    }
+
     /**
      * Adds a single airline entry to the database.
      * Takes in values from the GUI the user has typed in.
@@ -58,26 +67,23 @@ public class AirlineAddController extends Controller {
             airlCountryAdd.clear();
             airlActiveAdd.clear();
 
+            //Saying to the user that the airline has successfully added.
             Alert alert = new Alert(Alert.AlertType.INFORMATION);
             alert.setTitle("Airline Add Successful");
             alert.setHeaderText("New Airline added!");
             alert.setContentText("Your new airline has been successfully added into the database.");
             alert.showAndWait();
 
+            //Closes the add form.
             Stage stage = (Stage) addButton.getScene().getWindow();
             stage.close();
-
         } catch (Exception e) {
+            //Tells the user what and where the error is.
             Alert alert = new Alert(Alert.AlertType.ERROR);
             alert.setTitle("Airline Data Error");
             alert.setHeaderText("Error adding a custom airline entry.");
             alert.setContentText(e.getMessage());
             alert.showAndWait();
         }
-
-    }
-
-    public void load() {
-        theDataSet = getParent().getCurrentDataset();
     }
 }
diff --git a/src/main/java/seng202/group9/GUI/AirlineEditController.java b/src/main/java/seng202/group9/GUI/AirlineEditController.java
index 8737858..545e5e4 100644
--- a/src/main/java/seng202/group9/GUI/AirlineEditController.java
+++ b/src/main/java/seng202/group9/GUI/AirlineEditController.java
@@ -11,14 +11,14 @@ import seng202.group9.Controller.EntryParser;
 import seng202.group9.Controller.Session;
 import seng202.group9.Core.Airline;
 
-import java.util.ArrayList;
-import java.util.HashMap;
 
 /**
- * Created by Sunguin on 2016/09/24.
+ * The GUI controller class for airline_edit_form.fxml.
+ * Extends from the abstract class {@link Controller}.
+ * Created by Sunguin
  */
 public class AirlineEditController extends Controller {
-    //Setting up text fields for editing data
+    //Setting up text fields for editing data.
     @FXML
     private TextField airlNameEdit;
     @FXML
@@ -36,12 +36,43 @@ public class AirlineEditController extends Controller {
     @FXML
     private Button applyButton;
 
+    //Sets up an empty Dataset to be assigned to the current dataset.
     private Dataset theDataSet = null;
+    //Sets up an empty session to be assigned to the current session.
     private Session currentSession = null;
-
+    //Sets up an empty airline to be assigned to the airline being edited.
     private Airline toEdit = null;
 
+
+    /**
+     * Loads up the current dataset and current session.
+     * Also gets the airline to be edited from the table.
+     * Sets the text fields as the airline selected.
+     */
+    public void load() {
+        theDataSet = getParent().getCurrentDataset();
+        currentSession = getParent().getSession();
+
+        toEdit = theDataSet.getAirlineDictionary().get(currentSession.getAirlineToEdit());
+
+        airlNameEdit.setText(toEdit.getName());
+        airlAliasEdit.setText(toEdit.getAlias());
+        airlIATAEdit.setText(toEdit.getIATA());
+        airlICAOEdit.setText(toEdit.getICAO());
+        airlCallsignEdit.setText(toEdit.getCallSign());
+        airlCountryEdit.setText(toEdit.getCountryName());
+        airlActiveEdit.setText(toEdit.getActive());
+    }
+
+
+    /**
+     * Edits the current airline and closes the popup window.
+     * Takes in the values from the text fields.
+     * @see Dataset
+     */
     public void editAirline() {
+        //Tries to edit an airport and comes up with a popup if successful and exits the popup.
+        //Otherwise an error message will pop up with what is wrong.
         try {
             EntryParser parser = new EntryParser();
             parser.parseAirline(airlNameEdit.getText(), airlAliasEdit.getText(), airlIATAEdit.getText(),
@@ -61,19 +92,4 @@ public class AirlineEditController extends Controller {
             System.err.println("RIP Harambe: " + e.getMessage() + "IT WAS TOO SOON");
         }
     }
-
-    public void load() {
-        theDataSet = getParent().getCurrentDataset();
-        currentSession = getParent().getSession();
-
-        toEdit = theDataSet.getAirlineDictionary().get(currentSession.getAirlineToEdit());
-
-        airlNameEdit.setText(toEdit.getName());
-        airlAliasEdit.setText(toEdit.getAlias());
-        airlIATAEdit.setText(toEdit.getIATA());
-        airlICAOEdit.setText(toEdit.getICAO());
-        airlCallsignEdit.setText(toEdit.getCallSign());
-        airlCountryEdit.setText(toEdit.getCountryName());
-        airlActiveEdit.setText(toEdit.getActive());
-    }
 }
diff --git a/src/main/java/seng202/group9/GUI/AirlineFilterController.java b/src/main/java/seng202/group9/GUI/AirlineFilterController.java
index 7a6b88c..b8db03f 100644
--- a/src/main/java/seng202/group9/GUI/AirlineFilterController.java
+++ b/src/main/java/seng202/group9/GUI/AirlineFilterController.java
@@ -17,7 +17,9 @@ import java.util.ArrayList;
 import java.util.HashMap;
 
 /**
- * Created by Sunguin on 2016/09/22.
+ * The GUI controller class for airline_filter_form.fxml.
+ * Extends from the abstract class {@link Controller}.
+ * Created by Sunguin
  */
 public class AirlineFilterController extends Controller {
 
@@ -42,6 +44,14 @@ public class AirlineFilterController extends Controller {
     private Dataset theDataSet = null;
     private Session currentSession = null;
 
+    /**
+     * Loads up the current dataset and current session.
+     */
+    public void load() {
+        theDataSet = getParent().getCurrentDataset();
+        currentSession = getParent().getSession();
+    }
+
     /**
      * Filters airlines by any field.
      * These are specified by what the user has typed in the filter boxes.
@@ -79,22 +89,17 @@ public class AirlineFilterController extends Controller {
         alert.setContentText("Your airline data has been successfully filtered.");
         alert.showAndWait();
 
-        //currentSession.setFilteredAirlines(FXCollections.observableArrayList(filter.getFilteredData()));
-
+        //Creates a new hashmap for airlines and fills it with airlines that fit the criteria specified by the user.
+        //Saves it into the current session.
         HashMap<Integer, String> airlinesHM = new HashMap<Integer, String>();
         ArrayList<Airline> airlines = filter.getFilteredData();
-        //for (Airline airline: airlines) {
         for (int index = 0; index < airlines.size(); index++) {
             airlinesHM.put(index, airlines.get(index).getName());
         }
         currentSession.setFilteredAirlines(airlinesHM);
 
+        //Closes the popup.
         Stage stage = (Stage) applyButton.getScene().getWindow();
         stage.close();
     }
-
-    public void load() {
-        theDataSet = getParent().getCurrentDataset();
-        currentSession = getParent().getSession();
-    }
 }
diff --git a/src/main/java/seng202/group9/GUI/AirlineRDController.java b/src/main/java/seng202/group9/GUI/AirlineRDController.java
index d2415bc..475b392 100644
--- a/src/main/java/seng202/group9/GUI/AirlineRDController.java
+++ b/src/main/java/seng202/group9/GUI/AirlineRDController.java
@@ -69,7 +69,7 @@ public class AirlineRDController extends Controller {
 
 
     /**
-     * Opens the Airline add form.
+     * Opens the Airline Add form.
      */
     public void openAdd() {
         createPopUpStage(SceneCode.AIRLINE_ADD, 600, 370);
@@ -118,6 +118,9 @@ public class AirlineRDController extends Controller {
         }
     }
 
+    /**
+     * Opens the Airline Edit form.
+     */
     public void editAirline() {
         Airline toEdit = tableViewAirlineRD.getSelectionModel().getSelectedItem();
         currentSession.setAirlineToEdit(toEdit.getName());
@@ -137,6 +140,9 @@ public class AirlineRDController extends Controller {
         JOptionPane.showMessageDialog(null, "This is not Implemented yet");
     }
 
+    /**
+     * Goes to the airline summary page.
+     */
     public void airlineSummaryButton() {
         replaceSceneContent(SceneCode.AIRLINE_SUMMARY);
     }