com.mapbox.services.api.geocoding.v5.models

Class CarmenContext

java.lang.Object

com.mapbox.services.api.geocoding.v5.models.CarmenContext

public class CarmenContext
extends java.lang.Object

Array representing a hierarchy of parents. Each parent includes id, text keys along with (if avaliable) a wikidata, short_code, and Maki key.

Since:

1.0.0

See Also:

Carmen Geojson information, Mapbox geocoder documentation

Constructor Summary

Constructors

Constructor and Description
CarmenContext()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCategory()
java.lang.String	getId() ID of the feature of the form {index}.{id} where index is the id/handle of the datasource that contributed the result.
java.lang.String	getMaki() Suggested icon mapping from the most current version of the Maki project for a poi feature, based on its category
java.lang.String	getShortCode()
java.lang.String	getText()
java.lang.String	getWikidata()

Methods inherited from class java.lang.Object

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

Constructor Detail

CarmenContext

public CarmenContext()

Method Detail

getId

public java.lang.String getId()

ID of the feature of the form {index}.{id} where index is the id/handle of the datasource that contributed the result.

Returns:

String containing the ID.

Since:

1.0.0

getText

public java.lang.String getText()

Returns:

Text representing the feature (e.g. "Austin").

Since:

1.0.0

getShortCode

public java.lang.String getShortCode()

Returns:

String containing ISO 3166-1 country and ISO 3166-2 region codes

Since:

1.0.0

getWikidata

public java.lang.String getWikidata()

Returns:

The Wikidata identifier for a country, region or place

Since:

1.2.0

getCategory

public java.lang.String getCategory()

Returns:

Comma-separated list of categories applicable to a poi

Since:

1.0.0

getMaki

public java.lang.String getMaki()

Suggested icon mapping from the most current version of the Maki project for a poi feature, based on its category

Returns:

String containing recommendation

Since:

1.2.0