Created TrainApi, updated VehiclePositionApi

src/ApiTestFile.java

@@ -8,19 +8,19 @@
 
 
 public class ApiTestFile {
-    private static final String API_URL = "https://api.translink.ca/rttiapi/v1/stops/55612?";
+    private static final String PARTIAL_API_URL = "OpenDataAPI/api/V1";
 
     public static void getStopInformation() {
         OkHttpClient client = new OkHttpClient().newBuilder()
                 .build();
         HttpUrl httpUrl = new HttpUrl.Builder()
-                .scheme("https")
-                .host("api.translink.ca")
-                .addPathSegment("rttiapi")
-                .addPathSegment("v1")
-                .addPathSegment("stops")
-                .addPathSegment("55612?")
-                .addQueryParameter("apikey", System.getenv("API_KEY"))
+                .scheme("http")
+                .host("api.openmetrolinx.com")
+                .addPathSegment(PARTIAL_API_URL)
+                .addPathSegment("Stop")
+                .addPathSegment("Details")
+                .addPathSegment("UN") //getting station information for UN, which denotes Union Station
+                .addQueryParameter("key", System.getenv("API_KEY"))
                 .build();
 
         Request request = new Request.Builder()

src/app/Main.java

@@ -1,9 +1,12 @@
 package app;
 
-import data_access.FileStationDataAccessObject;
+import data_access.text_file.FileStationDataAccessObject;
+import data_access.API.GOStationApiClass;
 import entity.StationFactory;
 import interface_adapter.search.SearchViewModel;
 import interface_adapter.ViewManagerModel;
+import interface_adapter.show_incoming_vehicles.ShowIncomingVehiclesState;
+import interface_adapter.show_incoming_vehicles.ShowIncomingVehiclesViewModel;
 import interface_adapter.station_info.StationInfoViewModel;
 import view.SearchPanelView;
 import view.StationInfoView;
@@ -38,6 +41,8 @@ public static void main(String[] args) {
         // be observed by the Views.
         SearchViewModel searchViewModel = new SearchViewModel();
         StationInfoViewModel stationInfoViewModel = new StationInfoViewModel();
+        ShowIncomingVehiclesViewModel showIncomingVehiclesViewModel = new ShowIncomingVehiclesViewModel();
+
 
         // Creating a DAO called stationDataAccessObject by reading from file revisedStopData.txt, with the creation of the object being done by StationFactory()
         // Note: This process is wrapped in a try-catch block since it is possible that the code throws out an IOException (occurs when the txt file being read does not exist)
@@ -47,7 +52,7 @@ public static void main(String[] args) {
         // TODO [Implementation question]: Is there suppose to be NO ARGUMENT for the StationFactory() instance passed inside?
         FileStationDataAccessObject stationDataAccessObject;
         try {
-            stationDataAccessObject = new FileStationDataAccessObject("./revisedStopData.txt", new StationFactory());
+            stationDataAccessObject = new FileStationDataAccessObject("./revisedStopData.txt", new StationFactory(), new GOStationApiClass());
         } catch (IOException e) {
             throw new RuntimeException(e);
         }
@@ -58,7 +63,7 @@ public static void main(String[] args) {
 
         // Creating an instance of StationInfoView. Note: Although this view should have its own use case, for now, since we are NOT displaying other data besides the station name, there is no useCaseFactory for this case
         // This View is only linked to transition from the SearchPanelView (once the other use case are integrated into this view, this will NO LONGER be the case)
-        StationInfoView stationInfoView = new StationInfoView(stationInfoViewModel);
+        StationInfoView stationInfoView = StationInfoUseCaseFactory.create(viewManagerModel, stationInfoViewModel, stationDataAccessObject, showIncomingVehiclesViewModel);
         views.add(stationInfoView, stationInfoView.viewName);
 
         // When initially booting up the application, the stationPanel is the 1st panel displayed to viewers.

src/app/SearchUseCaseFactory.java

@@ -46,9 +46,11 @@ private static SearchController createSearchUseCase(
         // Notice how we pass this method's parameters to the Presenter.
         SearchOutputBoundary searchOutputBoundary = new SearchPresenter(searchViewModel, stationInfoViewModel, viewManagerModel);
 
+        // TODO [Implementation question]: No need to use an instance of SearchUseCaseFactory right?
+
         SearchInputBoundary searchInteractor = new SearchInteractor(
                 searchDataAccessObject, searchOutputBoundary);
 
         return new SearchController(searchInteractor);
     }
-}
+}

src/app/StationInfoUseCaseFactory.java

@@ -0,0 +1,54 @@
+package app;
+
+import interface_adapter.ViewManagerModel;
+import interface_adapter.show_incoming_vehicles.ShowIncomingVehiclesViewModel;
+import interface_adapter.station_info.StationInfoController;
+import interface_adapter.station_info.StationInfoPresenter;
+import interface_adapter.station_info.StationInfoViewModel;
+import use_case.StationInfo.StationInfoDataAccessInterface;
+import use_case.StationInfo.StationInfoInputBoundary;
+import use_case.StationInfo.StationInfoInteractor;
+import use_case.StationInfo.StationInfoOutputBoundary;
+import view.StationInfoView;
+
+import javax.swing.*;
+import java.io.IOException;
+
+public class StationInfoUseCaseFactory {
+
+    /** Prevent instantiation. */
+    private StationInfoUseCaseFactory() {}
+
+    public static StationInfoView create(
+            ViewManagerModel viewManagerModel,
+            StationInfoViewModel stationInfoViewModel,
+            StationInfoDataAccessInterface stationInfoDataAccessObject,
+            ShowIncomingVehiclesViewModel showIncomingVehiclesViewModel) {
+
+        try {
+            StationInfoController stationInfoController = createStationInfoUseCase(viewManagerModel,
+                    stationInfoViewModel, stationInfoDataAccessObject, showIncomingVehiclesViewModel);
+            return new StationInfoView(stationInfoViewModel, stationInfoController);
+        } catch (IOException e) {
+            JOptionPane.showMessageDialog(null, "Could not open user data file.");
+        }
+
+        return null;
+    }
+
+    private static StationInfoController createStationInfoUseCase(
+            ViewManagerModel viewManagerModel,
+            StationInfoViewModel stationInfoViewModel,
+            StationInfoDataAccessInterface stationInfoDataAccessObject,
+            ShowIncomingVehiclesViewModel showIncomingVehiclesViewModel) throws IOException {
+
+        // Notice how we pass this method's parameters to the Presenter.
+        StationInfoOutputBoundary stationInfoOutputBoundary = new StationInfoPresenter(stationInfoViewModel,
+                showIncomingVehiclesViewModel, viewManagerModel);
+
+        StationInfoInputBoundary stationInfoInteractor = new StationInfoInteractor(
+                stationInfoDataAccessObject, stationInfoOutputBoundary);
+
+        return new StationInfoController(stationInfoInteractor);
+    }
+}

src/data_access/API/GOStationApiClass.java

@@ -0,0 +1,57 @@
+package data_access.API;
+
+import okhttp3.HttpUrl;
+import okhttp3.OkHttpClient;
+import okhttp3.Request;
+import okhttp3.Response;
+import org.json.JSONArray;
+import org.json.JSONException;
+import org.json.JSONObject;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+public class GOStationApiClass implements TrainApiInterface {
+
+    private final String PARTIAL_API_URL = "OpenDataAPI/api/V1";
+    public GOStationApiClass () {
+    }
+    public List<String> retrieveStationAmenities(String stationId){
+        OkHttpClient client = new OkHttpClient().newBuilder()
+                .build();
+        HttpUrl httpUrl = new HttpUrl.Builder()
+                .scheme("http")
+                .host("api.openmetrolinx.com")
+                .addPathSegment(PARTIAL_API_URL)
+                .addPathSegment("Stop")
+                .addPathSegment("Details")
+                .addPathSegment(stationId) //getting station information for the station with the id denoted by stationId
+                .addQueryParameter("key", API_KEY)
+                .build();
+
+        Request request = new Request.Builder()
+                .url(httpUrl)
+                .addHeader("content-type", "application/json")
+                .build();
+        try {
+            // TODO: Do we need additional error checking based on error codes in Metadata?
+            Response response = client.newCall(request).execute();
+            String fullStopJsonData = response.body().string();
+            JSONObject fullStopJsonObj = new JSONObject(fullStopJsonData); // This is where the metadata is located at
+            JSONObject stopJsonDataObj = fullStopJsonObj.getJSONObject("Stop");
+            JSONArray amenitiesJsonArray = stopJsonDataObj.getJSONArray("Facilities");
+            List<String> amenitiesList = new ArrayList<String>();
+            for (int i = 0; i < amenitiesJsonArray.length(); i++) {
+                JSONObject currAmenitiesEntry = amenitiesJsonArray.getJSONObject(i);
+                amenitiesList.add(currAmenitiesEntry.getString("Description"));
+                //System.out.println(currAmenitiesEntry.getString("Description")); // For debugging purposes
+            }
+            return amenitiesList;
+
+        } catch (IOException | JSONException e) {
+            throw new RuntimeException(e);
+        }
+
+    }
+}

src/data_access/API/GOTrainsApiClass.java

@@ -0,0 +1,70 @@
+package data_access.API;
+
+import okhttp3.HttpUrl;
+import okhttp3.OkHttpClient;
+import okhttp3.Request;
+import okhttp3.Response;
+import org.json.JSONArray;
+import org.json.JSONException;
+import org.json.JSONObject;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+public class GOTrainsApiClass implements TrainApiInterface {
+
+    private final String PARTIAL_API_URL = "OpenDataAPI/api/V1";
+    public GOTrainsApiClass () {
+    }
+
+    /**
+     * Searches for all trains and their information including ID and position.
+     *
+     * @param stationId ID of station for incoming trains
+     * @return      API information
+     */
+    public List<String> retrieveTrains(String stationId){
+        OkHttpClient client = new OkHttpClient().newBuilder()
+                .build();
+        HttpUrl httpUrl = new HttpUrl.Builder()
+                .scheme("http")
+                .host("api.openmetrolinx.com")
+                .addPathSegment(PARTIAL_API_URL)
+                .addPathSegment("ServiceataGlance")
+                .addPathSegment("Trains")
+                .addPathSegment("All")
+                // TODO: may need for future
+                // .addPathSegment(stationId) //getting station information for the station with the id denoted by stationId
+                .addQueryParameter("key", API_KEY)
+                .build();
+
+        Request request = new Request.Builder()
+                .url(httpUrl)
+                .addHeader("content-type", "application/json")
+                .build();
+
+        /**
+         * Search for information
+         */
+        try {
+            Response response = client.newCall(request).execute();
+            String trainJsonData = response.body().string();
+            JSONObject metaDataJsonObj = new JSONObject(trainJsonData); // This is where the Metadata is located at
+            JSONObject tripsJsonDataObj = metaDataJsonObj.getJSONObject("Trips");
+            JSONArray tripJsonArray = tripsJsonDataObj.getJSONArray("Trip");
+            List<String> tripList = new ArrayList<String>();
+            for (int i = 0; i < tripJsonArray.length(); i++) {
+                JSONObject currTripEntry = tripJsonArray.getJSONObject(i);
+                tripList.add(currTripEntry.getString("id")); // left at "id" for now, to be changed to vehicle
+                //System.out.println(currAmenitiesEntry.getString("Description")); // For debugging purposes
+                System.out.println(httpUrl);
+            }
+            return tripList; // do not print this yet, wait for full change
+
+        } catch (IOException | JSONException e) {
+            throw new RuntimeException(e);
+        }
+
+    }
+}

src/data_access/API/GOVehicleApiClass.java

@@ -0,0 +1,75 @@
+package data_access.API;
+
+import okhttp3.HttpUrl;
+import okhttp3.OkHttpClient;
+import okhttp3.Request;
+import okhttp3.Response;
+import org.json.JSONArray;
+import org.json.JSONException;
+import org.json.JSONObject;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+import static data_access.API.TrainApiInterface.API_KEY;
+
+public class GOVehicleApiClass {
+    private final String PARTIAL_API_URL = "OpenDataAPI/api/V1";
+    public GOVehicleApiClass() {
+    }
+    public List<List<String>> retrieveVehicleInfo(String stationId){
+        OkHttpClient client = new OkHttpClient().newBuilder()
+                .build();
+        HttpUrl httpUrl = new HttpUrl.Builder()
+                .scheme("http")
+                .host("api.openmetrolinx.com")
+                .addPathSegment(PARTIAL_API_URL)
+                .addPathSegment("Stop")
+                .addPathSegment("NextService")
+                .addPathSegment(stationId)
+                .addQueryParameter("key", API_KEY)
+                .build();
+
+        Request request = new Request.Builder()
+                .url(httpUrl)
+                .addHeader("content-type", "application/json")
+                .build();
+        try {
+            Response response = client.newCall(request).execute();
+            String trainInfoJsonData = response.body().string();
+            JSONObject headerPositionJsonObj = new JSONObject(trainInfoJsonData); // This is where the header is located at
+
+            JSONObject stationServiceJsonObj = headerPositionJsonObj.getJSONObject("NextService");
+            JSONArray vehiclesJsonArray = stationServiceJsonObj.getJSONArray("Lines");
+
+            List<List<String>> vehiclesList = new ArrayList<>();
+            for (int i = 0; i < vehiclesJsonArray.length(); i++) {
+                JSONObject currtripEntry = vehiclesJsonArray.getJSONObject(i);
+                List<String> vehiclesInfoList = new ArrayList<>();
+                vehiclesInfoList.add(currtripEntry.getString("LineCode")); // parent line id of the station
+                vehiclesInfoList.add(currtripEntry.getString("LineName")); // parent line full name
+                vehiclesInfoList.add(currtripEntry.getString("ServiceType"));
+                // indicates if vehicle is a train or a bus. Train is "T", Bus is "B"
+                vehiclesInfoList.add(currtripEntry.getString("DirectionName")); // Vehicle display name
+                vehiclesInfoList.add(currtripEntry.getString("ScheduledDepartureTime"));
+                // vehicle scheduled departure time from this station
+                vehiclesInfoList.add(currtripEntry.getString("ComputedDepartureTime"));
+                // vehicle actual departure time from this station
+                vehiclesInfoList.add(currtripEntry.getString("TripNumber"));
+                // We could calculate delay based on Computed Departure time and Scheduled departure time of a Certain Vehicle
+
+                vehiclesList.add(vehiclesInfoList); //add trainInfoList in trainList
+
+                System.out.println(vehiclesInfoList); // For debugging purposes
+
+                System.out.println(httpUrl);
+            }
+            return vehiclesList; // do not print this yet, wait for full change
+
+        } catch (IOException | JSONException e) {
+            throw new RuntimeException(e);
+        }
+
+    }
+}