org.opentripplanner.routing.algorithm.filterchain.deletionflagger.MaxLimitFilter 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.filterchain.deletionflagger;

import com.google.common.collect.Lists;
import java.util.List;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import org.opentripplanner.model.plan.Itinerary;
import org.opentripplanner.routing.algorithm.filterchain.ListSection;


/**
 * Flag all itineraries after the provided limit. This flags the itineraries at the end of the list
 * for removal, so the list should be sorted on the desired key before this filter is applied.
 * 
 * The filter can also report the first itinerary in the list it will flag. The subscriber
 * is optional.
 */
public class MaxLimitFilter implements ItineraryDeletionFlagger {
    private static final Consumer IGNORE_SUBSCRIBER = (i) -> {};

    private final String name;
    private final int maxLimit;
    private final ListSection cropSection;
    private final Consumer changedSubscriber;

    /** Create filter with default crop(TAIL) and without any callback. */
    public MaxLimitFilter(String name, int maxLimit) {
        this(name, maxLimit, ListSection.TAIL, IGNORE_SUBSCRIBER);
    }

    public MaxLimitFilter(
            String name,
            int maxLimit,
            ListSection cropSection,
            Consumer changedSubscriber
    ) {
        this.name = name;
        this.maxLimit = maxLimit;
        this.cropSection = cropSection;
        this.changedSubscriber = changedSubscriber == null ? IGNORE_SUBSCRIBER : changedSubscriber;
    }

    @Override
    public String name() {
        return name;
    }

    @Override
    public List getFlaggedItineraries(List itineraries) {
        if(itineraries.size() <= maxLimit) { return List.of(); }

        if(cropSection == ListSection.HEAD) { itineraries = Lists.reverse(itineraries); }

        changedSubscriber.accept(itineraries.get(maxLimit));
        return itineraries.stream().skip(maxLimit).collect(Collectors.toList());
    }
}