-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Implement SIRI extra calls #6493
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
vpaturet
wants to merge
6
commits into
opentripplanner:dev-2.x
Choose a base branch
from
entur:implement_extra_calls
base: dev-2.x
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
f1999cb
Implement SIRI extra calls
vpaturet f54594a
Clarify method name
vpaturet 70b3593
Align error code for unknown stop
vpaturet c32be07
Add validation rules
vpaturet b3906b6
Merge branch 'dev-2.x' into implement_extra_calls
vpaturet bb6cb63
Fix merge conflicts
vpaturet File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
194 changes: 194 additions & 0 deletions
194
application/src/main/java/org/opentripplanner/updater/trip/siri/ExtraCallTripBuilder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,194 @@ | ||
| package org.opentripplanner.updater.trip.siri; | ||
|
|
||
| import static java.lang.Boolean.TRUE; | ||
| import static org.opentripplanner.updater.spi.UpdateError.UpdateErrorType.INVALID_STOP_SEQUENCE; | ||
| import static org.opentripplanner.updater.spi.UpdateError.UpdateErrorType.NO_START_DATE; | ||
| import static org.opentripplanner.updater.spi.UpdateError.UpdateErrorType.STOP_MISMATCH; | ||
| import static org.opentripplanner.updater.spi.UpdateError.UpdateErrorType.UNKNOWN_STOP; | ||
|
|
||
| import java.time.LocalDate; | ||
| import java.time.ZoneId; | ||
| import java.time.ZonedDateTime; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
| import java.util.function.Function; | ||
| import org.opentripplanner.model.StopTime; | ||
| import org.opentripplanner.transit.model.framework.DataValidationException; | ||
| import org.opentripplanner.transit.model.framework.FeedScopedId; | ||
| import org.opentripplanner.transit.model.framework.Result; | ||
| import org.opentripplanner.transit.model.network.StopPattern; | ||
| import org.opentripplanner.transit.model.network.TripPattern; | ||
| import org.opentripplanner.transit.model.site.StopLocation; | ||
| import org.opentripplanner.transit.model.timetable.RealTimeState; | ||
| import org.opentripplanner.transit.model.timetable.RealTimeTripTimes; | ||
| import org.opentripplanner.transit.model.timetable.Trip; | ||
| import org.opentripplanner.transit.model.timetable.TripTimesFactory; | ||
| import org.opentripplanner.transit.service.TransitEditorService; | ||
| import org.opentripplanner.updater.spi.DataValidationExceptionMapper; | ||
| import org.opentripplanner.updater.spi.UpdateError; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import uk.org.siri.siri21.EstimatedVehicleJourney; | ||
| import uk.org.siri.siri21.OccupancyEnumeration; | ||
|
|
||
| class ExtraCallTripBuilder { | ||
|
|
||
| private static final Logger LOG = LoggerFactory.getLogger(ExtraCallTripBuilder.class); | ||
| private final TransitEditorService transitService; | ||
| private final ZoneId timeZone; | ||
| private final Function<Trip, FeedScopedId> getTripPatternId; | ||
| private final Trip trip; | ||
| private final String dataSource; | ||
| private final LocalDate serviceDate; | ||
| private final List<CallWrapper> calls; | ||
| private final boolean isJourneyPredictionInaccurate; | ||
| private final OccupancyEnumeration occupancy; | ||
| private final boolean cancellation; | ||
| private final StopTimesMapper stopTimesMapper; | ||
|
|
||
| ExtraCallTripBuilder( | ||
| EstimatedVehicleJourney estimatedVehicleJourney, | ||
| TransitEditorService transitService, | ||
| EntityResolver entityResolver, | ||
| Function<Trip, FeedScopedId> getTripPatternId, | ||
| Trip trip | ||
| ) { | ||
| this.trip = Objects.requireNonNull(trip); | ||
|
|
||
| // DataSource of added trip | ||
| dataSource = estimatedVehicleJourney.getDataSource(); | ||
|
|
||
| serviceDate = entityResolver.resolveServiceDate(estimatedVehicleJourney); | ||
|
|
||
| isJourneyPredictionInaccurate = TRUE.equals(estimatedVehicleJourney.isPredictionInaccurate()); | ||
| occupancy = estimatedVehicleJourney.getOccupancy(); | ||
| cancellation = TRUE.equals(estimatedVehicleJourney.isCancellation()); | ||
|
|
||
| calls = CallWrapper.of(estimatedVehicleJourney); | ||
|
|
||
| this.transitService = transitService; | ||
| this.getTripPatternId = getTripPatternId; | ||
| timeZone = transitService.getTimeZone(); | ||
|
|
||
| stopTimesMapper = new StopTimesMapper(entityResolver, timeZone); | ||
| } | ||
|
|
||
| Result<TripUpdate, UpdateError> build() { | ||
| TripPattern originalPattern = transitService.findPattern(trip); | ||
| long numExtraCalls = calls.stream().filter(CallWrapper::isExtraCall).count(); | ||
| if (calls.size() - numExtraCalls != originalPattern.numberOfStops()) { | ||
| // A trip update with extra calls is expected to have the same number of non-extra calls as | ||
| // the number of stops in the original scheduled trip | ||
| return UpdateError.result(trip.getId(), INVALID_STOP_SEQUENCE, dataSource); | ||
| } | ||
|
|
||
| if (serviceDate == null) { | ||
| return UpdateError.result(trip.getId(), NO_START_DATE, dataSource); | ||
| } | ||
|
|
||
| FeedScopedId calServiceId = transitService.getOrCreateServiceIdForDate(serviceDate); | ||
| if (calServiceId == null) { | ||
| return UpdateError.result(trip.getId(), NO_START_DATE, dataSource); | ||
| } | ||
|
|
||
| ZonedDateTime departureDate = serviceDate.atStartOfDay(timeZone); | ||
|
|
||
| // Create the "scheduled version" of the trip | ||
| // We do not reuse the trip times of the original scheduled trip | ||
| // since adding extra stops change the timings of later stops in the trip pattern. | ||
| var aimedStopTimes = new ArrayList<StopTime>(); | ||
| int extraCallCounter = 0; | ||
| for (int stopSequence = 0; stopSequence < calls.size(); stopSequence++) { | ||
| CallWrapper call = calls.get(stopSequence); | ||
| StopTime stopTime = stopTimesMapper.createAimedStopTime( | ||
| trip, | ||
| departureDate, | ||
| stopSequence, | ||
| call, | ||
| stopSequence == 0, | ||
| stopSequence == (calls.size() - 1) | ||
| ); | ||
|
|
||
| // Drop this update if the call refers to an unknown stop (not present in the site repository). | ||
| if (stopTime == null) { | ||
| return UpdateError.result(trip.getId(), UNKNOWN_STOP, dataSource); | ||
| } | ||
|
|
||
| // Drop this update if it replaces scheduled stops from the original pattern. | ||
| // Only changes within the same parent station are allowed. | ||
| if (call.isExtraCall()) { | ||
| extraCallCounter++; | ||
| } else { | ||
| StopLocation stopInOriginalPattern = originalPattern.getStop( | ||
| stopSequence - extraCallCounter | ||
| ); | ||
| StopLocation stopInNewPattern = stopTime.getStop(); | ||
| if ( | ||
| !stopInNewPattern.equals(stopInOriginalPattern) && | ||
| !stopInNewPattern.isPartOfSameStationAs(stopInOriginalPattern) | ||
| ) { | ||
| return UpdateError.result(trip.getId(), STOP_MISMATCH, dataSource); | ||
| } | ||
| } | ||
|
|
||
| aimedStopTimes.add(stopTime); | ||
| } | ||
|
|
||
| // TODO: We always create a new TripPattern to be able to modify its scheduled timetable | ||
| StopPattern stopPattern = new StopPattern(aimedStopTimes); | ||
|
|
||
| RealTimeTripTimes tripTimes = TripTimesFactory.tripTimes( | ||
| trip, | ||
| aimedStopTimes, | ||
| transitService.getDeduplicator() | ||
| ); | ||
| // validate the scheduled trip times | ||
| // they are in general superseded by real-time trip times | ||
| // but in case of trip cancellation, OTP will fall back to scheduled trip times | ||
| // therefore they must be valid | ||
| tripTimes.validateNonIncreasingTimes(); | ||
| tripTimes.setServiceCode(transitService.getServiceCode(trip.getServiceId())); | ||
|
|
||
| TripPattern pattern = TripPattern.of(getTripPatternId.apply(trip)) | ||
| .withRoute(trip.getRoute()) | ||
| .withMode(trip.getMode()) | ||
| .withNetexSubmode(trip.getNetexSubMode()) | ||
| .withStopPattern(stopPattern) | ||
| .withScheduledTimeTableBuilder(builder -> builder.addTripTimes(tripTimes)) | ||
| .withCreatedByRealtimeUpdater(true) | ||
| .build(); | ||
|
|
||
| RealTimeTripTimes updatedTripTimes = tripTimes.copyScheduledTimes(); | ||
|
|
||
| // Loop through calls again and apply updates | ||
| for (int stopSequence = 0; stopSequence < calls.size(); stopSequence++) { | ||
| TimetableHelper.applyUpdates( | ||
| departureDate, | ||
| updatedTripTimes, | ||
| stopSequence, | ||
| stopSequence == (calls.size() - 1), | ||
| isJourneyPredictionInaccurate, | ||
| calls.get(stopSequence), | ||
| occupancy | ||
| ); | ||
| } | ||
|
|
||
| if (cancellation || stopPattern.isAllStopsNonRoutable()) { | ||
| updatedTripTimes.cancelTrip(); | ||
| } else { | ||
| updatedTripTimes.setRealTimeState(RealTimeState.MODIFIED); | ||
| } | ||
|
|
||
| /* Validate */ | ||
| try { | ||
| updatedTripTimes.validateNonIncreasingTimes(); | ||
| } catch (DataValidationException e) { | ||
| return DataValidationExceptionMapper.toResult(e, dataSource); | ||
| } | ||
|
|
||
| return Result.success( | ||
| new TripUpdate(stopPattern, updatedTripTimes, serviceDate, null, pattern, false, dataSource) | ||
| ); | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about calling this
tripPatternIdGeneratororgenerateTripPatternIdinstead? Otherwise it looks like we are getting an existing id.