org.opentripplanner.transit.raptor.api.response.RaptorResponse 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.api.response;

import org.opentripplanner.model.base.ToStringBuilder;
import org.opentripplanner.transit.raptor.api.path.Path;
import org.opentripplanner.transit.raptor.api.request.RaptorRequest;
import org.opentripplanner.transit.raptor.api.transit.RaptorTripSchedule;

import java.util.Collection;


/**
 * This is the result of a raptor search including the the result paths, the original request
 * (unmodified) and the the main request used to perform the raptor search. The {@link
 * org.opentripplanner.transit.raptor.RaptorService} might perform additional heuristic searches,
 * too, but the requests for these are not returned.
 *
 * @param  The TripSchedule type defined by the user of the raptor API.
 */
public class RaptorResponse {
    private final Collection> paths;
    private final RaptorRequest requestOriginal;
    private final RaptorRequest requestUsed;

    public RaptorResponse(
            Collection> paths,
            RaptorRequest requestOriginal,
            RaptorRequest requestUsed
    ) {
        this.paths = paths;
        this.requestOriginal = requestOriginal;
        this.requestUsed = requestUsed;
    }

    /**
     * The result paths found in the search.
     */
    public Collection> paths() {
        return paths;
    }

    /**
     * The original request issued to perform the travel search.
     */
    public RaptorRequest requestOriginal() {
        return requestOriginal;
    }

    /**
     * The actual request used to perform the travel search. In the case of a multi-criteria
     * search, heuristics is used to optimize the search and the request is changed to account
     * for this. Also, different optimization may add filters (stop filter) to the request.
     * Heuristics is also used to "guess" on an appropriate search-window, earliest-departure-time
     * and latest-arrival-time.
     */
    public RaptorRequest requestUsed() {
        return requestUsed;
    }

    @Override
    public String toString() {
        return ToStringBuilder.of(RaptorResponse.class)
            .addObj("paths", paths)
            .addObj("requestOriginal", requestOriginal)
            .addObj("requestUsed", requestUsed)
            .toString();
    }
}