Extract parking lots from NeTEx feeds #5946

leonardehrenfried · 2024-07-04T12:43:54Z

Summary

This parses parking information from NeTEx XML feeds and inserts them into the already existing OTP model for parking data.

It also improves the capabilities to debug parking in the debug client.

If you want to see example data for the Italian region of South Tyrol: https://transmodel.api.opendatahub.com/netex/parking

Unit tests

I added a few tests for the mappers but there is a lot of code that does wiring inside the NetexModule. I'm not sure how much I should test that.

Documentation

I only added Javadoc but I feel we should document this somewhere. https://docs.opentripplanner.org/en/latest/Netex-Norway/ seems like a good place to document but it's pretty old and more of a tutorial rather than reference document.

cc @rcavaliere @clezag

codecov · 2024-07-04T12:53:09Z

Codecov Report

Attention: Patch coverage is 70.77922% with 45 lines in your changes missing coverage. Please review.

Project coverage is 69.65%. Comparing base (c3c1ea0) to head (ed6b165).
Report is 55 commits behind head on dev-2.x.

Files	Patch %	Lines
.../inspector/vector/vertex/VertexPropertyMapper.java	0.00%	17 Missing ⚠️
...ripplanner/netex/mapping/VehicleParkingMapper.java	84.61%	5 Missing and 1 partial ⚠️
.../routing/vehicle_parking/VehicleParkingSpaces.java	0.00%	6 Missing ⚠️
...org/opentripplanner/inspector/vector/KeyValue.java	20.00%	3 Missing and 1 partial ⚠️
...ipplanner/netex/loader/parser/SiteFrameParser.java	55.55%	3 Missing and 1 partial ⚠️
...org/opentripplanner/netex/mapping/NetexMapper.java	63.63%	4 Missing ⚠️
...anner/graph_builder/module/StreetLinkerModule.java	0.00%	0 Missing and 1 partial ⚠️
...ntripplanner/netex/config/NetexFeedParameters.java	92.85%	0 Missing and 1 partial ⚠️
...anner/netex/loader/parser/NetexDocumentParser.java	80.00%	0 Missing and 1 partial ⚠️
...eet/model/vertex/VehicleParkingEntranceVertex.java	50.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##             dev-2.x    #5946    +/-   ##
===========================================
  Coverage      69.64%   69.65%            
- Complexity     17138    17186    +48     
===========================================
  Files           1937     1945     +8     
  Lines          73747    73909   +162     
  Branches        7546     7562    +16     
===========================================
+ Hits           51362    51478   +116     
- Misses         19752    19798    +46     
  Partials        2633     2633

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

leonardehrenfried · 2024-07-04T14:13:28Z

src/main/java/org/opentripplanner/netex/index/NetexEntityIndex.java

@@ -184,6 +190,7 @@ public NetexEntityIndex(NetexEntityIndex parent) {
    this.tariffZonesById = new HierarchicalVersionMapById<>(parent.tariffZonesById);
    this.brandingById = new HierarchicalMapById<>(parent.brandingById);
    this.timeZone = new HierarchicalElement<>(parent.timeZone);
+    this.parkings = new HashSet<>(parent.parkings);


Use HierarchicalMapById

vpaturet · 2024-07-15T08:06:05Z

The serialization id must be bumped due to a change in the Graph object

vpaturet · 2024-07-15T09:57:17Z

I have checked with Norwegian data, the parking data do not get imported, probably because of the hierarchical structure of the NeTEx dataset (shared stop file + line-specific files). When mapping the parking in org.opentripplanner.netex.NetexBundle#vehicleParkings, there is no local value in the hierarchical map, all keys are present in the parent hierarchical map.
Maybe you could follow the same pattern as for Entrance or StopPlace?
From a design perspective it is also probably better to define a Parking entity under transit/model/site, so that you can follow the same approach as with the other SiteFrame entities.

leonardehrenfried · 2024-07-15T16:26:07Z

The very latest version imports the Norway NeTEx feed without errors.

leonardehrenfried · 2024-07-17T09:45:36Z

I have now added the switch to ignore the parking data.

habrahamsson-skanetrafiken

This looks very well worked out. Just a question and a minor issue.

habrahamsson-skanetrafiken · 2024-07-23T13:18:07Z

src/main/java/org/opentripplanner/inspector/vector/KeyValue.java

 public record KeyValue(String key, Object value) {
  public static KeyValue kv(String key, Object value) {
    return new KeyValue(key, value);
  }
+  public static KeyValue kv(String key, FeedScopedId value) {


I'm a bit unfamiliar with this part of the code. Could you help me understand what is this KeyValue class used for? And why do we want to stringify the FeedScopedId instead of using the object itself as the value?

I would like the parameter and the property to be marked @Nullable if nulls are expected.

I wrote a bit of JavaDoc but here is the explanation:

This is a class that contains values that are then serialized by the vector tiles library and used in the Debug UI. Normally, you would use the values for styling but we mainly just display them in popups, like this:

Since the vector tiles are by design a very efficient data format they don't support any complex data types so FeedScopedId is silently ignored. Since I kept forgetting this, I created a little helper that convert the id to a string.

src/main/java/org/opentripplanner/standalone/config/buildconfig/NetexConfig.java

Co-authored-by: Henrik Abrahamsson <127481124+habrahamsson-skanetrafiken@users.noreply.github.com>

leonardehrenfried · 2024-07-25T14:18:40Z

@vpaturet NeTEx parking is now ignored by default.

leonardehrenfried added Sandbox NeTEx This issue is related to the Netex model/import. labels Jul 4, 2024

leonardehrenfried requested a review from a team as a code owner July 4, 2024 12:43

leonardehrenfried force-pushed the netex-parking branch from 21d9acd to 70af97e Compare July 4, 2024 12:47

leonardehrenfried force-pushed the netex-parking branch from 70af97e to 0ca9720 Compare July 4, 2024 13:19

leonardehrenfried commented Jul 4, 2024

View reviewed changes

leonardehrenfried requested review from t2gran and removed request for t2gran July 4, 2024 14:17

leonardehrenfried force-pushed the netex-parking branch from eabbf6c to aff04b9 Compare July 8, 2024 15:47

leonardehrenfried added 13 commits July 8, 2024 17:49

Parse parking lots from NeTEx

dbdc80b

Flesh out parsing, add test

8550feb

Fix building of capacity

e95b675

Change wiring of vehicle parking

b5d492a

Improve building of the links

3133496

Swap colour order

96b9004

Format code

90ddcec

Update snapshot tests

39f13f3

Update docs

2dd6589

Update Javadoc and implementation

aab96e6

Add test for linking

6df518f

Add more tests

c12d713

Use HierarchicalMapById

5525701

leonardehrenfried force-pushed the netex-parking branch from aff04b9 to 5525701 Compare July 8, 2024 15:49

leonardehrenfried requested a review from vpaturet July 9, 2024 09:27

leonardehrenfried added this to the 2.6 (next release) milestone Jul 12, 2024

vpaturet added the bump serialization id Add this label if you want the serialization id automatically bumped after merging the PR label Jul 15, 2024

Add test for allPassengerVehicles

c6ae01a

Add more robust null check for issue

618e0a1

leonardehrenfried added 8 commits July 16, 2024 12:49

Add comment

949a6c7

Add config option to ignore parking

44edc44

Add code reuse

3a88dd3

Merge remote-tracking branch 'upstream/dev-2.x' into netex-parking

938f451

Add Javadoc

1238429

Replace typo in 'finishUp'

cc659fa

Merge remote-tracking branch 'upstream/dev-2.x' into netex-parking

5813d2c

Invert check

990ce7c

leonardehrenfried mentioned this pull request Jul 19, 2024

SIRI-FM vehicle parking updates #5979

Merged

Merge remote-tracking branch 'upstream/dev-2.x' into netex-parking

6181512

leonardehrenfried requested a review from habrahamsson-skanetrafiken July 23, 2024 08:52

habrahamsson-skanetrafiken requested changes Jul 23, 2024

View reviewed changes

leonardehrenfried and others added 3 commits July 23, 2024 15:55

Fix copy&paste error

7b1f760

Co-authored-by: Henrik Abrahamsson <127481124+habrahamsson-skanetrafiken@users.noreply.github.com>

Replace identity with equality

1876a04

Add Javadoc for KeyValue

1cfaa38

leonardehrenfried requested a review from habrahamsson-skanetrafiken July 23, 2024 14:27

leonardehrenfried added 2 commits July 23, 2024 16:31

Rename variable

a2eaecc

Ignore NeTEx parking by default

6eae019

Update tests

ed6b165

leonardehrenfried enabled auto-merge July 25, 2024 14:29

vpaturet approved these changes Jul 25, 2024

View reviewed changes

habrahamsson-skanetrafiken approved these changes Jul 29, 2024

View reviewed changes

leonardehrenfried merged commit 475ea53 into opentripplanner:dev-2.x Jul 29, 2024
6 checks passed

t2gran pushed a commit that referenced this pull request Jul 29, 2024

Add changelog entry for #5946 [ci skip]

a314730

t2gran pushed a commit that referenced this pull request Jul 29, 2024

Bump serialization version id for #5946

4c33d38

leonardehrenfried deleted the netex-parking branch July 29, 2024 12:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extract parking lots from NeTEx feeds #5946

Extract parking lots from NeTEx feeds #5946

leonardehrenfried commented Jul 4, 2024 •

edited

Loading

codecov bot commented Jul 4, 2024 •

edited

Loading

leonardehrenfried Jul 4, 2024

vpaturet commented Jul 15, 2024

vpaturet commented Jul 15, 2024 •

edited

Loading

leonardehrenfried commented Jul 15, 2024

leonardehrenfried commented Jul 17, 2024

habrahamsson-skanetrafiken left a comment

habrahamsson-skanetrafiken Jul 23, 2024

leonardehrenfried Jul 23, 2024

leonardehrenfried commented Jul 25, 2024

Extract parking lots from NeTEx feeds #5946

Extract parking lots from NeTEx feeds #5946

Conversation

leonardehrenfried commented Jul 4, 2024 • edited Loading

Summary

Unit tests

Documentation

codecov bot commented Jul 4, 2024 • edited Loading

Codecov Report

leonardehrenfried Jul 4, 2024

Choose a reason for hiding this comment

vpaturet commented Jul 15, 2024

vpaturet commented Jul 15, 2024 • edited Loading

leonardehrenfried commented Jul 15, 2024

leonardehrenfried commented Jul 17, 2024

habrahamsson-skanetrafiken left a comment

Choose a reason for hiding this comment

habrahamsson-skanetrafiken Jul 23, 2024

Choose a reason for hiding this comment

leonardehrenfried Jul 23, 2024

Choose a reason for hiding this comment

leonardehrenfried commented Jul 25, 2024

leonardehrenfried commented Jul 4, 2024 •

edited

Loading

codecov bot commented Jul 4, 2024 •

edited

Loading

vpaturet commented Jul 15, 2024 •

edited

Loading