From b2cba96dc19985f21606fc655ce281dd23ebaa4a Mon Sep 17 00:00:00 2001 From: Sunguin Peng Date: Sun, 18 Sep 2016 10:38:54 +1200 Subject: [PATCH] Added javadoc for airline, airport and route raw data controller classes. --- res/userdb.db | Bin 4370432 -> 4370432 bytes .../group9/GUI/AirlineRDController.java | 56 +++++++++++----- .../group9/GUI/AirportRDController.java | 23 +++++++ .../seng202/group9/GUI/RouteRDController.java | 61 +++++++++++------- 4 files changed, 100 insertions(+), 40 deletions(-) diff --git a/res/userdb.db b/res/userdb.db index e29a483fc9ba2bd33e80d341a861ccc9080dc0c2..f83f4fdea289522eea82a9709b5dc166d60eaa33 100644 GIT binary patch delta 250 zcmWN=xiUjh0D$2+xgz%E+U1g1V&8YM<GAyZ#$f%6TxJ<~TOv$vA zC6gJMm5NklPUdAn7NsUjvMejIDr>SX8?q@|vMoEZD|@mp2XZJ!ax5ouDs?%NbGeX9 oxst{=@$)s@wu^7^J_&cNhxhoEWZ|(@YSik_F^}z-U;kA80PAyAV*mgE delta 250 zcmWN=$u2`t0D$3~UR5*KOea&#^Q@*G5<5F9tAFV+YVk*c#I@=RSlLULUZs!1mwe66 zYp(e}D~9y5bQ{uVBuGvY>5{y3OF??1SNf!124ql%WLQQdl~Ea!ahZ@wnUZOlky$B9 zNy<`@s?5o}EXblPNllhzMOI}^)@4IBWlOeYM|NdT_T@khT)g@aw%7G nEsY=I*IT%6=ilQ)67E`$AMraWho@GdQLDeiEVg5I^IQD`=aW@M diff --git a/src/main/java/seng202/group9/GUI/AirlineRDController.java b/src/main/java/seng202/group9/GUI/AirlineRDController.java index 8a447de..9363e79 100644 --- a/src/main/java/seng202/group9/GUI/AirlineRDController.java +++ b/src/main/java/seng202/group9/GUI/AirlineRDController.java @@ -9,6 +9,8 @@ import seng202.group9.Controller.Dataset; import seng202.group9.Core.Airline; /** + * The GUI controller class for airline_raw_data.fxml. + * Extends from the abstract class {@link Controller}. * Created by Sunguin on 2016/09/13. */ public class AirlineRDController extends Controller { @@ -64,6 +66,32 @@ public class AirlineRDController extends Controller { private Dataset theDataSet = null; + /** + * Loads the initial airline data to the GUI table. + * Also sets up the dropdown menu options. + */ + public void load() { + airlIDcol.setCellValueFactory(new PropertyValueFactory("ID")); + airlNamecol.setCellValueFactory(new PropertyValueFactory("Name")); + airlAliascol.setCellValueFactory(new PropertyValueFactory("Alias")); + airlIATAcol.setCellValueFactory(new PropertyValueFactory("IATA")); + airlICAOcol.setCellValueFactory(new PropertyValueFactory("ICAO")); + airlCallsigncol.setCellValueFactory(new PropertyValueFactory("CallSign")); + airlCountrycol.setCellValueFactory(new PropertyValueFactory("CountryName")); + airlActivecol.setCellValueFactory(new PropertyValueFactory("Active")); + + theDataSet = getParent().getCurrentDataset(); + tableViewAirlineRD.setItems(FXCollections.observableArrayList(theDataSet.getAirlines())); + + airlActiveCBox.setValue("Y"); + airlActiveCBox.getItems().addAll("Y", "N"); + } + + /** + * Adds a single airline entry to the database. + * Takes in values from the GUI the user has typed in. + * @see Dataset + */ public void addAirlineSingle() { try { theDataSet.addAirline( @@ -92,29 +120,23 @@ public class AirlineRDController extends Controller { } } - public void load() { - airlIDcol.setCellValueFactory(new PropertyValueFactory("ID")); - airlNamecol.setCellValueFactory(new PropertyValueFactory("Name")); - airlAliascol.setCellValueFactory(new PropertyValueFactory("Alias")); - airlIATAcol.setCellValueFactory(new PropertyValueFactory("IATA")); - airlICAOcol.setCellValueFactory(new PropertyValueFactory("ICAO")); - airlCallsigncol.setCellValueFactory(new PropertyValueFactory("CallSign")); - airlCountrycol.setCellValueFactory(new PropertyValueFactory("CountryName")); - airlActivecol.setCellValueFactory(new PropertyValueFactory("Active")); - - theDataSet = getParent().getCurrentDataset(); - tableViewAirlineRD.setItems(FXCollections.observableArrayList(theDataSet.getAirlines())); - - airlActiveCBox.setValue("Y"); - airlActiveCBox.getItems().addAll("Y", "N"); - } - + /** + * Deletes a single selected airline entry from the database. + * Updates the GUI accordingly. + * @see Dataset + */ public void deleteAirline() { Airline toDelete = tableViewAirlineRD.getSelectionModel().getSelectedItem(); theDataSet.deleteAirline(toDelete); tableViewAirlineRD.setItems(FXCollections.observableArrayList(theDataSet.getAirlines())); } + /** + * Filters airlines by any field. + * These are specified by what the user has typed in the filter boxes. + * Updates the GUI accordingly. + * @see AirlineFilter + */ public void filterAirlines() { AirlineFilter filter = new AirlineFilter(theDataSet.getAirlines()); if (airlNameFilter.getText() != null) { diff --git a/src/main/java/seng202/group9/GUI/AirportRDController.java b/src/main/java/seng202/group9/GUI/AirportRDController.java index 9ac178e..7ed2ebe 100644 --- a/src/main/java/seng202/group9/GUI/AirportRDController.java +++ b/src/main/java/seng202/group9/GUI/AirportRDController.java @@ -12,6 +12,8 @@ import seng202.group9.Core.Airport; import static javafx.collections.FXCollections.observableArrayList; /** + * The GUI controller class for airport_raw_data.fxml. + * Extends from the abstract class {@link Controller}. * Created by Sunguin on 2016/09/13. */ public class AirportRDController extends Controller{ @@ -91,6 +93,10 @@ public class AirportRDController extends Controller{ private Dataset theDataSet = null; + /** + * Loads the initial airport data to the GUI table. + * Also sets up the dropdown menu options. + */ public void load() { airpIDcol.setCellValueFactory(new PropertyValueFactory("ID")); airpNamecol.setCellValueFactory(new PropertyValueFactory("Name")); @@ -112,6 +118,11 @@ public class AirportRDController extends Controller{ airpDSTCBox.getItems().addAll("E", "A", "S", "O", "Z", "N", "U"); } + /** + * Adds a single airport entry in the database. + * Takes in values from the GUI the user has typed in. + * @see Dataset + */ public void addAirportSingle() { try { theDataSet.addAirport( @@ -146,16 +157,28 @@ public class AirportRDController extends Controller{ alert.showAndWait(); } } + public void airportAnalyserButton() { replaceSceneContent(SceneCode.AIRPORT_ANALYSER); } + /** + * Deletes a single selected airport entry from the database. + * Updates the GUI accordingly. + * @see Dataset + */ public void deleteAirport(){ Airport toDelete = tableViewAirportRD.getSelectionModel().getSelectedItem(); theDataSet.deleteAirport(toDelete); tableViewAirportRD.setItems(observableArrayList(theDataSet.getAirports())); } + /** + * Filters the airports table by any field. + * These are specified by what the user has typed in the filter boxes. + * Updates the GUI accordingly. + * @see AirportFilter + */ public void filterAirports() { AirportFilter filter = new AirportFilter(theDataSet.getAirports()); if (airpNameFilter.getText() != null) { diff --git a/src/main/java/seng202/group9/GUI/RouteRDController.java b/src/main/java/seng202/group9/GUI/RouteRDController.java index 4f5194a..6ae8d2c 100644 --- a/src/main/java/seng202/group9/GUI/RouteRDController.java +++ b/src/main/java/seng202/group9/GUI/RouteRDController.java @@ -4,14 +4,14 @@ import javafx.collections.FXCollections; import javafx.fxml.FXML; import javafx.scene.control.*; import javafx.scene.control.cell.PropertyValueFactory; -import seng202.group9.Controller.DataException; import seng202.group9.Controller.Dataset; import seng202.group9.Controller.SceneCode; import seng202.group9.Controller.RouteFilter; import seng202.group9.Core.Route; /** - * Controller class for the Routes Raw Data scene. + * The GUI controller class for route_raw_data.fxml. + * Extends from the abstract class {@link Controller}. * Created by Sunguin on 2016/09/14. */ public class RouteRDController extends Controller { @@ -66,8 +66,31 @@ public class RouteRDController extends Controller { private Dataset theDataSet = null; /** - * Adds a single route to the Route database. - * Takes in values written from the GUI. + * Loads the initial route data to the GUI table. + * Also sets up the dropdown menu options. + */ + public void load() { + rAirlineCol.setCellValueFactory(new PropertyValueFactory("AirlineName")); + rAirlineIDCol.setCellValueFactory(new PropertyValueFactory("AirlineID")); + rSourceCol.setCellValueFactory(new PropertyValueFactory("DepartureAirport")); + rSourceIDCol.setCellValueFactory(new PropertyValueFactory("SourceID")); + rDestCol.setCellValueFactory(new PropertyValueFactory("ArrivalAirport")); + rDestIDCol.setCellValueFactory(new PropertyValueFactory("DestID")); + rCodeshareCol.setCellValueFactory(new PropertyValueFactory("Code")); + rStopsCol.setCellValueFactory(new PropertyValueFactory("Stops")); + rEquipmentCol.setCellValueFactory(new PropertyValueFactory("Equipment")); + + theDataSet = getParent().getCurrentDataset(); + tableViewRouteRD.setItems(FXCollections.observableArrayList(theDataSet.getRoutes())); + + rCodeshareCBox.setValue(""); + rCodeshareCBox.getItems().addAll("Y", ""); + } + + /** + * Adds a single route entry in the database. + * Takes in values from the GUI the user has typed in. + * @see Dataset */ public void addRouteSingle() { try { @@ -96,31 +119,23 @@ public class RouteRDController extends Controller { } } - public void load() { - rAirlineCol.setCellValueFactory(new PropertyValueFactory("AirlineName")); - rAirlineIDCol.setCellValueFactory(new PropertyValueFactory("AirlineID")); - rSourceCol.setCellValueFactory(new PropertyValueFactory("DepartureAirport")); - rSourceIDCol.setCellValueFactory(new PropertyValueFactory("SourceID")); - rDestCol.setCellValueFactory(new PropertyValueFactory("ArrivalAirport")); - rDestIDCol.setCellValueFactory(new PropertyValueFactory("DestID")); - rCodeshareCol.setCellValueFactory(new PropertyValueFactory("Code")); - rStopsCol.setCellValueFactory(new PropertyValueFactory("Stops")); - rEquipmentCol.setCellValueFactory(new PropertyValueFactory("Equipment")); - - theDataSet = getParent().getCurrentDataset(); - tableViewRouteRD.setItems(FXCollections.observableArrayList(theDataSet.getRoutes())); - - rCodeshareCBox.setValue(""); - rCodeshareCBox.getItems().addAll("Y", ""); - - } - + /** + * Deletes a single selected route entry from the database. + * Updates the GUI accordingly. + * @see Dataset + */ public void deleteRoute(){ Route toDelete = tableViewRouteRD.getSelectionModel().getSelectedItem(); theDataSet.deleteRoute(toDelete); tableViewRouteRD.setItems(FXCollections.observableArrayList(theDataSet.getRoutes())); } + /** + * Filters the routes table by any field. + * These are specified by what the user has typed in the filter boxes. + * Updates the GUI accordingly. + * @see RouteFilter + */ public void filterRoutes(){ RouteFilter filter = new RouteFilter(theDataSet.getRoutes()); if (rAirlineFilter.getText() != null) {