com.precisely.addressing.v1

Interface Addressing

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

Addresser

All Known Implementing Classes:

Addresser

public interface Addressing
extends AutoCloseable

interface to interact with Addressing capabilities. it is capable of geocoding and verifying an address

 Addressing addressing = new AddressingBuilder()
         .withConfiguration(new AddressingConfigurationBuilder()
             .withResources(Paths.get("{directory}/ga-sdk-dist-3.1.187/resources")) // runtime resources location bundled in release distribution
             .withData(new SpdDataSourceBuilder()
                 .withSpdPaths(Paths.get("/data")) // location where software should scan for SPD data
                 .withNumberOfExtractors(3)
                 .withExtractedPath(Paths.get("/data")) // location where data should be extracted
                 .build())
             .build())
         .build();
 

Method Summary

Modifier and Type	Method and Description
Capabilities	capabilities() Get supported capabilities of addresser
Response	geocode(RequestAddress address, Preferences preferences)
ConfiguredDictionaryOutput	getConfiguredDictionaries(ConfiguredDictionaryInput request)
Response	lookup(LookupType type, Preferences preferences, KeyValue... key)
ParsedResponse	parse(RequestAddress address, Preferences preferences) Deprecated.
ParsedResponseV2	parseV2(RequestAddress address, Preferences preferences)
PredictionResponse	predict(RequestAddress address, Preferences preferences) parse address elements
PredictionResponseV2	predictV2(RequestAddress address, Preferences preferences) parse address elements
Response	reverse(Double x, Double y, String country, Preferences preferences) find address for given coordinates
Response	verify(RequestAddress address, Preferences preferences)

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

verify

Response verify(RequestAddress address,
                Preferences preferences)
         throws AddressingException

Parameters:

address - address that needs to be verified

preferences - criteria controlling aspects of verification

Returns:

response containing address information

Throws:

AddressingException - exception is thrown only when underlying implementation fails to populate

geocode

Response geocode(RequestAddress address,
                 Preferences preferences)
          throws AddressingException

Parameters:

address - address that need to be geocoded

preferences - criteria controlling aspects of geocoding

Returns:

response containing address information

Throws:

AddressingException - exception is thrown only when underlying implementation fails to populate

getConfiguredDictionaries

ConfiguredDictionaryOutput getConfiguredDictionaries(ConfiguredDictionaryInput request)
                                              throws AddressingException

Parameters:

request - which contains country code for fetching list of configured dictionaries.

Returns:

ConfiguredDictionaryOutput containing list of configured dictionaries.

Throws:

AddressingException - exception is thrown only when underlying implementation fails

parse

@Deprecated
ParsedResponse parse(RequestAddress address,
                                 Preferences preferences)
                          throws AddressingException

Deprecated.

Deprecated and will be removed in future release. Use the parseV2 method.

Parameters:

address - address that needs to be parsed

preferences - criteria controlling aspects of parsing

Returns:

response containing address information

Throws:

AddressingException - exception is thrown only when underlying implementation fails to populate

parseV2

ParsedResponseV2 parseV2(RequestAddress address,
                         Preferences preferences)
                  throws AddressingException

Parameters:

address - address that needs to be parsed

preferences - criteria controlling aspects of parsing

Returns:

response containing address information

Throws:

AddressingException - exception is thrown only when underlying implementation fails to populate

predict

PredictionResponse predict(RequestAddress address,
                           Preferences preferences)
                    throws AddressingException

parse address elements

Parameters:

address - request address

preferences - preferences to control how matching is done or how the data is returned

Returns:

response containing address information PredictionResponse

Throws:

AddressingException - exception is thrown only when underlying implementation fails to populate

predictV2

PredictionResponseV2 predictV2(RequestAddress address,
                               Preferences preferences)
                        throws AddressingException

parse address elements

Parameters:

address - request address

preferences - preferences to control how matching is done or how the data is returned

Returns:

response containing address information PredictionResponse

Throws:

AddressingException - exception is thrown only when underlying implementation fails to populate

lookup

Response lookup(LookupType type,
                Preferences preferences,
                KeyValue... key)
         throws AddressingException

Parameters:

type - LookupType i.e PB_KEY

preferences - preferences to control how matching is done or how the data is returned

key - key information for lookup

Returns:

response containing address information

Throws:

AddressingException - exception is thrown only when underlying implementation fails to populate

reverse

Response reverse(Double x,
                 Double y,
                 String country,
                 Preferences preferences)
          throws AddressingException

find address for given coordinates

Parameters:

x - coordinate longitude

y - coordinate latitude

country - country

preferences - preferences to control how matching is done or how the data is returned

Returns:

response containing address information

Throws:

AddressingException - exception is thrown only when underlying implementation fails to populate

capabilities

Capabilities capabilities()
                   throws AddressingException

Get supported capabilities of addresser

Returns:

[@see com.precisely.addressing.v1.model.Capabilities]

Throws:

AddressingException - exception is thrown only when underlying implementation fails to populate