Package org.goplanit.gtfs.converter.zoning

Class GtfsZoningReaderFactory

java.lang.Object

org.goplanit.gtfs.converter.zoning.GtfsZoningReaderFactory

public class GtfsZoningReaderFactory
extends Object

Factory for creating PLANitGTFS zoning (public transport infrastructure) Readers. GTFS zoning data, e.g. stops converted to PLANit transfer zone, require the service network and routed services (GTFS services, trips) to already been parsed via the GtfsServicesReader. It is also expected the input source is consistent with that parsing exercise. As an end-user it is likely best to directly parse all in one integrated go using the GtfsIntermodalReader instead of this factory.

Author:

markr

Constructor Summary

Constructors

Constructor	Description
GtfsZoningReaderFactory()

Method Summary

Modifier and Type	Method	Description
static GtfsZoningReader	create(GtfsZoningReaderSettings settings, Zoning zoningToPopulate, ServiceNetwork serviceNetwork, RoutedServices routedServices, Function<ServiceNode,String> serviceNodeToGtfsStopIdMapping)	Create a GTFS zoning reader, where information from an already present service network and routed services is leveraged to improve the quality of the parsing of PT stops, i.e., transfer zones.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GtfsZoningReaderFactory

public GtfsZoningReaderFactory()

Method Detail

create

public static GtfsZoningReader create(@NotNull
                                      GtfsZoningReaderSettings settings,
                                      @NotNull
                                      Zoning zoningToPopulate,
                                      @NotNull
                                      ServiceNetwork serviceNetwork,
                                      @NotNull
                                      RoutedServices routedServices,
                                      @NotNull
                                      Function<ServiceNode,String> serviceNodeToGtfsStopIdMapping)

Create a GTFS zoning reader, where information from an already present service network and routed services is leveraged to improve the quality of the parsing of PT stops, i.e., transfer zones. Here, the mode of routed services, trips, and their stops is used to match the stops already present in the zoning. Example: when sourcing the network from Open Street Map and only the phsyical network and stops are parsed. These can then be complemented with GTFS services. In order to properly match OSM stops (transfer zones) to GTFS stops, the mode is required. This mode is obtained from the GTFS services parsed earlier and available in the Service network and Routed Services, while the OSM stops are part of the Zoning. In that case this factory method is the best choice to fuse the two together.

Parameters:

settings - to use, containing the physical reference network and reference to source file and other configuration settings

zoningToPopulate - the zoning to populate further beyond the already partially populated transfer zones

serviceNetwork - the compatible PLANit service network that is assumed to have been constructed from the same GTFS source files as this zoning reader will use

routedServices - the compatible PLANit routed services that is assumed to have been constructed from the same GTFS source files as this zoning reader will use

serviceNodeToGtfsStopIdMapping - allows mapping between the service nodes in the routed services and the underlying GTFS stop ids which are presumed present such that we can create routes on the physical road/rail network

Returns:

zoning reader to use for parsing