org.opentripplanner.transit.raptor.rangeraptor.path.PathMapper 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.5.0

package org.opentripplanner.transit.raptor.rangeraptor.path;

import org.opentripplanner.transit.raptor.api.path.Path;
import org.opentripplanner.transit.raptor.api.transit.RaptorTripSchedule;

/**
 * Responsible for mapping between the domain of routing to the domain of result paths.
 * Especially a regular forward search and a reverse search have different internal
 * data representations (latest possible arival times vs. arrival times); Hence one mapper
 * for each.
 *
 * @param  The TripSchedule type defined by the user of the raptor API.
 */
@FunctionalInterface
public interface PathMapper {
    /**
     * Build a path from a destination arrival - this maps between the domain of routing
     * to the domain of result paths. All values not needed for routing is computed as part of this mapping.
     */
     Path mapToPath(final DestinationArrival destinationArrival);
}