org.opentripplanner.netex.loader.mapping.TripMapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation
The OpenTripPlanner multimodal journey planning system
There is a newer version: 2.6.0
package org.opentripplanner.netex.loader.mapping;

import org.opentripplanner.model.FeedScopedId;
import org.opentripplanner.model.Trip;
import org.opentripplanner.model.impl.EntityById;
import org.opentripplanner.netex.loader.util.ReadOnlyHierarchicalMap;
import org.opentripplanner.netex.support.DayTypeRefsToServiceIdAdapter;
import org.rutebanken.netex.model.JourneyPattern;
import org.rutebanken.netex.model.LineRefStructure;
import org.rutebanken.netex.model.Route;
import org.rutebanken.netex.model.ServiceJourney;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.xml.bind.JAXBElement;
import java.util.Set;

/**
 * This maps a NeTEx ServiceJourney to an OTP Trip. A ServiceJourney can be connected to a Line (OTP
 * Route) in two ways. Either directly from the ServiceJourney or through JourneyPattern → Route.
 * The former has precedent over the latter.
 */
class TripMapper {
    private static final Logger LOG = LoggerFactory.getLogger(TripMapper.class);

    private final FeedScopedIdFactory idFactory;
    private EntityById otpRouteById;
    private ReadOnlyHierarchicalMap routeById;
    private ReadOnlyHierarchicalMap journeyPatternsById;
  private final Set shapePointIds;

    TripMapper(
            FeedScopedIdFactory idFactory,
            EntityById otpRouteById,
            ReadOnlyHierarchicalMap routeById,
      ReadOnlyHierarchicalMap journeyPatternsById,
      Set shapePointIds
    ) {
        this.idFactory = idFactory;
        this.otpRouteById = otpRouteById;
        this.routeById = routeById;
        this.journeyPatternsById = journeyPatternsById;
    this.shapePointIds = shapePointIds;
    }

    /**
     * Map a service journey to a trip.
     * 
   *
     * @return valid trip or {@code null} if unable to map to a valid trip.
     */
    Trip mapServiceJourney(ServiceJourney serviceJourney){
        org.opentripplanner.model.Route route = resolveRoute(serviceJourney);
        String serviceId = resolveServiceId(serviceJourney);

        if(serviceId == null || route == null) {
            return null;
        }

        Trip trip = new Trip();
        trip.setId(idFactory.createId(serviceJourney.getId()));
        trip.setRoute(route);
        trip.setServiceId(idFactory.createId(serviceId));
        trip.setShapeId(getShapeId(serviceJourney));
        if (serviceJourney.getPrivateCode() != null) {
          trip.setInternalPlanningCode(serviceJourney.getPrivateCode().getValue());
        }
        trip.setTripShortName(serviceJourney.getPublicCode());

        return trip;
    }

    private FeedScopedId getShapeId(ServiceJourney serviceJourney) {
        JourneyPattern journeyPattern = journeyPatternsById.lookup(serviceJourney.getJourneyPatternRef().getValue().getRef());
    FeedScopedId serviceLinkId = journeyPattern != null ? idFactory.createId(journeyPattern
        .getId().replace("JourneyPattern", "ServiceLink")) : null;

    return shapePointIds.contains(serviceLinkId) ? serviceLinkId : null;
    }

    private String resolveServiceId(ServiceJourney serviceJourney) {
        String serviceId =  DayTypeRefsToServiceIdAdapter.createServiceId(serviceJourney.getDayTypes());
        if(serviceId == null) {
            LOG.warn(
                    "Not able to generate serviceId for ServiceJourney, dayTypes is empty. ServiceJourney id: {}",
                    serviceJourney.getId()
            );
        }
        return serviceId;
    }

    private org.opentripplanner.model.Route resolveRoute(ServiceJourney serviceJourney) {
        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
      JourneyPattern journeyPattern = journeyPatternsById.lookup(serviceJourney
          .getJourneyPatternRef()
          .getValue()
          .getRef());
            String routeRef = journeyPattern.getRouteRef().getRef();
            lineRef = routeById.lookup(routeRef).getLineRef().getValue().getRef();
        }
        org.opentripplanner.model.Route route = otpRouteById.get(idFactory.createId(lineRef));

        if(route == null) {
            LOG.warn(
                    "Unable to link ServiceJourney to Route. ServiceJourney id: "
                    + serviceJourney.getId()
                    + ", Line ref: " + lineRef
            );
        }
        return route;
    }
}