com.mapbox.api.geocoding.v6.models

Class V6MatchCode

java.lang.Object

com.mapbox.api.geocoding.v6.models.V6JsonObject

com.mapbox.api.geocoding.v6.models.V6MatchCode

All Implemented Interfaces:

java.io.Serializable

public abstract class V6MatchCode
extends V6JsonObject

The V6MatchCode object in the Geocoding API helps you understand how the resulting address feature aligns with the query submitted. Available only for address-type features, the V6MatchCode provides a breakdown of how each element of the result matches with the query, plus an overall Confidence score, based on how well it matches. This can help you make decisions about what results to keep or throw out based on your application's tolerance for fuzzy matching on the query.

Smart Address Match is available for all forward geocoding requests that return an address type feature. It works best when using Structured Input forward queries, as the request components must be typed explicitly.

See Also:

Smart Address Match, Serialized Form

Constructor Summary

Constructors

Constructor and Description
V6MatchCode()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	addressNumber() Match code for address number.
abstract java.lang.String	confidence() Confidence score, which indicates how well the result matches the input query.
abstract java.lang.String	country() Match code for country.
static V6MatchCode	fromJson(java.lang.String json) Create a V6MatchCode object from JSON.
abstract java.lang.String	locality() Match code for locality.
abstract java.lang.String	place() Match code for place.
abstract java.lang.String	postcode() Match code for postcode.
abstract java.lang.String	region() Match code for region.
abstract java.lang.String	street() Match code for street.
static com.google.gson.TypeAdapter<V6MatchCode>	typeAdapter(com.google.gson.Gson gson) Gson type adapter for parsing Gson to this class.

Methods inherited from class com.mapbox.api.geocoding.v6.models.V6JsonObject

getUnrecognizedJsonProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

V6MatchCode

public V6MatchCode()

Method Detail

addressNumber

@Nullable
 @SerializedName(value="address_number")
public abstract java.lang.String addressNumber()

Match code for address number.

Returns:

match code for address number

street

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

Match code for street.

Returns:

match code for street

locality

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

Match code for locality.

Returns:

match code for locality

place

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

Match code for place.

Returns:

match code for place

postcode

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

Match code for postcode.

Returns:

match code for postcode

region

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

Match code for region.

Returns:

match code for region

country

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

Match code for country.

Returns:

match code for country

confidence

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

Confidence score, which indicates how well the result matches the input query.

Returns:

confidence score

fromJson

public static V6MatchCode fromJson(@NonNull
                                   java.lang.String json)

Create a V6MatchCode object from JSON.

Parameters:

json - string of JSON making up a carmen context

Returns:

this class using the defined information in the provided JSON string

typeAdapter

public static com.google.gson.TypeAdapter<V6MatchCode> 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