public interface GeoLocatorProvider
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
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.
|
static final java.lang.String CLASS_VERSION
boolean isAllowFreeFormEntry()
boolean isAllowCityAndState()
Coordinate getGeoLocation(java.lang.String pPostalOrAddress, java.util.Locale pLocale)
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.Coordinate getGeoLocation(java.lang.String pCity, java.lang.String pArea, java.util.Locale pLocale)
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.