Package org.goplanit.osm.converter.zoning

Class OsmZoningReaderFactory

java.lang.Object

org.goplanit.osm.converter.zoning.OsmZoningReaderFactory

public class OsmZoningReaderFactory
extends Object

Factory for creating PLANitOSM zoning Readers. For now OSM zoning reader require the presence of an OSM network reader as those settings and subsequent reference network (that it is expected to populate) are inputs to the factory method. In other words and OSM zoning reader cannot be created in a stand-alone fashion, it always requires an OSMNetwork reader as well.

Author:

markr

Constructor Summary

Constructors

Constructor	Description
OsmZoningReaderFactory()

Method Summary

Modifier and Type	Method	Description
static OsmZoningReader	create(String inputFile, String countryName, PlanitOsmNetwork referenceNetwork)	Create a PLANitOSMReader while providing an OSM network to populate
static OsmZoningReader	create(String inputFile, String countryName, PlanitOsmNetwork referenceNetwork, OsmNetworkToZoningReaderData network2ZoningData)	Create a PLANitOSMReader while providing an OSM network to populate
static OsmZoningReader	create(String inputFile, String countryName, Zoning zoningToPopulate, PlanitOsmNetwork referenceNetwork, OsmNetworkToZoningReaderData network2ZoningData)	Create a PLANitOSMReader while providing an OSM network to populate
static OsmZoningReader	create(URL inputSource, String countryName, PlanitOsmNetwork referenceNetwork)	Create a PLANitOSMReader while providing an OSM network to populate
static OsmZoningReader	create(URL inputSource, String countryName, PlanitOsmNetwork referenceNetwork, OsmNetworkToZoningReaderData network2ZoningData)	Create a PLANitOSMReader while providing an OSM network to populate
static OsmZoningReader	create(URL inputSource, String countryName, Zoning zoningToPopulate, PlanitOsmNetwork referenceNetwork, OsmNetworkToZoningReaderData network2ZoningData)	Create a PLANitOSMReader while providing an OSM network to populate
static OsmZoningReader	create(OsmPublicTransportReaderSettings settings)	Create a PLANitOSMReader while providing an OSM network to populate
static OsmZoningReader	create(OsmPublicTransportReaderSettings settings, Zoning zoningToPopulate)	Create a PLANitOSMReader while providing an OSM network to populate
static OsmZoningReader	create(Zoning zoningToPopulate)	Create a default PLANitOsmZoningReader.

Methods inherited from class java.lang.Object

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

Constructor Detail

OsmZoningReaderFactory

public OsmZoningReaderFactory()

Method Detail

create

public static OsmZoningReader create(Zoning zoningToPopulate)
                              throws PlanItException

Create a default PLANitOsmZoningReader. User is expected to configure the reader via settings before invoking read() method

Parameters:

zoningToPopulate - to populate

Returns:

created OSM reader

Throws:

PlanItException - thrown if error

create

public static OsmZoningReader create(OsmPublicTransportReaderSettings settings)
                              throws PlanItException

Create a PLANitOSMReader while providing an OSM network to populate

Parameters:

settings - to use

Returns:

created OSM reader

Throws:

PlanItException - thrown if error

create

public static OsmZoningReader create(OsmPublicTransportReaderSettings settings,
                                     Zoning zoningToPopulate)
                              throws PlanItException

Create a PLANitOSMReader while providing an OSM network to populate

Parameters:

settings - to use

zoningToPopulate - to populate

Returns:

created OSM reader

Throws:

PlanItException - thrown if error

create

public static OsmZoningReader create(String inputFile,
                                     String countryName,
                                     PlanitOsmNetwork referenceNetwork)
                              throws PlanItException

Create a PLANitOSMReader while providing an OSM network to populate

Parameters:

inputFile - to use

countryName - name of the country

referenceNetwork - to use the same setup regarding id creation for zoning

Returns:

created OSM reader

Throws:

PlanItException - thrown if error

create

public static OsmZoningReader create(String inputFile,
                                     String countryName,
                                     PlanitOsmNetwork referenceNetwork,
                                     OsmNetworkToZoningReaderData network2ZoningData)
                              throws PlanItException

Create a PLANitOSMReader while providing an OSM network to populate

Parameters:

inputFile - to use

countryName - name of the country

referenceNetwork - to use the same setup regarding id creation for zoning

network2ZoningData - data transferred from parsing network to be used by zoning reader.

Returns:

created OSM reader

Throws:

PlanItException - thrown if error

create

public static OsmZoningReader create(String inputFile,
                                     String countryName,
                                     Zoning zoningToPopulate,
                                     PlanitOsmNetwork referenceNetwork,
                                     OsmNetworkToZoningReaderData network2ZoningData)
                              throws PlanItException

Create a PLANitOSMReader while providing an OSM network to populate

Parameters:

inputFile - to use

countryName - name of the country

zoningToPopulate - the zoning to populate

referenceNetwork - to use the same setup regarding id creation for zoning

network2ZoningData - data transferred from parsing network to be used by zoning reader.

Returns:

created OSM reader

Throws:

PlanItException - thrown if error

create

public static OsmZoningReader create(URL inputSource,
                                     String countryName,
                                     PlanitOsmNetwork referenceNetwork)
                              throws PlanItException

Create a PLANitOSMReader while providing an OSM network to populate

Parameters:

inputSource - to use

countryName - name of the country

referenceNetwork - to use the same setup regarding id creation for zoning

Returns:

created OSM reader

Throws:

PlanItException - thrown if error

create

public static OsmZoningReader create(URL inputSource,
                                     String countryName,
                                     PlanitOsmNetwork referenceNetwork,
                                     OsmNetworkToZoningReaderData network2ZoningData)
                              throws PlanItException

Create a PLANitOSMReader while providing an OSM network to populate

Parameters:

inputSource - to use

countryName - name of the country

referenceNetwork - to use the same setup regarding id creation for zoning

network2ZoningData - data transferred from parsing network to be used by zoning reader.

Returns:

created OSM reader

Throws:

PlanItException - thrown if error

create

public static OsmZoningReader create(URL inputSource,
                                     String countryName,
                                     Zoning zoningToPopulate,
                                     PlanitOsmNetwork referenceNetwork,
                                     OsmNetworkToZoningReaderData network2ZoningData)
                              throws PlanItException

Create a PLANitOSMReader while providing an OSM network to populate

Parameters:

inputSource - to use

countryName - name of the country

zoningToPopulate - the zoning to populate

referenceNetwork - to use the same setup regarding id creation for zoning

network2ZoningData - data transferred from parsing network to be used by zoning reader.

Returns:

created OSM reader

Throws:

PlanItException - thrown if error