com.precisely.addressing

Class Addresser

java.lang.Object

com.precisely.addressing.Addresser

All Implemented Interfaces:

Addressing, Addresser, AutoCloseable

public class Addresser
extends Object
implements Addresser

Constructor Summary

Constructors

Constructor and Description
Addresser(List<AddressFactory> addressFactories, AddressingConfiguration configuration)
Addresser(List<AddressFactory> addressFactories, AddressingConfiguration configuration, boolean onlyRemote)

Method Summary

Modifier and Type	Method and Description
Capabilities	capabilities() Get supported capabilities of addresser
void	close()
List<Feature>	features(String name)
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 and will be removed in future release.
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 class java.lang.Object

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

Constructor Detail

Addresser

public Addresser(List<AddressFactory> addressFactories,
                 AddressingConfiguration configuration,
                 boolean onlyRemote)
          throws AddressingException

Throws:

AddressingException

Addresser

public Addresser(List<AddressFactory> addressFactories,
                 AddressingConfiguration configuration)
          throws AddressingException

Throws:

AddressingException

Method Detail

verify

public Response verify(RequestAddress address,
                       Preferences preferences)
                throws AddressingException

Specified by:

verify in interface Addressing

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

public Response geocode(RequestAddress address,
                        Preferences preferences)
                 throws AddressingException

Specified by:

geocode in interface Addressing

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

public ConfiguredDictionaryOutput getConfiguredDictionaries(ConfiguredDictionaryInput request)
                                                     throws AddressingException

Specified by:

getConfiguredDictionaries in interface Addressing

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

public ParsedResponse parse(RequestAddress address,
                            Preferences preferences)
                     throws AddressingException

Description copied from interface: Addressing

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

Specified by:

parse in interface Addressing

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

public ParsedResponseV2 parseV2(RequestAddress address,
                                Preferences preferences)
                         throws AddressingException

Specified by:

parseV2 in interface Addressing

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

public PredictionResponse predict(RequestAddress address,
                                  Preferences preferences)
                           throws AddressingException

Description copied from interface: Addressing

parse address elements

Specified by:

predict in interface Addressing

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

public PredictionResponseV2 predictV2(RequestAddress address,
                                      Preferences preferences)
                               throws AddressingException

Description copied from interface: Addressing

parse address elements

Specified by:

predictV2 in interface Addressing

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

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

Specified by:

lookup in interface Addressing

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

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

Description copied from interface: Addressing

find address for given coordinates

Specified by:

reverse in interface Addressing

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

public Capabilities capabilities()
                          throws AddressingException

Description copied from interface: Addressing

Get supported capabilities of addresser

Specified by:

capabilities in interface Addressing

Returns:

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

Throws:

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

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

features

public List<Feature> features(String name)
                       throws AddressingException

Specified by:

features in interface Addresser

Throws:

AddressingException