public class AndroidGeocoder extends Object
Constructor and Description |
---|
AndroidGeocoder(Context context)
Constructs a Geocoder whose responses will be localized for the
default system Locale.
|
AndroidGeocoder(Context context,
Locale locale)
Constructs a Geocoder whose responses will be localized for the
given Locale.
|
Modifier and Type | Method and Description |
---|---|
List<Address> |
getFromLocation(double latitude,
double longitude,
int maxResults)
Returns an array of Addresses that are known to describe the
area immediately surrounding the given latitude and longitude.
|
List<Address> |
getFromLocationName(String locationName,
int maxResults)
Returns an array of Addresses that are known to describe the
named location, which may be a place name such as "Dalvik,
Iceland", an address such as "1600 Amphitheatre Parkway,
Mountain View, CA", an airport code such as "SFO", etc..
|
List<Address> |
getFromLocationName(String locationName,
int maxResults,
double lowerLeftLatitude,
double lowerLeftLongitude,
double upperRightLatitude,
double upperRightLongitude)
Returns an array of Addresses that are known to describe the named location, which may be a
place name such as "Dalvik, Iceland", an address such as "1600 Amphitheatre Parkway, Mountain
View, CA", an airport code such as "SFO", etc..
|
static boolean |
isPresent()
Returns true if the Geocoder methods getFromLocation and
getFromLocationName are implemented.
|
void |
setAccessToken(String accessToken)
You'll need to have a Mapbox access token to use the geocoding API within MAS.
|
public AndroidGeocoder(Context context, Locale locale)
context
- the Context of the calling Activitylocale
- the desired Locale for the query resultsNullPointerException
- if Locale is nullpublic AndroidGeocoder(Context context)
context
- the Context of the calling Activitypublic static boolean isPresent()
getFromLocation(double, double, int)
and
getFromLocationName(String, int)
are implemented.public List<Address> getFromLocation(double latitude, double longitude, int maxResults) throws IOException, com.mapbox.services.api.ServicesException
Returns an array of Addresses that are known to describe the area immediately surrounding the given latitude and longitude. The returned addresses will be localized for the locale provided to this class's constructor.
The returned values may be obtained by means of a network lookup. The results are a best guess and are not guaranteed to be meaningful or correct. It may be useful to call this method from a thread separate from your primary UI thread.
latitude
- the latitude a point for the searchlongitude
- the longitude a point for the searchmaxResults
- max number of addresses to return. Smaller numbers (1 to 5) are recommendedIllegalArgumentException
- if latitude is
less than -90 or greater than 90IllegalArgumentException
- if longitude is
less than -180 or greater than 180IOException
- if the network is unavailable or any other
I/O problem occurscom.mapbox.services.api.ServicesException
- Generic Exception for all things Mapbox.public List<Address> getFromLocationName(String locationName, int maxResults) throws IOException, com.mapbox.services.api.ServicesException
Returns an array of Addresses that are known to describe the named location, which may be a place name such as "Dalvik, Iceland", an address such as "1600 Amphitheatre Parkway, Mountain View, CA", an airport code such as "SFO", etc.. The returned addresses will be localized for the locale provided to this class's constructor.
The query will block and returned values will be obtained by means of a network lookup. The results are a best guess and are not guaranteed to be meaningful or correct. It may be useful to call this method from a thread separate from your primary UI thread.
locationName
- a user-supplied description of a locationmaxResults
- max number of results to return. Smaller numbers (1 to 5) are recommendedIllegalArgumentException
- if locationName is nullIOException
- if the network is unavailable or any other
I/O problem occurscom.mapbox.services.api.ServicesException
- Generic Exception for all things Mapbox.public List<Address> getFromLocationName(String locationName, int maxResults, double lowerLeftLatitude, double lowerLeftLongitude, double upperRightLatitude, double upperRightLongitude) throws IOException, com.mapbox.services.api.ServicesException
Returns an array of Addresses that are known to describe the named location, which may be a place name such as "Dalvik, Iceland", an address such as "1600 Amphitheatre Parkway, Mountain View, CA", an airport code such as "SFO", etc.. The returned addresses will be localized for the locale provided to this class's constructor.
You may specify a bounding box for the search results by including the Latitude and Longitude of the Lower Left point and Upper Right point of the box.
The query will block and returned values will be obtained by means of a network lookup. The results are a best guess and are not guaranteed to be meaningful or correct. It may be useful to call this method from a thread separate from your primary UI thread.
locationName
- a user-supplied description of a locationmaxResults
- max number of addresses to return. Smaller numbers (1 to 5) are recommendedlowerLeftLatitude
- the latitude of the lower left corner of the bounding boxlowerLeftLongitude
- the longitude of the lower left corner of the bounding boxupperRightLatitude
- the latitude of the upper right corner of the bounding boxupperRightLongitude
- the longitude of the upper right corner of the bounding boxIllegalArgumentException
- if locationName is null, if any longitude is less than -180
or greater than 180, if any latitude is less than -90 or
greater than 90IOException
- if the network is unavailable or any other
I/O problem occurscom.mapbox.services.api.ServicesException
- Generic Exception for all things Mapbox.public void setAccessToken(String accessToken)
accessToken
- Your Mapbox access token© 2015–2016 Mapbox. All rights reserved.