Create the NumItinerariesFilter and the associated NumItinerariesFilterResults to limit itineraries based on the numItineraries parameter.

[eibakke]

Summary

This PR pulls functionality to limit the number of itineraries to the numItineraries parameter into a separate filter from the MaxLimitFilter because of the need to keep more information about the filtered itineraries than just the first one that is removed. The NumItinerariesFilterResults contains information used in the creation of page cursors currently, as well as information that will be used in the future deduplication feature.

Issue

N/A

Unit tests

Updated relevant unit tests and added a unittest for the new filter.

Documentation

Added JavaDoc.

Changelog

N/A

Bumping the serialization version id

N/A

[codecov]

Codecov Report

Attention: 15 lines in your changes are missing coverage. Please review.

Comparison is base (c608267) 66.79% compared to head (c0d42a2) 66.80%.
Report is 97 commits behind head on dev-2.x.

Additional details and impacted files

@@              Coverage Diff              @@
##             dev-2.x    #5450      +/-   ##
=============================================
+ Coverage      66.79%   66.80%   +0.01%     
- Complexity     15463    15556      +93     
=============================================
  Files           1798     1806       +8     
  Lines          69795    69821      +26     
  Branches        7357     7357              
=============================================
+ Hits           46619    46644      +25     
+ Misses         20720    20719       -1     
- Partials        2456     2458       +2     

Files	Coverage Δ
...er/ext/flex/template/FlexAccessEgressTemplate.java	71.42% <ø> (ø)
.../main/java/org/opentripplanner/model/StopTime.java	77.27% <ø> (ø)
...java/org/opentripplanner/model/plan/SortOrder.java	100.00% <ø> (ø)
...anner/model/plan/pagecursor/PageCursorFactory.java	98.52% <100.00%> (-0.16%)	⬇️
...entripplanner/routing/algorithm/RoutingWorker.java	80.70% <100.00%> (ø)
...m/filterchain/ItineraryListFilterChainBuilder.java	90.00% <100.00%> (ø)
...ner/routing/algorithm/filterchain/ListSection.java	100.00% <ø> (ø)
...hm/filterchain/deletionflagger/MaxLimitFilter.java	100.00% <ø> (ø)
...terchain/deletionflagger/NumItinerariesFilter.java	100.00% <100.00%> (ø)
...n/deletionflagger/NumItinerariesFilterResults.java	100.00% <100.00%> (ø)
... and 6 more

... and 60 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[leonardehrenfried]

I must admit that I don't fully understand the logic here so I would appreciate some context in a dev meeting.

Besides I picked up on a small thing.

[eibakke]

I must admit that I don't fully understand the logic here so I would appreciate some context in a dev meeting.

The idea is to capture more information about the result of applying the numItineraries condition and using it in the pageCursor for more accurate paging. I'll use it next in order to get rid of potential duplicates when paging. I'll happily explain more in today's meeting.

Besides I picked up on a small thing.

Taking a look at the timestamp addition suggestions and the question you had now.

[vpaturet]

Looks good to me.