com.mapbox.services.api.mapmatching.v5.models

Class MapMatchingResponse

java.lang.Object

com.mapbox.services.api.mapmatching.v5.models.MapMatchingResponse

public class MapMatchingResponse
extends java.lang.Object

Mapbox map matching API response and convenience getter methods for optional properties

Since:

2.0.0

See Also:

Map Matching API Documentation

Constructor Summary

Constructors

Constructor and Description
MapMatchingResponse()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() A string depicting the state of the response.
java.util.List<MapMatchingMatching>	getMatchings() An array of Match objects
java.util.List<MapMatchingTracepoint>	getTracepoints() An array of Tracepoint objects representing the location an input point was matched with.
void	setCode(java.lang.String code)
void	setMatchings(java.util.List<MapMatchingMatching> matchings) Set the matchings value
void	setTracepoints(java.util.List<MapMatchingTracepoint> tracepoints) Set the tracepoints value

Methods inherited from class java.lang.Object

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

Constructor Detail

MapMatchingResponse

public MapMatchingResponse()

Method Detail

getCode

public java.lang.String getCode()

A string depicting the state of the response.

• "Ok" - Normal case
• "NoMatch" - The input did not produce any matches. matchings will be an empty array.
• "TooManyCoordinates" - There are more than 100 points in the request.
• "InvalidInput" - message will hold an explanation of the invalid input.
• "ProfileNotFound" - Profile should be mapbox.driving, mapbox.walking, or mapbox.cycling.

Returns:

String containing the code.

Since:

2.0.0

setCode

public void setCode(java.lang.String code)

Parameters:

code - String containing the code.

Since:

2.0.0

getMatchings

public java.util.List<MapMatchingMatching> getMatchings()

An array of Match objects

Returns:

matchings list

setMatchings

public void setMatchings(java.util.List<MapMatchingMatching> matchings)

Set the matchings value

Parameters:

matchings - list

getTracepoints

public java.util.List<MapMatchingTracepoint> getTracepoints()

An array of Tracepoint objects representing the location an input point was matched with. Array of Waypoint objects representing all input points of the trace in the order they were matched. If a trace point is omitted by map matching because it is an outlier, the entry will be null.

Returns:

tracepoints list

setTracepoints

public void setTracepoints(java.util.List<MapMatchingTracepoint> tracepoints)

Set the tracepoints value

Parameters:

tracepoints - list