com.pb.geocoding

Class GeocoderBuilder

java.lang.Object

com.pb.geocoding.GeocoderBuilder

public class GeocoderBuilder
extends Object

A builder of GeocodingAPI

Since:

3.0.0

 GeocodingAPI geocoder = new GeocoderBuilder()
         //path to ggs runtime resources, this will be located under ggs distribution
         .withConfiguration(Paths.get("{directory}/ga-sdk-dist-{version}/resources"))
         // This is where you can set default preferences. If this is not set, the default preferences would be used from
         // configuration file: {directory}/ga-sdk-dist-{version}/resources/config/geocodePreferences.xml
         .withPreferences(new GeocoderPreferences())
         .build();
 

Constructor Summary

Constructors

Constructor and Description
GeocoderBuilder()

Method Summary

Modifier and Type	Method and Description
GeocodingAPI	build() This will build and return an instance GeocodingAPI based of the configuration.
GeocoderBuilder	withConfiguration(com.pb.geocoding.config.api.GeocodingConfiguration configuration) Provide GeocodingConfiguration assembled by ConfigurationBuilder
GeocoderBuilder	withConfiguration(Path resources) Provide runtime resources location for SDK
GeocoderBuilder	withPreferences(Preferences preferences) This is where you can set default preferences.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeocoderBuilder

public GeocoderBuilder()

Method Detail

withConfiguration

public GeocoderBuilder withConfiguration(Path resources)
                                  throws GeocodingException

Provide runtime resources location for SDK

Parameters:

resources - path to runtime resources /ga-sdk-dist-{version}/resources

Returns:

GeocoderBuilder

Throws:

GeocodingException

withConfiguration

public GeocoderBuilder withConfiguration(com.pb.geocoding.config.api.GeocodingConfiguration configuration)
                                  throws GeocodingException

Provide GeocodingConfiguration assembled by ConfigurationBuilder

Parameters:

configuration - configuration for geocoder build using ConfigurationBuilder

Returns:

GeocoderBuilder

Throws:

GeocodingException

withPreferences

public GeocoderBuilder withPreferences(Preferences preferences)
                                throws GeocodingException

This is where you can set default preferences. If this is not set, the default preferences would be used from configuration file: {directory}/ga-sdk-dist-{version}/resources/config/geocodePreferences.xml

Parameters:

preferences - default preferences that must be used if user does not provide request specific preferences

Returns:

GeocoderBuilder

Throws:

GeocodingException

build

public GeocodingAPI build()
                   throws GeocodingException

This will build and return an instance GeocodingAPI based of the configuration.

Returns:

GeocodingAPI

Throws:

GeocodingException