Added java doc to route as well as reordered the constructor to match openflights.org/data

src/main/java/seng202/group9/Core/Route.java

@@ -1,16 +1,30 @@
 package seng202.group9.Core;
 
+/**
+ * Route Class
+ * @author Fan-Wu Yang
+ *
+ */
 public class Route {
 	private int ID;
 	private int stops;
 	private String codeShare;
 	private String equipment;
-	private Airline airline;
+	private String airline;
-	private Airport departureAirport;
+	private String departureAirport;
-	private Airport arrivalAirport;
+	private String arrivalAirport;
-	
+	/**
-	public Route(int ID, int stops, String codeShare, String equipment, Airline airline,
+	 * Constructor
-			Airport departureAirport, Airport arrivalAirport){
+	 * @param airline
+	 * @param ID
+	 * @param departureAirport
+	 * @param arrivalAirport
+	 * @param codeShare
+	 * @param stops
+	 * @param equipment
+	 */
+	public Route(String airline, int ID, String departureAirport, String arrivalAirport,
+			String codeShare, int stops, String equipment){
 		this.ID = ID;
 		this.stops = stops;
 		this.codeShare = codeShare;
@@ -19,72 +33,109 @@ public class Route {
 		this.departureAirport = departureAirport;
 		this.arrivalAirport = arrivalAirport;
 	}
-	
+	/**
+	 * Returns code share of the route
+	 * @return
+	 */
 	public String getCodeShare() {
 		return codeShare;
 	}
-
+	/**
+	 * sets code share of the route
+	 * @param codeShare
+	 */
 	public void setCodeShare(String codeShare) {
 		this.codeShare = codeShare;
 	}
-
+	/**
-	public Airport getDepartureAirport() {
+	 * Sets departure Airport
-		return departureAirport;
+	 * @param departureAirport
-	}
+	 */
-
+	public void setDepartureAirport(String  departureAirport) {
-	public void setDepartureAirport(Airport departureAirport) {
 		this.departureAirport = departureAirport;
 	}
-
+	/**
-	public Airport getArrivalAirport() {
+	 * sets the arrival airport
-		return arrivalAirport;
+	 * @param arrivalAirport
-	}
+	 */
-
+	public void setArrivalAirport(String arrivalAirport) {
-	public void setArrivalAirport(Airport arrivalAirport) {
 		this.arrivalAirport = arrivalAirport;
 	}
-
+	/**
+	 * sets id fo the route
+	 * @param iD
+	 */
 	public void setID(int iD) {
 		ID = iD;
 	}
-
+	/**
+	 * sets number of stops
+	 * @param stops
+	 */
 	public void setStops(int stops) {
 		this.stops = stops;
 	}
-
+	/**
+	 * sets equipment for the route
+	 * @param equipment
+	 */
 	public void setEquipment(String equipment) {
 		this.equipment = equipment;
 	}
-
+	/**
-	public void setAirline(Airline airline) {
+	 * sets airline that flies this route
+	 * @param airline
+	 */
+	public void setAirline(String airline) {
 		this.airline = airline;
 	}
-
+	/**
+	 * returns the id of this route
+	 * @return
+	 */
 	public int getID(){
 		return ID;
 	}
-	
+	/**
+	 * returns the number of stops the route stops.
+	 * @return
+	 */
 	public int getStops(){
 		return stops;
 	}
-	
+	/**
+	 * returns codeshare of the route
+	 * @return
+	 */
 	public String getCode(){
 		return codeShare;
 	}
-	
+	/**
+	 * return equipment for the route
+	 * @return
+	 */
 	public String getEquipment(){
 		return equipment;
 	}
-	
+	/**
-	public Airline getAirline(){
+	 * returns the airline that flies this route
+	 * @return
+	 */
+	public String getAirline(){
 		return airline;
 	}
-	
+	/**
-	public Airport departsFrom(){
+	 * returns the source airport of this route
+	 * @return
+	 */
+	public String departsFrom(){
 		return departureAirport;
 	}
-	
+	/**
-	public Airport arrivesAt(){
+	 * returns the target airport of this route.
+	 * @return
+	 */
+	public String arrivesAt(){
 		return arrivalAirport;
 	}