org.opentripplanner.routing.algorithm.mapping.RoutingRequestToFilterChainMapper 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.routing.algorithm.mapping;

import org.opentripplanner.model.plan.Itinerary;
import org.opentripplanner.routing.algorithm.filterchain.ItineraryFilter;
import org.opentripplanner.routing.algorithm.filterchain.ItineraryFilterChainBuilder;
import org.opentripplanner.routing.api.request.RoutingRequest;

import java.time.Instant;
import java.util.function.Consumer;

public class RoutingRequestToFilterChainMapper {

  /** Filter itineraries down to this limit, but not below. */
  private static final int MIN_NUMBER_OF_ITINERARIES = 3;

  /** Never return more that this limit of itineraries. */
  private static final int MAX_NUMBER_OF_ITINERARIES = 200;

  public static ItineraryFilter createFilterChain(
      RoutingRequest request,
      Instant filterOnLatestDepartureTime,
      Consumer maxLimitReachedSubscriber
  ) {
    var builder = new ItineraryFilterChainBuilder(request.arriveBy);

    if (request.groupBySimilarityKeepOne >= 0.5) {
      builder.addGroupBySimilarity(request.groupBySimilarityKeepOne, 1);
    }

    if (request.groupBySimilarityKeepNumOfItineraries >= 0.5) {
      int minLimit = request.numItineraries;
      if (minLimit < 0 || minLimit > MIN_NUMBER_OF_ITINERARIES) {
        minLimit = MIN_NUMBER_OF_ITINERARIES;
      }
      builder.addGroupBySimilarity(request.groupBySimilarityKeepNumOfItineraries, minLimit);
    }

    builder
        .withMaxNumberOfItineraries(Math.min(request.numItineraries, MAX_NUMBER_OF_ITINERARIES))
        .withTransitGeneralizedCostLimit(request.transitGeneralizedCostLimit)
        .withRemoveTransitWithHigherCostThanBestOnStreetOnly(true)
        .withLatestDepartureTimeLimit(filterOnLatestDepartureTime)
        .withMaxLimitReachedSubscriber(maxLimitReachedSubscriber)
        .withDebugEnabled(request.debugItineraryFilter);

    return builder.build();
  }
}