com.mapbox.api.matrix.v1

Class MapboxMatrix

java.lang.Object

com.mapbox.core.MapboxService<MatrixResponse,MatrixService>

com.mapbox.api.matrix.v1.MapboxMatrix

public abstract class MapboxMatrix
extends com.mapbox.core.MapboxService<MatrixResponse,MatrixService>

the Matrix API returns all travel times between many points. The Matrix API will always return the duration on the fastest route. Durations between points may not be symmetric (for example A to B may have a different duration than B to A), as the routes may differ by direction due to one-way streets or turn restrictions. The Matrix API returns durations in seconds. It does not return route geometries or distances.

This API allows you to build tools that efficiently check the reachability of coordinates from each other, filter points by travel time, or run your own algorithms for solving optimization problems.

The standard limit for request are a maximum 60 requests per minute and maximum 25 input coordinates. For example you can request a symmetric 25x25 matrix, an asymmetric 1x24 matrix with distinct coordinates or a 12x24 where sources and destinations share some coordinates. For higher volumes contact us.

Since:

2.1.0

See Also:

API documentation

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class com.mapbox.core.MapboxService

MAX_URL_SIZE, okHttpClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapboxMatrix()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	baseUrl()
static MapboxMatrix.Builder	builder() Build a new MapboxMatrix object with the initial values set for baseUrl(), profile(), and user().
protected com.google.gson.GsonBuilder	getGsonBuilder()
protected retrofit2.Call<MatrixResponse>	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

MapboxMatrix

protected MapboxMatrix()

Method Detail

getGsonBuilder

protected com.google.gson.GsonBuilder getGsonBuilder()

Overrides:

getGsonBuilder in class com.mapbox.core.MapboxService<MatrixResponse,MatrixService>

initializeCall

protected retrofit2.Call<MatrixResponse> initializeCall()

Specified by:

initializeCall in class com.mapbox.core.MapboxService<MatrixResponse,MatrixService>

baseUrl

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

Specified by:

baseUrl in class com.mapbox.core.MapboxService<MatrixResponse,MatrixService>

builder

public static MapboxMatrix.Builder builder()

Build a new MapboxMatrix object with the initial values set for baseUrl(), profile(), and user().

Returns:

a MapboxMatrix.Builder object for creating this object

Since:

3.0.0