org.opentripplanner.transit.raptor.rangeraptor.path.configure.PathConfig Maven / Gradle / Ivy

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.transit.raptor.rangeraptor.path.configure;


import static org.opentripplanner.transit.raptor.rangeraptor.path.PathParetoSetComparators.comparatorStandard;
import static org.opentripplanner.transit.raptor.rangeraptor.path.PathParetoSetComparators.comparatorStandardAndLatestDepature;
import static org.opentripplanner.transit.raptor.rangeraptor.path.PathParetoSetComparators.comparatorWithCost;
import static org.opentripplanner.transit.raptor.rangeraptor.path.PathParetoSetComparators.comparatorWithCostAndLatestDeparture;
import static org.opentripplanner.transit.raptor.rangeraptor.path.PathParetoSetComparators.comparatorWithRelaxedCost;
import static org.opentripplanner.transit.raptor.rangeraptor.path.PathParetoSetComparators.comparatorWithRelaxedCostAndLatestDeparture;
import static org.opentripplanner.transit.raptor.rangeraptor.path.PathParetoSetComparators.comparatorWithTimetable;
import static org.opentripplanner.transit.raptor.rangeraptor.path.PathParetoSetComparators.comparatorWithTimetableAndCost;
import static org.opentripplanner.transit.raptor.rangeraptor.path.PathParetoSetComparators.comparatorWithTimetableAndRelaxedCost;

import org.opentripplanner.transit.raptor.api.path.Path;
import org.opentripplanner.transit.raptor.api.transit.RaptorTripSchedule;
import org.opentripplanner.transit.raptor.rangeraptor.path.DestinationArrivalPaths;
import org.opentripplanner.transit.raptor.rangeraptor.transit.SearchContext;
import org.opentripplanner.transit.raptor.util.paretoset.ParetoComparator;

/**
 * This class is responsible for creating a a result collector - the
 * set of paths.
 * 
 * This class have REQUEST scope, so a new instance should be created
 * for each new request/travel search.
 *
 * @param  The TripSchedule type defined by the user of the raptor API.
 */
public class PathConfig {
    private final SearchContext ctx;

    public PathConfig(SearchContext context) {
        this.ctx = context;
    }

    /**
     * Create a new {@link DestinationArrivalPaths} each time it is invoked.
     * The given {@code includeCost} decide if the cost should be included in the
     * pareto set criteria or not.
     */
    public DestinationArrivalPaths createDestArrivalPaths(boolean includeCost) {
        return new DestinationArrivalPaths<>(
                paretoComparator(includeCost),
                ctx.calculator(),
                ctx.costCalculator(),
                ctx.slackProvider(),
                ctx.pathMapper(),
                ctx.debugFactory(),
                ctx.stopNameResolver(),
                ctx.lifeCycle()
        );
    }

    private ParetoComparator> paretoComparator(boolean includeCost) {
        double relaxedCost = ctx.searchParams().relaxCostAtDestination();
        boolean includeRelaxedCost = includeCost && relaxedCost > 0.0;
        boolean includeTimetable = ctx.searchParams().timetableEnabled();
        boolean preferLateArrival = ctx.searchParams().preferLateArrival();


        if(includeTimetable && includeRelaxedCost) {
            return comparatorWithTimetableAndRelaxedCost(relaxedCost);
        }
        if(includeTimetable && includeCost) {
            return comparatorWithTimetableAndCost();
        }
        if(includeTimetable) {
            return comparatorWithTimetable();
        }
        if(includeRelaxedCost && preferLateArrival) {
            return comparatorWithRelaxedCostAndLatestDeparture(relaxedCost);
        }
        if(includeRelaxedCost) {
            return comparatorWithRelaxedCost(relaxedCost);
        }
        if(includeCost && preferLateArrival) {
            return comparatorWithCostAndLatestDeparture();
        }
        if(includeCost) {
            return comparatorWithCost();
        }
        if(preferLateArrival) {
            return comparatorStandardAndLatestDepature();
        }
        return comparatorStandard();
    }
}