com.nbmap.api.matching.v5.models

Class MapMatchingMatching

java.lang.Object

com.nbmap.api.matching.v5.models.MapMatchingMatching

All Implemented Interfaces:

java.io.Serializable

public abstract class MapMatchingMatching
extends java.lang.Object
implements java.io.Serializable

A match object is a DirectionsRoute object with an additional confidence field.

Since:

2.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapMatchingMatching.Builder This builder can be used to set the values describing the MapMatchingResponse.

Constructor Summary

Constructors

Constructor and Description
MapMatchingMatching()

Method Summary

Modifier and Type	Method and Description
static MapMatchingMatching.Builder	builder() Create a new instance of this class by using the MapMatchingMatching.Builder class.
abstract double	confidence() A number between 0 (low) and 1 (high) indicating level of confidence in the returned match.
abstract double	distance() The distance traveled from origin to destination.
abstract double	duration() The estimated travel time from origin to destination.
abstract java.lang.String	geometry() Gives the geometry of the route.
abstract java.util.List<com.nbmap.api.directions.v5.models.RouteLeg>	legs() A Leg is a route between only two waypoints.
abstract com.nbmap.api.directions.v5.models.RouteOptions	routeOptions() Holds onto the parameter information used when making the directions request.
abstract MapMatchingMatching.Builder	toBuilder() Convert the current MapMatchingMatching to its builder holding the currently assigned values.
com.nbmap.api.directions.v5.models.DirectionsRoute	toDirectionRoute() Map this MapMatchingMatching object to a DirectionsRoute object.
static com.google.gson.TypeAdapter<MapMatchingMatching>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.
abstract java.lang.String	voiceLanguage() String of the language to be used for voice instructions.
abstract double	weight() The calculated weight of the route.
abstract java.lang.String	weightName() The name of the weight profile used while calculating during extraction phase.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapMatchingMatching

public MapMatchingMatching()

Method Detail

builder

public static MapMatchingMatching.Builder builder()

Create a new instance of this class by using the MapMatchingMatching.Builder class.

Returns:

this classes MapMatchingMatching.Builder for creating a new instance

Since:

3.0.0

distance

public abstract double distance()

The distance traveled from origin to destination.

Returns:

a double number with unit meters

Since:

1.0.0

duration

public abstract double duration()

The estimated travel time from origin to destination.

Returns:

a double number with unit seconds

Since:

1.0.0

geometry

@Nullable
public abstract java.lang.String geometry()

Gives the geometry of the route. Commonly used to draw the route on the map view.

Returns:

an encoded polyline string

Since:

1.0.0

weight

public abstract double weight()

The calculated weight of the route.

Returns:

the weight value provided from the API as a double value

Since:

2.1.0

weightName

@SerializedName(value="weight_name")
public abstract java.lang.String weightName()

The name of the weight profile used while calculating during extraction phase. The default is routability which is duration based, with additional penalties for less desirable maneuvers.

Returns:

a String representing the weight profile used while calculating the route

Since:

2.1.0

legs

public abstract java.util.List<com.nbmap.api.directions.v5.models.RouteLeg> legs()

A Leg is a route between only two waypoints.

Returns:

list of RouteLeg objects

Since:

1.0.0

confidence

public abstract double confidence()

A number between 0 (low) and 1 (high) indicating level of confidence in the returned match.

Returns:

confidence value

Since:

2.0.0

routeOptions

@Nullable
public abstract com.nbmap.api.directions.v5.models.RouteOptions routeOptions()

Holds onto the parameter information used when making the directions request. Useful for re-requesting a directions route using the same information previously used.

Returns:

a RouteOptionss object which holds onto critical information from the request that cannot be derived directly from the directions route

Since:

3.0.0

voiceLanguage

@Nullable
 @SerializedName(value="voiceLocale")
public abstract java.lang.String voiceLanguage()

String of the language to be used for voice instructions. Defaults to en, and can be any accepted instruction language. Will be null when the language provided via NbmapMapMatching.language() is not compatible with API Voice.

Returns:

String compatible with voice instructions, null otherwise

Since:

3.4.0

toBuilder

public abstract MapMatchingMatching.Builder toBuilder()

Convert the current MapMatchingMatching to its builder holding the currently assigned values. This allows you to modify a single variable and then rebuild the object resulting in an updated and modified MapMatchingMatching.

Returns:

a MapMatchingMatching.Builder with the same values set to match the ones defined in this MapMatchingMatching

Since:

3.0.0

toDirectionRoute

public com.nbmap.api.directions.v5.models.DirectionsRoute toDirectionRoute()

Map this MapMatchingMatching object to a DirectionsRoute object.

Returns:

a DirectionsRoute object

typeAdapter

public static com.google.gson.TypeAdapter<MapMatchingMatching> typeAdapter(com.google.gson.Gson gson)

Gson type adapter for parsing Gson to this class.

Parameters:

gson - the built Gson object

Returns:

the type adapter for this class

Since:

3.0.0