Optimization
This guide provides an overview how to get optimized routes between multiple points using the Mapbox Java SDK.
The Mapbox Optimization API returns a duration-optimized route between the input coordinates. This is also known as solving the Traveling Salesperson Problem. A typical use case for this API is planning the route for deliveries in a city. An optimized route can be retrieved for car driving, bicycling, walking, or hiking.
For more information about this API, including its pricing structure, see the Mapbox Optimization API documentation.
The wrapper for the Mapbox Optimization API is included in the mapbox-sdk-services module. Before using this wrapper, make sure that you have included the correct permissions inside your AndroidManifest.xml file if you plan to use this API inside of an Android application. The MapboxOptimization class is used to return a duration-optimized route between the input coordinates.
Import packages
import com.mapbox.api.optimization.v1.MapboxOptimization
import com.mapbox.api.directions.v5.DirectionsCriteria
import com.mapbox.api.optimization.v1.models.OptimizationResponse
Optimization request
Before making the Optimization API request, you must build the MapboxOptimization object passing in three required parameters:
- A valid Mapbox access token.
- A
<List>ofPointobjects. These are the waypoints in the optimized route. The minimum amount ofPointobjects in the list is 2, and the maximum is 12. - A directions profile. The API needs to know whether you want a route which is optimized for driving, cycling, or walking.
Here's an example MapboxOptimization object:
private List<Point> coordinates;
...
MapboxOptimization optimizedClient = MapboxOptimization.builder()
.coordinates(coordinates)
.profile(DirectionsCriteria.PROFILE_DRIVING)
.accessToken(MAPBOX_ACCESS_TOKEN)
.build();
private val coordinates: List<Point>? = null
...
val optimizedClient = MapboxOptimization.builder()
.coordinates(coordinates)
.profile(DirectionsCriteria.PROFILE_DRIVING)
.accessToken(MAPBOX_ACCESS_TOKEN)
.build()
You can read about optional parameters in the Optimization API documentation.
Optimization response
Once you have built your MapboxOptimization object with all the parameters that you'd like to use in the request, you'll need to send the request using enqueueCall() asynchronously. Once the request receives a response, it will tell the callback where you can handle the response appropriately.
optimizedClient.enqueueCall(new Callback<OptimizationResponse>() {
@Override
public void onResponse(Call<OptimizationResponse> call, Response<OptimizationResponse> response) {
if (!response.isSuccessful()) {
Log.d(TAG, "optimization call not successful");
return;
} else {
if (response.body().trips().isEmpty()) {
Log.d(TAG, "optimization call successful but no routes");
return;
}
}
DirectionsRoute optimizedRoute = response.body().trips().get(0);
}
@Override
public void onFailure(Call<OptimizationResponse> call, Throwable throwable) {
Log.d(TAG, "Error: " + throwable.getMessage());
}
});
optimizedClient?.enqueueCall(object : Callback<OptimizationResponse> {
override fun onResponse(call: Call<OptimizationResponse>, response: Response<OptimizationResponse>) {
if (!response.isSuccessful) {
Log.d(TAG, "optimization call not successful")
return
} else {
if (response.body()!!.trips()!!.isEmpty()) {
Log.d(TAG, "optimization call successful but no routes")
return
}
}
val optimizedRoute = response.body()!!.trips()!![0]
}
override fun onFailure(call: Call<OptimizationResponse>, throwable: Throwable) {
Log.d(TAG, "Error: " + throwable.message)
}
})
In case your user leaves the activity or application before the callback's notified, you should use cancelCall() within your onDestroy() lifecycle method:
@Override
protected void onDestroy() {
super.onDestroy();
if (optimizedClient != null) {
optimizedClient.cancelCall();
}
mapView.onDestroy();
}
@Override
protected void onDestroy() {
super.onDestroy();
optimizedClient?.cancelCall()
mapView?.onDestroy()
}