com.mapbox.api.geocoding.v5

Class MapboxGeocoding

java.lang.Object

com.mapbox.core.MapboxService<GeocodingResponse,GeocodingService>

com.mapbox.api.geocoding.v5.MapboxGeocoding

public abstract class MapboxGeocoding
extends com.mapbox.core.MapboxService<GeocodingResponse,GeocodingService>

This class gives you access to both Mapbox forward and reverse geocoding.

Forward geocoding lets you convert location text into geographic coordinates, turning 2 Lincoln Memorial Circle NW into a Point with the coordinates -77.050, 38.889.

Reverse geocoding turns geographic coordinates into place names, turning -77.050, 38.889 into 2 Lincoln Memorial Circle NW. These place names can vary from specific addresses to states and countries that contain the given coordinates.

Batch Geocoding This feature is limited to enterprise customers only and the mode() must be set to GeocodingCriteria.MODE_PLACES_PERMANENT.

Batch requests have the same parameters as normal requests, but can include more than one query by using MapboxGeocoding.Builder.query(String) and separating queries with the ; character.

With the GeocodingCriteria.MODE_PLACES_PERMANENT mode, you can make up to 50 forward or reverse geocoding queries in a single request. The response is a list of individual GeocodingResponses. Each query in a batch request counts individually against your account's rate limits.

Since:

1.0.0

See Also:

Android Geocoding documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapboxGeocoding.Builder This builder is used to create a new request to the Mapbox Geocoding API.

Field Summary

Fields inherited from class com.mapbox.core.MapboxService

okHttpClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapboxGeocoding()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	baseUrl()
static MapboxGeocoding.Builder	builder() Build a new MapboxGeocoding object with the initial values set for baseUrl() and mode().
void	cancelBatchCall() Wrapper method for Retrofits Call.cancel() call, important to manually cancel call if the user dismisses the calling activity or no longer needs the returned results.
retrofit2.Call<java.util.List<GeocodingResponse>>	cloneBatchCall() Wrapper method for Retrofits Call.clone() call, useful for getting call information.
void	enqueueBatchCall(retrofit2.Callback<java.util.List<GeocodingResponse>> callback) Wrapper method for Retrofits Call.enqueue(Callback) call returning a batch response specific to the Geocoding batch API.
retrofit2.Response<java.util.List<GeocodingResponse>>	executeBatchCall() Wrapper method for Retrofits Call.execute() call returning a batch response specific to the Geocoding API.
protected com.google.gson.GsonBuilder	getGsonBuilder()
protected retrofit2.Call<GeocodingResponse>	initializeCall()

Methods inherited from class com.mapbox.core.MapboxService

cancelCall, cloneCall, enableDebug, enqueueCall, executeCall, getCall, getCallFactory, getOkHttpClient, getRetrofit, getService, isEnableDebug, setCallFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

MapboxGeocoding

protected MapboxGeocoding()

Method Detail

getGsonBuilder

protected com.google.gson.GsonBuilder getGsonBuilder()

Overrides:

getGsonBuilder in class com.mapbox.core.MapboxService<GeocodingResponse,GeocodingService>

initializeCall

protected retrofit2.Call<GeocodingResponse> initializeCall()

Specified by:

initializeCall in class com.mapbox.core.MapboxService<GeocodingResponse,GeocodingService>

executeBatchCall

public retrofit2.Response<java.util.List<GeocodingResponse>> executeBatchCall()
                                                                       throws java.io.IOException

Wrapper method for Retrofits Call.execute() call returning a batch response specific to the Geocoding API.

Returns:

the Geocoding v5 batch response once the call completes successfully

Throws:

java.io.IOException - Signals that an I/O exception of some sort has occurred.

Since:

1.0.0

enqueueBatchCall

public void enqueueBatchCall(retrofit2.Callback<java.util.List<GeocodingResponse>> callback)

Wrapper method for Retrofits Call.enqueue(Callback) call returning a batch response specific to the Geocoding batch API. Use this method to make a geocoding request on the Main Thread.

Parameters:

callback - a Callback which is used once the GeocodingResponse is created.

Since:

1.0.0

cancelBatchCall

public void cancelBatchCall()

Wrapper method for Retrofits Call.cancel() call, important to manually cancel call if the user dismisses the calling activity or no longer needs the returned results.

Since:

1.0.0

cloneBatchCall

public retrofit2.Call<java.util.List<GeocodingResponse>> cloneBatchCall()

Wrapper method for Retrofits Call.clone() call, useful for getting call information.

Returns:

cloned call

Since:

1.0.0

baseUrl

@NonNull
protected abstract java.lang.String baseUrl()

Specified by:

baseUrl in class com.mapbox.core.MapboxService<GeocodingResponse,GeocodingService>

builder

public static MapboxGeocoding.Builder builder()

Build a new MapboxGeocoding object with the initial values set for baseUrl() and mode().

Returns:

a MapboxGeocoding.Builder object for creating this object

Since:

3.0.0