org.opentripplanner.netex.mapping.StopAndStationMapper Maven / Gradle / Ivy
package org.opentripplanner.netex.mapping;
import static java.util.stream.Collectors.toList;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.Multimap;
import jakarta.xml.bind.JAXBElement;
import java.time.ZoneId;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Objects;
import java.util.Set;
import java.util.stream.Collectors;
import org.opentripplanner.graph_builder.issue.api.DataImportIssueStore;
import org.opentripplanner.graph_builder.issue.api.Issue;
import org.opentripplanner.netex.index.api.ReadOnlyHierarchicalVersionMapById;
import org.opentripplanner.netex.issues.StopPlaceWithoutQuays;
import org.opentripplanner.netex.mapping.support.FeedScopedIdFactory;
import org.opentripplanner.netex.mapping.support.NetexMainAndSubMode;
import org.opentripplanner.netex.mapping.support.StopPlaceVersionAndValidityComparator;
import org.opentripplanner.transit.model.basic.Accessibility;
import org.opentripplanner.transit.model.framework.FeedScopedId;
import org.opentripplanner.transit.model.site.FareZone;
import org.opentripplanner.transit.model.site.RegularStop;
import org.opentripplanner.transit.model.site.Station;
import org.opentripplanner.transit.service.SiteRepositoryBuilder;
import org.rutebanken.netex.model.Quay;
import org.rutebanken.netex.model.Quays_RelStructure;
import org.rutebanken.netex.model.StopPlace;
import org.rutebanken.netex.model.TariffZoneRef;
/**
* This maps a NeTEx StopPlace and its child quays to and OTP parent stop and child stops. NeTEx
* also contains GroupsOfStopPlaces and these are also mapped to parent stops, because searching
* from a StopPlace and searching from a GroupOfStopPlaces both corresponding to searching from all
* of its underlying quays. Model changes in OTP are required if we want to preserve the original
* NeTEx hierarchy.
*
* A NeTEx StopPlace can contain both a version and a validity period. Since none of these are
* present in the OTP model we have to choose which version should be mapped based on both of these
* parameters.
*
* To ensure compatibility with older data sets, we also have to keep quays that are only present in
* older versions of the StopPlace.
*/
class StopAndStationMapper {
private final ReadOnlyHierarchicalVersionMapById quayIndex;
private final StationMapper stationMapper;
private final QuayMapper quayMapper;
private final TariffZoneMapper tariffZoneMapper;
private final StopPlaceTypeMapper stopPlaceTypeMapper = new StopPlaceTypeMapper();
private final DataImportIssueStore issueStore;
/**
* Quay ids for all processed stop places
*/
private final Set quaysAlreadyProcessed = new HashSet<>();
final List resultStops = new ArrayList<>();
final List resultStations = new ArrayList<>();
final Multimap resultStationByMultiModalStationRfs = ArrayListMultimap.create();
StopAndStationMapper(
FeedScopedIdFactory idFactory,
ReadOnlyHierarchicalVersionMapById quayIndex,
TariffZoneMapper tariffZoneMapper,
SiteRepositoryBuilder siteRepositoryBuilder,
ZoneId defaultTimeZone,
DataImportIssueStore issueStore,
boolean noTransfersOnIsolatedStops,
Set routeToCentroidStopPlaceIds
) {
this.stationMapper = new StationMapper(
issueStore,
idFactory,
defaultTimeZone,
noTransfersOnIsolatedStops,
routeToCentroidStopPlaceIds,
siteRepositoryBuilder
);
this.quayMapper = new QuayMapper(idFactory, issueStore, siteRepositoryBuilder);
this.tariffZoneMapper = tariffZoneMapper;
this.quayIndex = quayIndex;
this.issueStore = issueStore;
}
/**
* @param stopPlaces all stop places including multiple versions of each.
*/
void mapParentAndChildStops(final Collection stopPlaces) {
// Prioritize StopPlace versions. Highest priority first.
// TODO OTP2 - This should pushed up into the ReadOnlyHierarchicalVersionMapById as part of
// - Issue: Netex import resolve version for all entities , not just stops #2781
List stopPlaceAllVersions = sortStopPlacesByValidityAndVersionDesc(stopPlaces);
StopPlace selectedStopPlace = first(stopPlaceAllVersions);
Station station = mapStopPlaceAllVersionsToStation(selectedStopPlace);
Collection fareZones = mapTariffZones(selectedStopPlace);
var transitMode = stopPlaceTypeMapper.map(selectedStopPlace);
// Loop through all versions of the StopPlace in order to collect all quays, even if they
// were deleted in newer versions of the StopPlace
for (StopPlace stopPlace : stopPlaceAllVersions) {
for (Quay quay : listOfQuays(stopPlace)) {
addStopToParentIfNotPresent(quay, station, fareZones, transitMode, selectedStopPlace);
}
}
}
private static StopPlace first(List stops) {
return stops.get(0);
}
private Station mapStopPlaceAllVersionsToStation(StopPlace stopPlace) {
Station station = stationMapper.map(stopPlace);
if (stopPlace.getParentSiteRef() != null) {
resultStationByMultiModalStationRfs.put(stopPlace.getParentSiteRef().getRef(), station);
}
resultStations.add(station);
return station;
}
private Collection mapTariffZones(StopPlace stopPlace) {
if (stopPlace.getTariffZones() == null) {
return List.of();
}
return stopPlace
.getTariffZones()
.getTariffZoneRef_()
.stream()
.map(ref -> findTariffZone(stopPlace, (TariffZoneRef) ref.getValue()))
.filter(Objects::nonNull)
.collect(Collectors.toList());
}
private FareZone findTariffZone(StopPlace stopPlace, TariffZoneRef ref) {
if (ref == null) {
return null;
}
var result = tariffZoneMapper.findAndMapTariffZone(ref);
if (result == null) {
issueStore.add(
Issue.issue(
"StopPlaceMissingFareZone",
"StopPlace %s has unsupported tariff zone reference: %s",
stopPlace.getId(),
ref
)
);
}
return result;
}
/**
* Sort stop places on version with latest version first (descending order).
*/
private List sortStopPlacesByValidityAndVersionDesc(Collection stopPlaces) {
return stopPlaces
.stream()
.sorted(new StopPlaceVersionAndValidityComparator())
.collect(toList());
}
private void addStopToParentIfNotPresent(
Quay quay,
Station station,
Collection fareZones,
NetexMainAndSubMode transitMode,
StopPlace stopPlace
) {
// TODO OTP2 - This assumption is only valid because Norway have a
// - national stop register, we should add all stops/quays
// - for version resolution.
// Continue if this is not newest version of quay
if (!quayIndex.isNewerOrSameVersionComparedWithExistingValues(quay)) {
return;
}
if (quaysAlreadyProcessed.contains(quay.getId())) {
return;
}
var wheelchair = wheelchairAccessibilityFromQuay(quay, stopPlace);
RegularStop stop = quayMapper.mapQuayToStop(quay, station, fareZones, transitMode, wheelchair);
if (stop == null) {
return;
}
resultStops.add(stop);
quaysAlreadyProcessed.add(quay.getId());
}
/**
* Return the list of quays for the given {@code stopPlace} or an empty list if no quays exist.
*
* We do not support quay references, all quays must be included as part of the given stopPlace.
*/
private List listOfQuays(StopPlace stopPlace) {
Quays_RelStructure quays = stopPlace.getQuays();
if (quays == null) {
issueStore.add(new StopPlaceWithoutQuays(stopPlace.getId()));
return Collections.emptyList();
}
List result = new ArrayList<>();
for (JAXBElement it : quays.getQuayRefOrQuay()) {
if (it.getValue() instanceof Quay quay) {
result.add(quay);
} else {
issueStore.add(
Issue.issue(
"StopPlaceWithoutQuays",
"StopPlace %s has unsupported quay reference: %s",
stopPlace.getId(),
it
)
);
}
}
return result;
}
/**
* Get WheelChairBoarding from Quay and parent Station.
*
* @param quay NeTEx quay could contain information about accessibility
* @param stopPlace Parent StopPlace for given Quay
* @return not null value with default NO_INFORMATION if nothing defined in quay or parentStation.
*/
private Accessibility wheelchairAccessibilityFromQuay(Quay quay, StopPlace stopPlace) {
var defaultWheelChairBoarding = Accessibility.NO_INFORMATION;
if (stopPlace != null) {
defaultWheelChairBoarding = WheelChairMapper.wheelchairAccessibility(
stopPlace.getAccessibilityAssessment(),
Accessibility.NO_INFORMATION
);
}
return WheelChairMapper.wheelchairAccessibility(
quay.getAccessibilityAssessment(),
defaultWheelChairBoarding
);
}
}