org.opentripplanner.transit.service.DefaultTransitService Maven / Gradle / Ivy
Show all versions of otp Show documentation
package org.opentripplanner.transit.service;
import gnu.trove.set.TIntSet;
import gnu.trove.set.hash.TIntHashSet;
import java.time.Duration;
import java.time.Instant;
import java.time.LocalDate;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.util.Collection;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import javax.inject.Inject;
import org.locationtech.jts.geom.Coordinate;
import org.locationtech.jts.geom.Envelope;
import org.opentripplanner.ext.flex.FlexIndex;
import org.opentripplanner.model.FeedInfo;
import org.opentripplanner.model.PathTransfer;
import org.opentripplanner.model.StopTimesInPattern;
import org.opentripplanner.model.Timetable;
import org.opentripplanner.model.TimetableSnapshot;
import org.opentripplanner.model.TripTimeOnDate;
import org.opentripplanner.model.calendar.CalendarService;
import org.opentripplanner.model.transfer.TransferService;
import org.opentripplanner.routing.algorithm.raptoradapter.transit.TransitLayer;
import org.opentripplanner.routing.services.TransitAlertService;
import org.opentripplanner.routing.stoptimes.ArrivalDeparture;
import org.opentripplanner.routing.stoptimes.StopTimesHelper;
import org.opentripplanner.transit.model.basic.Notice;
import org.opentripplanner.transit.model.basic.TransitMode;
import org.opentripplanner.transit.model.basic.WgsCoordinate;
import org.opentripplanner.transit.model.framework.AbstractTransitEntity;
import org.opentripplanner.transit.model.framework.FeedScopedId;
import org.opentripplanner.transit.model.network.GroupOfRoutes;
import org.opentripplanner.transit.model.network.Route;
import org.opentripplanner.transit.model.network.TripPattern;
import org.opentripplanner.transit.model.organization.Agency;
import org.opentripplanner.transit.model.organization.Operator;
import org.opentripplanner.transit.model.site.AreaStop;
import org.opentripplanner.transit.model.site.MultiModalStation;
import org.opentripplanner.transit.model.site.RegularStop;
import org.opentripplanner.transit.model.site.Station;
import org.opentripplanner.transit.model.site.StopLocation;
import org.opentripplanner.transit.model.site.StopLocationsGroup;
import org.opentripplanner.transit.model.timetable.Trip;
import org.opentripplanner.transit.model.timetable.TripIdAndServiceDate;
import org.opentripplanner.transit.model.timetable.TripOnServiceDate;
import org.opentripplanner.updater.GraphUpdaterStatus;
/**
* Default implementation of the Transit Service and Transit Editor Service.
* A new instance of this class should be created for each request.
* This ensures that the same TimetableSnapshot is used for the
* duration of the request (which may involve several method calls).
*/
public class DefaultTransitService implements TransitEditorService {
private final TransitModel transitModel;
private final TransitModelIndex transitModelIndex;
/**
* This should only be accessed through the getTimetableSnapshot method.
*/
private TimetableSnapshot timetableSnapshot;
@Inject
public DefaultTransitService(TransitModel transitModel) {
this.transitModel = transitModel;
this.transitModelIndex = transitModel.getTransitModelIndex();
}
@Override
public Collection getFeedIds() {
return this.transitModel.getFeedIds();
}
@Override
public Collection getAgencies() {
return this.transitModel.getAgencies();
}
@Override
public FeedInfo getFeedInfo(String feedId) {
return this.transitModel.getFeedInfo(feedId);
}
@Override
public void addAgency(Agency agency) {
this.transitModel.addAgency(agency);
}
@Override
public void addFeedInfo(FeedInfo info) {
this.transitModel.addFeedInfo(info);
}
@Override
public Collection getOperators() {
return this.transitModel.getOperators();
}
@Override
public Collection getNoticesByEntity(AbstractTransitEntity entity) {
return this.transitModel.getNoticesByElement().get(entity);
}
@Override
public TripPattern getTripPatternForId(FeedScopedId id) {
return this.transitModel.getTripPatternForId(id);
}
@Override
public Collection getAllTripPatterns() {
return this.transitModel.getAllTripPatterns();
}
@Override
public Collection getNotices() {
return this.transitModel.getNoticesByElement().values();
}
@Override
public Station getStationById(FeedScopedId id) {
return this.transitModel.getStopModel().getStationById(id);
}
@Override
public MultiModalStation getMultiModalStation(FeedScopedId id) {
return this.transitModel.getStopModel().getMultiModalStation(id);
}
@Override
public Collection getStations() {
return this.transitModel.getStopModel().listStations();
}
@Override
public Integer getServiceCodeForId(FeedScopedId id) {
return this.transitModel.getServiceCodes().get(id);
}
@Override
public TIntSet getServiceCodesRunningForDate(LocalDate serviceDate) {
return transitModelIndex
.getServiceCodesRunningForDate()
.getOrDefault(serviceDate, new TIntHashSet());
}
@Override
public AreaStop getAreaStop(FeedScopedId id) {
return this.transitModel.getStopModel().getAreaStop(id);
}
@Override
public Agency getAgencyForId(FeedScopedId id) {
return this.transitModelIndex.getAgencyForId(id);
}
@Override
public RegularStop getRegularStop(FeedScopedId id) {
return this.transitModel.getStopModel().getRegularStop(id);
}
@Override
public Route getRouteForId(FeedScopedId id) {
return this.transitModelIndex.getRouteForId(id);
}
@Override
public void addRoutes(Route route) {
this.transitModelIndex.addRoutes(route);
}
@Override
public Set getRoutesForStop(StopLocation stop) {
return this.transitModelIndex.getRoutesForStop(stop);
}
@Override
public Collection getPatternsForStop(StopLocation stop) {
return this.transitModelIndex.getPatternsForStop(stop);
}
@Override
public Collection getTripsForStop(StopLocation stop) {
return this.transitModelIndex.getTripsForStop(stop);
}
@Override
public Collection getAllOperators() {
return this.transitModelIndex.getAllOperators();
}
@Override
public Operator getOperatorForId(FeedScopedId id) {
return this.transitModelIndex.getOperatorForId().get(id);
}
@Override
public Collection listStopLocations() {
return transitModel.getStopModel().listStopLocations();
}
@Override
public Collection listRegularStops() {
return transitModel.getStopModel().listRegularStops();
}
@Override
public StopLocation getStopLocation(FeedScopedId id) {
return transitModel.getStopModel().getStopLocation(id);
}
@Override
public Collection listStopLocationGroups() {
return transitModel.getStopModel().listStopLocationGroups();
}
@Override
public StopLocationsGroup getStopLocationsGroup(FeedScopedId id) {
return transitModel.getStopModel().getStopLocationsGroup(id);
}
@Override
public Trip getTripForId(FeedScopedId id) {
return this.transitModelIndex.getTripForId().get(id);
}
@Override
public Collection getAllTrips() {
return transitModelIndex.getTripForId().values();
}
@Override
public Collection getAllRoutes() {
return this.transitModelIndex.getAllRoutes();
}
@Override
public TripPattern getPatternForTrip(Trip trip) {
return this.transitModelIndex.getPatternForTrip().get(trip);
}
@Override
public TripPattern getPatternForTrip(Trip trip, LocalDate serviceDate) {
TripPattern realtimePattern = getRealtimeAddedTripPattern(trip.getId(), serviceDate);
if (realtimePattern != null) {
return realtimePattern;
}
return getPatternForTrip(trip);
}
@Override
public Collection getPatternsForRoute(Route route) {
return this.transitModelIndex.getPatternsForRoute().get(route);
}
@Override
public MultiModalStation getMultiModalStationForStation(Station station) {
return this.transitModel.getStopModel().getMultiModalStationForStation(station);
}
/**
* Fetch upcoming vehicle departures from a stop. It goes though all patterns passing the stop for
* the previous, current and next service date. It uses a priority queue to keep track of the next
* departures. The queue is shared between all dates, as services from the previous service date
* can visit the stop later than the current service date's services. This happens eg. with
* sleeper trains.
*
* TODO: Add frequency based trips
*
* @param stop Stop object to perform the search for
* @param startTime Start time for the search.
* @param timeRange Searches forward for timeRange from startTime
* @param numberOfDepartures Number of departures to fetch per pattern
* @param arrivalDeparture Filter by arrivals, departures, or both
* @param includeCancelledTrips If true, cancelled trips will also be included in result.
*/
@Override
public List stopTimesForStop(
StopLocation stop,
Instant startTime,
Duration timeRange,
int numberOfDepartures,
ArrivalDeparture arrivalDeparture,
boolean includeCancelledTrips
) {
return StopTimesHelper.stopTimesForStop(
this,
stop,
startTime,
timeRange,
numberOfDepartures,
arrivalDeparture,
includeCancelledTrips
);
}
/**
* Get a list of all trips that pass through a stop during a single ServiceDate. Useful when
* creating complete stop timetables for a single day.
*
* @param stop Stop object to perform the search for
* @param serviceDate Return all departures for the specified date
*/
@Override
public List getStopTimesForStop(
StopLocation stop,
LocalDate serviceDate,
ArrivalDeparture arrivalDeparture,
boolean includeCancellations
) {
return StopTimesHelper.stopTimesForStop(
this,
stop,
serviceDate,
arrivalDeparture,
includeCancellations
);
}
/**
* Fetch upcoming vehicle departures from a stop for a specific pattern, passing the stop for the
* previous, current and next service date. It uses a priority queue to keep track of the next
* departures. The queue is shared between all dates, as services from the previous service date
* can visit the stop later than the current service date's services.
*
* TODO: Add frequency based trips
*
* @param stop Stop object to perform the search for
* @param pattern Pattern object to perform the search for
* @param startTime Start time for the search.
* @param timeRange Searches forward for timeRange from startTime
* @param numberOfDepartures Number of departures to fetch per pattern
* @param arrivalDeparture Filter by arrivals, departures, or both
*/
@Override
public List stopTimesForPatternAtStop(
StopLocation stop,
TripPattern pattern,
Instant startTime,
Duration timeRange,
int numberOfDepartures,
ArrivalDeparture arrivalDeparture,
boolean includeCancellations
) {
return StopTimesHelper.stopTimesForPatternAtStop(
this,
stop,
pattern,
startTime,
timeRange,
numberOfDepartures,
arrivalDeparture,
includeCancellations
);
}
/**
* Returns all the patterns for a specific stop. If includeRealtimeUpdates is set, new patterns
* added by realtime updates are added to the collection.
*/
@Override
public Collection getPatternsForStop(
StopLocation stop,
boolean includeRealtimeUpdates
) {
return transitModel
.getTransitModelIndex()
.getPatternsForStop(stop, includeRealtimeUpdates ? lazyGetTimeTableSnapShot() : null);
}
@Override
public Collection getGroupsOfRoutes() {
return transitModelIndex.getRoutesForGroupOfRoutes().keySet();
}
@Override
public Collection getRoutesForGroupOfRoutes(GroupOfRoutes groupOfRoutes) {
return transitModelIndex.getRoutesForGroupOfRoutes().get(groupOfRoutes);
}
@Override
public GroupOfRoutes getGroupOfRoutesForId(FeedScopedId id) {
return transitModelIndex.getGroupOfRoutesForId().get(id);
}
/**
* Get the most up-to-date timetable for the given TripPattern, as of right now. There should
* probably be a less awkward way to do this that just gets the latest entry from the resolver
* without making a fake routing request.
*/
@Override
public Timetable getTimetableForTripPattern(TripPattern tripPattern, LocalDate serviceDate) {
TimetableSnapshot timetableSnapshot = lazyGetTimeTableSnapShot();
return timetableSnapshot != null
? timetableSnapshot.resolve(tripPattern, serviceDate)
: tripPattern.getScheduledTimetable();
}
@Override
public TripPattern getRealtimeAddedTripPattern(FeedScopedId tripId, LocalDate serviceDate) {
TimetableSnapshot timetableSnapshot = lazyGetTimeTableSnapShot();
if (timetableSnapshot == null) {
return null;
}
return timetableSnapshot.getRealtimeAddedTripPattern(tripId, serviceDate);
}
@Override
public boolean hasRealtimeAddedTripPatterns() {
TimetableSnapshot timetableSnapshot = lazyGetTimeTableSnapShot();
if (timetableSnapshot == null) {
return false;
}
return timetableSnapshot.hasRealtimeAddedTripPatterns();
}
/**
* Lazy-initialization of TimetableSnapshot
*
* @return The same TimetableSnapshot is returned throughout the lifecycle of this object.
*/
private TimetableSnapshot lazyGetTimeTableSnapShot() {
if (this.timetableSnapshot == null) {
timetableSnapshot = transitModel.getTimetableSnapshot();
}
return this.timetableSnapshot;
}
@Override
public TripOnServiceDate getTripOnServiceDateById(FeedScopedId datedServiceJourneyId) {
TimetableSnapshot timetableSnapshot = lazyGetTimeTableSnapShot();
if (timetableSnapshot != null) {
TripOnServiceDate tripOnServiceDate = timetableSnapshot
.getRealtimeAddedTripOnServiceDate()
.get(datedServiceJourneyId);
if (tripOnServiceDate != null) {
return tripOnServiceDate;
}
}
return transitModelIndex.getTripOnServiceDateById().get(datedServiceJourneyId);
}
@Override
public Collection getAllTripOnServiceDates() {
return transitModelIndex.getTripOnServiceDateForTripAndDay().values();
}
@Override
public TripOnServiceDate getTripOnServiceDateForTripAndDay(
TripIdAndServiceDate tripIdAndServiceDate
) {
TimetableSnapshot timetableSnapshot = lazyGetTimeTableSnapShot();
if (timetableSnapshot != null) {
TripOnServiceDate tripOnServiceDate = timetableSnapshot
.getRealtimeAddedTripOnServiceDateByTripIdAndServiceDate()
.get(tripIdAndServiceDate);
if (tripOnServiceDate != null) {
return tripOnServiceDate;
}
}
return transitModelIndex.getTripOnServiceDateForTripAndDay().get(tripIdAndServiceDate);
}
@Override
public void addTransitMode(TransitMode mode) {
this.transitModel.addTransitMode(mode);
}
@Override
public Set getTransitModes() {
return this.transitModel.getTransitModes();
}
@Override
public Collection getTransfersByStop(StopLocation stop) {
return this.transitModel.getTransfersByStop(stop);
}
@Override
public TransitLayer getTransitLayer() {
return this.transitModel.getTransitLayer();
}
@Override
public TransitLayer getRealtimeTransitLayer() {
return this.transitModel.getRealtimeTransitLayer();
}
@Override
public void setTransitLayer(TransitLayer transitLayer) {
this.transitModel.setTransitLayer(transitLayer);
}
@Override
public CalendarService getCalendarService() {
return this.transitModel.getCalendarService();
}
@Override
public ZoneId getTimeZone() {
return this.transitModel.getTimeZone();
}
@Override
public TransitAlertService getTransitAlertService() {
return this.transitModel.getTransitAlertService();
}
@Override
public FlexIndex getFlexIndex() {
return this.transitModelIndex.getFlexIndex();
}
@Override
public ZonedDateTime getTransitServiceEnds() {
return transitModel.getTransitServiceEnds();
}
@Override
public ZonedDateTime getTransitServiceStarts() {
return transitModel.getTransitServiceStarts();
}
@Override
public Collection findRegularStop(Envelope envelope) {
return transitModel.getStopModel().findRegularStops(envelope);
}
@Override
public GraphUpdaterStatus getUpdaterStatus() {
return transitModel.getUpdaterManager();
}
@Override
public Optional getCenter() {
return transitModel.getStopModel().stopLocationCenter().map(WgsCoordinate::asJtsCoordinate);
}
@Override
public TransferService getTransferService() {
return transitModel.getTransferService();
}
@Override
public boolean transitFeedCovers(Instant dateTime) {
return transitModel.transitFeedCovers(dateTime);
}
}