atg.commerce.locations

Interface GeoLocatorProvider

public interface GeoLocatorProvider

This interface can be used to implement a geolocation provider capable of taking in an address or postal code and determining a resulting coordinate of that location.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
Coordinate	getGeoLocation(java.lang.String pPostalOrAddress, java.util.Locale pLocale) Find a geolocation based on either a free form address input or a postal code.
Coordinate	getGeoLocation(java.lang.String pCity, java.lang.String pArea, java.util.Locale pLocale) Find a geolocation based on a city and a state or province.
boolean	isAllowCityAndState() Whether or not this provider only supports postal code or free form address geo-location.
boolean	isAllowFreeFormEntry() Whether or not this provider uses an entry method that can take in an address of arbitrary format (e.g '02139', 'Cambridge Ma', or '1 Main Street Cambridge Ma') If this flag is false then getGeoLocation(String, Locale) is expected to be provided with only a postal code input.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

isAllowFreeFormEntry

boolean isAllowFreeFormEntry()

Whether or not this provider uses an entry method that can take in an address of arbitrary format (e.g '02139', 'Cambridge Ma', or '1 Main Street Cambridge Ma') If this flag is false then getGeoLocation(String, Locale) is expected to be provided with only a postal code input.

Returns:

Whether or not this type of entry is allowed.

isAllowCityAndState

boolean isAllowCityAndState()

Whether or not this provider only supports postal code or free form address geo-location. If false then providing city and state/province is not a valid method of geolocation.

Returns:

True if this provider supports a city and state input method

getGeoLocation

Coordinate getGeoLocation(java.lang.String pPostalOrAddress,
                          java.util.Locale pLocale)

Find a geolocation based on either a free form address input or a postal code. A free form address input may consist of a postal code, address, city, or other identifying information.

Parameters:

pPostalOrAddress - An address String if isFreeFormEntry is true, otherwise a postal/zip code.

pLocale - The locale of the input. Can be used to determine country and language of input.

Returns:

A coordinate representing the provided address or postal code.

getGeoLocation

Coordinate getGeoLocation(java.lang.String pCity,
                          java.lang.String pArea,
                          java.util.Locale pLocale)

Find a geolocation based on a city and a state or province.

Parameters:

pCity - The city to find a coordinate for.

pArea - An input for the general area where the city is located. Typically a state, county, or province.

pLocale - The locale of the input. Can be used to determine country and language of input.

Returns:

A coordinate representing the provided address or postal code.