ENH: NAV-52 - First throw at defining interfaces for a public transport interface.

src/main/java/ch/naviqore/service/ArrivalTime.java

@@ -0,0 +1,9 @@
+package ch.naviqore.service;
+
+import org.jetbrains.annotations.NotNull;
+
+import java.time.LocalDate;
+
+public interface ArrivalTime {
+    @NotNull LocalDate getArrivalTime();
+}

src/main/java/ch/naviqore/service/Connection.java

@@ -0,0 +1,30 @@
+package ch.naviqore.service;
+
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.List;
+
+public interface Connection {
+    @NotNull List<Leg> getLegs();
+
+    @NotNull Location getStartLocation();
+
+    @NotNull Location getEndLocation();
+
+    @Nullable Stop getStartStop();
+
+    @Nullable Stop getEndStop();
+
+    @NotNull ArrivalTime getArrivalTime();
+
+    @NotNull DepartureTime getDepartureTime();
+
+    int getDuration();
+
+    int getBeeLineDistance();
+
+    int getNumTransfers();
+
+    int getWalkingDistance();
+}

src/main/java/ch/naviqore/service/ConnectionQueryConfiguration.java

@@ -0,0 +1,11 @@
+package ch.naviqore.service;
+
+public interface ConnectionQueryConfiguration {
+    int getMaximumWalkingDuration();
+
+    int getMinimumTransferDuration();
+
+    int getMaximumTransferNumber();
+
+    int getMaximumTravelTime();
+}

src/main/java/ch/naviqore/service/DepartureTime.java

@@ -0,0 +1,9 @@
+package ch.naviqore.service;
+
+import org.jetbrains.annotations.NotNull;
+
+import java.time.LocalDate;
+
+public interface DepartureTime {
+    @NotNull LocalDate getDepartureTime();
+}

src/main/java/ch/naviqore/service/Leg.java

@@ -0,0 +1,22 @@
+package ch.naviqore.service;
+
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public interface Leg {
+    @NotNull Location getDepartureLocation();
+
+    @NotNull Location getArrivalLocation();
+
+    @Nullable Stop getDepartureStop();
+
+    @Nullable Stop getArrivalStop();
+
+    @NotNull DepartureTime getDepartureTime();
+
+    @NotNull ArrivalTime getArrivalTime();
+
+    @Nullable Trip getTrip();
+
+    @Nullable Walk getWalk();
+}

src/main/java/ch/naviqore/service/Location.java

@@ -0,0 +1,7 @@
+package ch.naviqore.service;
+
+public interface Location {
+    double getLatitude();
+
+    double getLongitude();
+}

src/main/java/ch/naviqore/service/NotFoundException.java

@@ -0,0 +1,4 @@
+package ch.naviqore.service;
+
+public class NotFoundException extends Exception{
+}

src/main/java/ch/naviqore/service/PublicTransportService.java

@@ -0,0 +1,31 @@
+package ch.naviqore.service;
+
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.time.LocalDate;
+import java.util.List;
+import java.util.Map;
+
+public interface PublicTransportService {
+    @NotNull List<StopTime> getNextDepartures(@NotNull Stop stop, @NotNull LocalDate from, @Nullable LocalDate until, int limit);
+
+    @NotNull List<Stop> getStops(@NotNull String like, @NotNull SearchType searchType);
+
+    @Nullable Stop getClosestStop(@NotNull Location location);
+
+    @NotNull List<Stop> getClosestStops(@NotNull Location location, int searchRadius, int limit);
+
+    @NotNull List<Connection> getJourneys(@NotNull Location departureLocation, @NotNull Location arrivalLocation, @NotNull DepartureTime departureTime,
+                                 ConnectionQueryConfiguration config);
+
+    @NotNull List<Connection> getJourneys(@NotNull Location departureLocation, @NotNull Location arrivalLocation, @NotNull ArrivalTime arrivalTime,
+                                 ConnectionQueryConfiguration config);
+
+    @NotNull Map<Stop, Connection> getShortestPossibleJourneyToStops(@NotNull Location departureLocation, @NotNull DepartureTime departureTime,
+                                                            @Nullable ConnectionQueryConfiguration config);
+
+    Stop getStopById(@NotNull String stopId) throws StopNotFoundException;
+    Trip getTripById(@NotNull String tripId) throws TripNotFoundException;
+    Route getRouteById(@NotNull String routeId) throws RouteNotFoundException;
+}

src/main/java/ch/naviqore/service/Route.java

@@ -0,0 +1,12 @@
+package ch.naviqore.service;
+
+import org.jetbrains.annotations.NotNull;
+
+public interface Route {
+    @NotNull String getRouteId();
+    @NotNull String getRouteName();
+    @NotNull String getRouteShortName();
+    @NotNull String getRouteDescription();
+    @NotNull String getRouteType();
+    @NotNull String getAgency();
+}

src/main/java/ch/naviqore/service/RouteNotFoundException.java

@@ -0,0 +1,4 @@
+package ch.naviqore.service;
+
+public class RouteNotFoundException extends NotFoundException {
+}

src/main/java/ch/naviqore/service/SearchType.java

@@ -0,0 +1,8 @@
+package ch.naviqore.service;
+
+public enum SearchType {
+    STARTS_WITH,
+    ENDS_WITH,
+    CONTAINS,
+    EXACT
+}

src/main/java/ch/naviqore/service/Stop.java

@@ -0,0 +1,8 @@
+package ch.naviqore.service;
+
+import org.jetbrains.annotations.NotNull;
+
+public interface Stop extends Location {
+    @NotNull String getStopId();
+    @NotNull String getName();
+}

src/main/java/ch/naviqore/service/StopNotFoundException.java

@@ -0,0 +1,4 @@
+package ch.naviqore.service;
+
+public class StopNotFoundException extends NotFoundException {
+}

src/main/java/ch/naviqore/service/StopTime.java

@@ -0,0 +1,13 @@
+package ch.naviqore.service;
+
+import org.jetbrains.annotations.NotNull;
+
+public interface StopTime {
+    @NotNull Trip getTrip();
+
+    @NotNull Stop getStop();
+
+    @NotNull ArrivalTime getArrivalTime();
+
+    @NotNull DepartureTime getDepartureTime();
+}

src/main/java/ch/naviqore/service/Trip.java

@@ -0,0 +1,17 @@
+package ch.naviqore.service;
+
+import org.jetbrains.annotations.NotNull;
+
+import java.util.List;
+
+public interface Trip {
+    @NotNull String getTripId();
+
+    @NotNull Route getRoute();
+
+    @NotNull StopTime getStartStop();
+
+    @NotNull StopTime getEndStop();
+
+    @NotNull List<StopTime> getStopTimes();
+}

src/main/java/ch/naviqore/service/TripNotFoundException.java

@@ -0,0 +1,4 @@
+package ch.naviqore.service;
+
+public class TripNotFoundException extends NotFoundException {
+}

src/main/java/ch/naviqore/service/Walk.java

@@ -0,0 +1,18 @@
+package ch.naviqore.service;
+
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public interface Walk {
+    @NotNull Location getStart();
+
+    @NotNull Location getEnd();
+
+    @Nullable Stop getStartStop();
+
+    @Nullable Stop getEndStop();
+
+    int getDistance();
+
+    int getDuration();
+}