Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.opentripplanner.netex.mapping.StopTimesMapper Maven / Gradle / Ivy
package org.opentripplanner.netex.mapping;
import static org.opentripplanner.model.PickDrop.COORDINATE_WITH_DRIVER;
import static org.opentripplanner.model.PickDrop.NONE;
import static org.opentripplanner.model.PickDrop.SCHEDULED;
import java.math.BigInteger;
import java.time.LocalTime;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
import javax.xml.bind.JAXBElement;
import org.opentripplanner.graph_builder.DataImportIssueStore;
import org.opentripplanner.model.BookingInfo;
import org.opentripplanner.model.FlexLocationGroup;
import org.opentripplanner.model.FlexStopLocation;
import org.opentripplanner.model.Stop;
import org.opentripplanner.model.StopLocation;
import org.opentripplanner.model.StopTime;
import org.opentripplanner.model.Trip;
import org.opentripplanner.model.impl.EntityById;
import org.opentripplanner.netex.index.api.ReadOnlyHierarchicalMap;
import org.opentripplanner.netex.index.api.ReadOnlyHierarchicalMapById;
import org.opentripplanner.netex.mapping.support.FeedScopedIdFactory;
import org.opentripplanner.util.OTPFeature;
import org.rutebanken.netex.model.DestinationDisplay;
import org.rutebanken.netex.model.DestinationDisplay_VersionStructure;
import org.rutebanken.netex.model.FlexibleLine;
import org.rutebanken.netex.model.JourneyPattern;
import org.rutebanken.netex.model.LineRefStructure;
import org.rutebanken.netex.model.MultilingualString;
import org.rutebanken.netex.model.PointInLinkSequence_VersionedChildStructure;
import org.rutebanken.netex.model.Route;
import org.rutebanken.netex.model.ServiceJourney;
import org.rutebanken.netex.model.StopPointInJourneyPattern;
import org.rutebanken.netex.model.TimetabledPassingTime;
import org.rutebanken.netex.model.VersionOfObjectRefStructure;
import org.rutebanken.netex.model.Via_VersionedChildStructure;
import org.rutebanken.netex.model.Vias_RelStructure;
/**
* This maps a list of TimetabledPassingTimes to a list of StopTimes. It also makes sure the StopTime has a reference
* to the correct stop. DestinationDisplay is mapped to HeadSign. There is logic to take care of the the fact that
* DestinationsDisplay is also valid for each subsequent TimeTabledPassingTime, while HeadSign has to be explicitly
* defined for each StopTime.
*/
class StopTimesMapper {
private final DataImportIssueStore issueStore;
private static final int DAY_IN_SECONDS = 3600 * 24;
private final FeedScopedIdFactory idFactory;
private final ReadOnlyHierarchicalMap destinationDisplayById;
private final EntityById stopsById;
private final EntityById flexibleStopLocationsById;
private final EntityById flexLocationGroupsByid;
private final ReadOnlyHierarchicalMap quayIdByStopPointRef;
private final ReadOnlyHierarchicalMap flexibleStopPlaceIdByStopPointRef;
private final ReadOnlyHierarchicalMap routeByid;
private final ReadOnlyHierarchicalMapById flexibleLinesById;
private String currentHeadSign;
StopTimesMapper(
DataImportIssueStore issueStore,
FeedScopedIdFactory idFactory,
EntityById stopsById,
EntityById flexStopLocationsById,
EntityById flexLocationGroupsById,
ReadOnlyHierarchicalMap destinationDisplayById,
ReadOnlyHierarchicalMap quayIdByStopPointRef,
ReadOnlyHierarchicalMap flexibleStopPlaceIdByStopPointRef,
ReadOnlyHierarchicalMapById flexibleLinesById,
ReadOnlyHierarchicalMap routeById
) {
this.issueStore = issueStore;
this.idFactory = idFactory;
this.destinationDisplayById = destinationDisplayById;
this.stopsById = stopsById;
this.flexibleStopLocationsById = flexStopLocationsById;
this.flexLocationGroupsByid = flexLocationGroupsById;
this.quayIdByStopPointRef = quayIdByStopPointRef;
this.flexibleStopPlaceIdByStopPointRef = flexibleStopPlaceIdByStopPointRef;
this.flexibleLinesById = flexibleLinesById;
this.routeByid = routeById;
}
/**
* @return a map of stop-times indexed by the TimetabledPassingTime id.
*/
@Nullable
StopTimesMapperResult mapToStopTimes(
JourneyPattern journeyPattern,
Trip trip,
List passingTimes,
ServiceJourney serviceJourney
) {
StopTimesMapperResult result = new StopTimesMapperResult();
List scheduledStopPointIds = new ArrayList<>();
for (int i = 0; i < passingTimes.size(); i++) {
TimetabledPassingTime currentPassingTime = passingTimes.get(i);
String pointInJourneyPattern = currentPassingTime.getPointInJourneyPatternRef().getValue().getRef();
StopPointInJourneyPattern stopPoint = findStopPoint(pointInJourneyPattern, journeyPattern);
StopLocation stop = lookUpStopLocation(stopPoint);
if (stop == null) {
issueStore.add(
"JourneyPatternStopNotFound",
"Stop with id {} not found for StopPoint {} in JourneyPattern {}. "
+ "Trip {} will not be mapped.",
stopPoint != null && stopPoint.getScheduledStopPointRef() != null
? stopPoint.getScheduledStopPointRef().getValue().getRef()
: "null"
, stopPoint != null ? stopPoint.getId() : "null"
, journeyPattern.getId()
, trip.getId()
);
return null;
}
scheduledStopPointIds.add(stopPoint.getScheduledStopPointRef().getValue().getRef());
StopTime stopTime = mapToStopTime(trip, stopPoint, stop, currentPassingTime, i);
if (stopTime == null) {
return null;
}
BookingInfo bookingInfo = new BookingInfoMapper(issueStore).map(
stopPoint,
serviceJourney,
lookUpFlexibleLine(serviceJourney, journeyPattern)
);
stopTime.setDropOffBookingInfo(bookingInfo);
stopTime.setPickupBookingInfo(bookingInfo);
result.addStopTime(currentPassingTime.getId(), stopTime);
}
result.setScheduledStopPointIds(scheduledStopPointIds);
if (OTPFeature.FlexRouting.isOn()) {
// TODO This is a temporary mapping of the UnscheduledTrip format, until we decide on how
// this should be harmonized between GTFS and NeTEx
modifyDataForUnscheduledFlexTrip(result);
}
return result;
}
private StopTime mapToStopTime(
Trip trip,
StopPointInJourneyPattern stopPoint,
StopLocation stop,
TimetabledPassingTime passingTime,
int stopSequence
) {
StopTime stopTime = new StopTime();
stopTime.setTrip(trip);
stopTime.setStopSequence(stopSequence);
stopTime.setStop(stop);
if (passingTime.getArrivalTime() != null || passingTime.getDepartureTime() != null) {
stopTime.setArrivalTime(calculateOtpTime(
passingTime.getArrivalTime(),
passingTime.getArrivalDayOffset(),
passingTime.getDepartureTime(),
passingTime.getDepartureDayOffset()
));
stopTime.setDepartureTime(calculateOtpTime(
passingTime.getDepartureTime(),
passingTime.getDepartureDayOffset(),
passingTime.getArrivalTime(),
passingTime.getArrivalDayOffset()
));
// From NeTEx we define timepoint as a waitpoint with waiting time defined (also 0)
if (Boolean.TRUE.equals(stopPoint.isIsWaitPoint())
&& passingTime.getWaitingTime() != null) {
stopTime.setTimepoint(1);
}
} else if (passingTime.getEarliestDepartureTime() != null && passingTime.getLatestArrivalTime() != null) {
stopTime.setFlexWindowStart(
calculateOtpTime(
passingTime.getEarliestDepartureTime(),
passingTime.getEarliestDepartureDayOffset()
)
);
stopTime.setFlexWindowEnd(
calculateOtpTime(
passingTime.getLatestArrivalTime(),
passingTime.getLatestArrivalDayOffset()
)
);
} else {
return null;
}
List vias = null;
if (stopPoint != null) {
if (isFalse(stopPoint.isForAlighting())) {
stopTime.setDropOffType(NONE);
} else if (Boolean.TRUE.equals(stopPoint.isRequestStop())) {
stopTime.setDropOffType(COORDINATE_WITH_DRIVER);
} else {
stopTime.setDropOffType(SCHEDULED);
}
if (isFalse(stopPoint.isForBoarding())) {
stopTime.setPickupType(NONE);
} else if (Boolean.TRUE.equals(stopPoint.isRequestStop())) {
stopTime.setPickupType(COORDINATE_WITH_DRIVER);
} else {
stopTime.setPickupType(SCHEDULED);
}
if (stopPoint.getDestinationDisplayRef() != null) {
DestinationDisplay destinationDisplay =
destinationDisplayById.lookup(stopPoint.getDestinationDisplayRef().getRef());
Vias_RelStructure viaValues = null;
if (destinationDisplay != null) {
currentHeadSign = destinationDisplay.getFrontText().getValue();
viaValues = destinationDisplay.getVias();
}
if (viaValues != null && viaValues.getVia() != null) {
vias = viaValues.getVia().stream()
.map(Via_VersionedChildStructure::getDestinationDisplayRef)
.filter(Objects::nonNull)
.map(VersionOfObjectRefStructure::getRef)
.filter(Objects::nonNull)
.map(destinationDisplayById::lookup)
.filter(Objects::nonNull)
.map(DestinationDisplay_VersionStructure::getFrontText)
.filter(Objects::nonNull)
.map(MultilingualString::getValue)
.collect(Collectors.toList());
if (vias.isEmpty()) {
vias = null;
}
}
}
}
if (passingTime.getArrivalTime() == null && passingTime.getDepartureTime() == null &&
passingTime.getEarliestDepartureTime() == null && passingTime.getLatestArrivalTime() == null
) {
issueStore.add("TripWithoutTime","Time missing for trip %s", trip.getId());
}
if (currentHeadSign != null) {
stopTime.setStopHeadsign(currentHeadSign);
}
stopTime.setHeadsignVias(vias);
return stopTime;
}
@Nullable
private StopLocation lookUpStopLocation(StopPointInJourneyPattern stopPointInJourneyPattern) {
if (stopPointInJourneyPattern == null) { return null; }
String stopPointRef = stopPointInJourneyPattern.getScheduledStopPointRef().getValue().getRef();
String stopId = quayIdByStopPointRef.lookup(stopPointRef);
String flexibleStopPlaceId = flexibleStopPlaceIdByStopPointRef.lookup(stopPointRef);
if (stopId == null && flexibleStopPlaceId == null) {
issueStore.add(
"PassengerStopAssignmentNotFound",
"No passengerStopAssignment found for %s",
stopPointRef
);
return null;
}
StopLocation stopLocation;
if (stopId != null) {
stopLocation = stopsById.get(idFactory.createId(stopId));
} else {
FlexStopLocation flexStopLocation = flexibleStopLocationsById.get(idFactory.createId(flexibleStopPlaceId));
FlexLocationGroup flexLocationGroup = flexLocationGroupsByid.get(idFactory.createId(flexibleStopPlaceId));
if (flexStopLocation != null) {
stopLocation = flexStopLocation;
} else
stopLocation = flexLocationGroup;
}
if (stopLocation == null) {
issueStore.add(
"StopPointInJourneyPatternMissingStopLocation",
"No Quay or FlexibleStopPlace found for %s",
stopPointRef
);
}
return stopLocation;
}
@Nullable
private static StopPointInJourneyPattern findStopPoint(
String pointInJourneyPatterRef,
JourneyPattern journeyPattern
) {
var points = journeyPattern
.getPointsInSequence()
.getPointInJourneyPatternOrStopPointInJourneyPatternOrTimingPointInJourneyPattern();
for (PointInLinkSequence_VersionedChildStructure point : points) {
if (point instanceof StopPointInJourneyPattern) {
StopPointInJourneyPattern stopPoint = (StopPointInJourneyPattern) point;
if (stopPoint.getId().equals(pointInJourneyPatterRef)) {
return stopPoint;
}
}
}
return null;
}
private static int calculateOtpTime(LocalTime time, BigInteger dayOffset,
LocalTime fallbackTime, BigInteger fallbackDayOffset) {
return time != null ?
calculateOtpTime(time, dayOffset) :
calculateOtpTime(fallbackTime, fallbackDayOffset);
}
static int calculateOtpTime(LocalTime time, BigInteger dayOffset) {
int otpTime = time.toSecondOfDay();
if (dayOffset != null) {
otpTime += DAY_IN_SECONDS * dayOffset.intValue();
}
return otpTime;
}
private static boolean isFalse(Boolean value) {
return value != null && !value;
}
// TODO This is a temporary mapping of the UnscheduledTrip format, until we decide on how
// this should be harmonized between GTFS and NeTEx
private static void modifyDataForUnscheduledFlexTrip(StopTimesMapperResult result) {
List stopTimes = result.stopTimes;
if (stopTimes.size() == 2 && stopTimes
.stream()
.allMatch(s -> s.getStop() instanceof FlexStopLocation
|| s.getStop() instanceof FlexLocationGroup)) {
int departureTime = stopTimes.get(0).getDepartureTime();
int arrivalTime = stopTimes.get(1).getArrivalTime();
for (StopTime stopTime : stopTimes) {
stopTime.clearArrivalTime();
stopTime.clearDepartureTime();
stopTime.setFlexWindowStart(departureTime);
stopTime.setFlexWindowEnd(arrivalTime);
}
}
}
private FlexibleLine lookUpFlexibleLine(ServiceJourney serviceJourney, JourneyPattern journeyPattern) {
if (serviceJourney == null) { return null; }
String lineRef = null;
// Check for direct connection to Line
JAXBElement lineRefStruct = serviceJourney.getLineRef();
if (lineRefStruct != null){
// Connect to Line referenced directly from ServiceJourney
lineRef = lineRefStruct.getValue().getRef();
} else if(serviceJourney.getJourneyPatternRef() != null){
// Connect to Line referenced through JourneyPattern->Route
String routeRef = journeyPattern.getRouteRef().getRef();
lineRef = routeByid.lookup(routeRef).getLineRef().getValue().getRef();
}
return flexibleLinesById.lookup(lineRef);
}
}
