com.conveyal.gtfs.validator.ReferencesTripValidator Maven / Gradle / Ivy

Go to download
package com.conveyal.gtfs.validator;

import com.conveyal.gtfs.error.SQLErrorStorage;
import com.conveyal.gtfs.loader.Feed;
import com.conveyal.gtfs.model.Route;
import com.conveyal.gtfs.model.ShapePoint;
import com.conveyal.gtfs.model.Stop;
import com.conveyal.gtfs.model.StopTime;
import com.conveyal.gtfs.model.Trip;

import java.util.HashSet;
import java.util.List;
import java.util.Set;

import static com.conveyal.gtfs.error.NewGTFSErrorType.*;

/**
 * This validator checks for unused entities in the dataset.
 *
 * It iterates over each trip and collects all of the route, trip, and stop IDs referenced by all of the trips found
 * within the feed. In the completion stage of the validator it verifies that there are no stops, trips, or routes in
 * the feed that do not actually get used by at least one trip.
 *
 * Created by abyrd on 2017-04-18
 */
public class ReferencesTripValidator extends TripValidator {

    Set referencedStops = new HashSet<>();
    Set referencedTrips = new HashSet<>();
    Set referencedRoutes = new HashSet<>();

    public ReferencesTripValidator(Feed feed, SQLErrorStorage errorStorage) {
        super(feed, errorStorage);
    }

    @Override
    public void validateTrip(Trip trip, Route route, List stopTimes, List stops) {
        if (trip != null) referencedTrips.add(trip.trip_id);
        if (route != null) referencedRoutes.add(route.route_id);
        for (Stop stop : stops) {
            referencedStops.add(stop.stop_id);
            // If a stop used by the trip has a parent station, count this among the referenced stops, too. While the
            // parent station may not be referenced directly, the relationship is functioning correctly and there is
            // not an issue with this stop being unreferenced.
            if (stop.parent_station != null) referencedStops.add(stop.parent_station);
        }
    }

    @Override
    public void complete (ValidationResult validationResult) {
        for (Stop stop : feed.stops) {
            if (!referencedStops.contains(stop.stop_id)) {
                registerError(stop, STOP_UNUSED, stop.stop_id);
            }
        }
        for (Trip trip : feed.trips) {
            if (!referencedTrips.contains(trip.trip_id)) {
                registerError(trip, TRIP_EMPTY);
            }
        }
        for (Route route : feed.routes) {
            if (!referencedRoutes.contains(route.route_id)) {
                registerError(route, ROUTE_UNUSED);
            }
        }
    }

}