com.nbmap.api.matching.v5

Class NbmapMapMatching

java.lang.Object

com.nbmap.core.NbmapService<MapMatchingResponse,MapMatchingService>

com.nbmap.api.matching.v5.NbmapMapMatching

public abstract class NbmapMapMatching
extends com.nbmap.core.NbmapService<MapMatchingResponse,MapMatchingService>

The Nbmap map matching interface (v5)

The Nbmap Map Matching API snaps fuzzy, inaccurate traces from a GPS unit or a phone to the OpenStreetMap road and path network using the Directions API. This produces clean paths that can be displayed on a map or used for other analysis.

Since:

2.0.0

See Also:

Map matching API documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NbmapMapMatching.Builder Builds your map matching query by adding parameters.

Field Summary

Fields inherited from class com.nbmap.core.NbmapService

MAX_URL_SIZE, okHttpClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NbmapMapMatching()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	baseUrl()
static NbmapMapMatching.Builder	builder() Build a new NbmapMapMatching object with the initial values set for baseUrl(), profile(), geometries(), and user().
void	enqueueCall(retrofit2.Callback<MapMatchingResponse> callback) Wrapper method for Retrofits Call.enqueue(Callback) call returning a response specific to the Map Matching API.
retrofit2.Response<MapMatchingResponse>	executeCall() Wrapper method for Retrofits Call.execute() call returning a response specific to the Map Matching API.
protected com.google.gson.GsonBuilder	getGsonBuilder()
protected retrofit2.Call<MapMatchingResponse>	initializeCall()

Methods inherited from class com.nbmap.core.NbmapService

cancelCall, cloneCall, enableDebug, 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

NbmapMapMatching

protected NbmapMapMatching()

Method Detail

getGsonBuilder

protected com.google.gson.GsonBuilder getGsonBuilder()

Overrides:

getGsonBuilder in class com.nbmap.core.NbmapService<MapMatchingResponse,MapMatchingService>

initializeCall

protected retrofit2.Call<MapMatchingResponse> initializeCall()

Specified by:

initializeCall in class com.nbmap.core.NbmapService<MapMatchingResponse,MapMatchingService>

executeCall

public retrofit2.Response<MapMatchingResponse> executeCall()
                                                    throws java.io.IOException

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

Overrides:

executeCall in class com.nbmap.core.NbmapService<MapMatchingResponse,MapMatchingService>

Returns:

the Map Matching v5 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

enqueueCall

public void enqueueCall(retrofit2.Callback<MapMatchingResponse> callback)

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

Overrides:

enqueueCall in class com.nbmap.core.NbmapService<MapMatchingResponse,MapMatchingService>

Parameters:

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

Since:

1.0.0

baseUrl

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

Specified by:

baseUrl in class com.nbmap.core.NbmapService<MapMatchingResponse,MapMatchingService>

builder

public static NbmapMapMatching.Builder builder()

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

Returns:

a NbmapMapMatching.Builder object for creating this object

Since:

3.0.0