-
Notifications
You must be signed in to change notification settings - Fork 101
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: transfers.txt trip=>route reference validation. (#1267)
* Initial transfers.txt trip=>route reference validation. * Use a FileValidator to support injection. * Add trip=>stop reference checks. * More transfers.txt validation. * Adding comments, unit-tests, and documentation for new validators. * Table formatting.
- Loading branch information
1 parent
23366db
commit ba7a83e
Showing
5 changed files
with
589 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
102 changes: 102 additions & 0 deletions
102
main/src/main/java/org/mobilitydata/gtfsvalidator/validator/TransfersStopTypeValidator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| package org.mobilitydata.gtfsvalidator.validator; | ||
|
|
||
| import java.util.Optional; | ||
| import javax.inject.Inject; | ||
| import org.mobilitydata.gtfsvalidator.annotation.GtfsValidator; | ||
| import org.mobilitydata.gtfsvalidator.notice.NoticeContainer; | ||
| import org.mobilitydata.gtfsvalidator.notice.SeverityLevel; | ||
| import org.mobilitydata.gtfsvalidator.notice.ValidationNotice; | ||
| import org.mobilitydata.gtfsvalidator.table.GtfsLocationType; | ||
| import org.mobilitydata.gtfsvalidator.table.GtfsStop; | ||
| import org.mobilitydata.gtfsvalidator.table.GtfsStopTableContainer; | ||
| import org.mobilitydata.gtfsvalidator.table.GtfsTransfer; | ||
| import org.mobilitydata.gtfsvalidator.table.GtfsTransferTableContainer; | ||
| import org.mobilitydata.gtfsvalidator.table.GtfsTransferTableLoader; | ||
|
|
||
| /** | ||
| * Validates that {@code transfers.from_stop_id} and {@code to_stop_id} reference stops or stations. | ||
| */ | ||
| @GtfsValidator | ||
| public class TransfersStopTypeValidator extends FileValidator { | ||
| private final GtfsTransferTableContainer transfersContainer; | ||
| private final GtfsStopTableContainer stopsContainer; | ||
|
|
||
| @Inject | ||
| public TransfersStopTypeValidator( | ||
| GtfsTransferTableContainer transfersContainer, GtfsStopTableContainer stopsContainer) { | ||
| this.transfersContainer = transfersContainer; | ||
| this.stopsContainer = stopsContainer; | ||
| } | ||
|
|
||
| @Override | ||
| public void validate(NoticeContainer noticeContainer) { | ||
| for (GtfsTransfer entity : transfersContainer.getEntities()) { | ||
| validateEntity(entity, noticeContainer); | ||
| } | ||
| } | ||
|
|
||
| public void validateEntity(GtfsTransfer entity, NoticeContainer noticeContainer) { | ||
| validateStopType( | ||
| entity, | ||
| GtfsTransferTableLoader.FROM_STOP_ID_FIELD_NAME, | ||
| entity.fromStopId(), | ||
| noticeContainer); | ||
| validateStopType( | ||
| entity, GtfsTransferTableLoader.TO_STOP_ID_FIELD_NAME, entity.toStopId(), noticeContainer); | ||
| } | ||
|
|
||
| private void validateStopType( | ||
| GtfsTransfer entity, String stopIdFieldName, String stopId, NoticeContainer noticeContainer) { | ||
| Optional<GtfsStop> optStop = stopsContainer.byStopId(stopId); | ||
| if (optStop.isEmpty()) { | ||
| // Foreign key reference is validated elsewhere. | ||
| return; | ||
| } | ||
|
|
||
| GtfsLocationType locationType = optStop.get().locationType(); | ||
| if (!isValidTransferStopType(locationType)) { | ||
| noticeContainer.addValidationNotice( | ||
| new TransferWithInvalidStopLocationTypeNotice( | ||
| entity.csvRowNumber(), stopIdFieldName, stopId, locationType)); | ||
| } | ||
| } | ||
|
|
||
| private static boolean isValidTransferStopType(GtfsLocationType locationType) { | ||
| switch (locationType) { | ||
| case STOP: | ||
| case STATION: | ||
| return true; | ||
| default: | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * A `from_stop_id` or `to_stop_id` field from GTFS file `transfers.txt` references a stop that | ||
| * has a `location_type` other than 0 or 1 (aka Stop/Platform or Station). | ||
| * | ||
| * <p>Severity: {@code SeverityLevel.ERROR} | ||
| */ | ||
| public static final class TransferWithInvalidStopLocationTypeNotice extends ValidationNotice { | ||
| // The row number from `transfers.txt` for the faulty entry. | ||
| private final long csvRowNumber; | ||
| // The name of the stop id field (e.g. `from_stop_id`) referencing the stop. | ||
| private final String stopIdFieldName; | ||
| // The referenced stop id. | ||
| private final String stopId; | ||
| // The numeric value of the invalid location type. | ||
| private final int locationTypeValue; | ||
| // The name of the invalid location type. | ||
| private String locationTypeName; | ||
|
|
||
| public TransferWithInvalidStopLocationTypeNotice( | ||
| long csvRowNumber, String stopIdFieldName, String stopId, GtfsLocationType locationType) { | ||
| super(SeverityLevel.ERROR); | ||
| this.csvRowNumber = csvRowNumber; | ||
| this.stopIdFieldName = stopIdFieldName; | ||
| this.stopId = stopId; | ||
| this.locationTypeValue = locationType.getNumber(); | ||
| this.locationTypeName = locationType.toString(); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.