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

Class CarmenFeature

java.lang.Object

com.mapbox.services.commons.geojson.Feature

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

All Implemented Interfaces:

com.mapbox.services.commons.geojson.GeoJSON

public class CarmenFeature
extends com.mapbox.services.commons.geojson.Feature

The Features key in the geocoding API response contains the majority of information you'll want to use.

Since:

1.0.0

See Also:

Carmen Geojson information, Mapbox geocoder documentation, Official GeoJSON Feature Specifications

Constructor Summary

Constructors

Constructor and Description
CarmenFeature()

Method Summary

Modifier and Type	Method and Description
com.mapbox.services.commons.models.Position	asPosition() Util to transform center into a Position object
static CarmenFeature	fromJson(java.lang.String json) Create a CarmenFeature object from JSON.
java.lang.String	getAddress()
double[]	getBbox()
double[]	getCenter()
java.util.List<CarmenContext>	getContext()
java.lang.String	getPlaceName()
double	getRelevance() You can use the relevance property to remove rough results if you require a response that matches your whole query.
java.lang.String	getText()
void	setAddress(java.lang.String address)
void	setBbox(double[] bbox)
void	setCenter(double[] center)
void	setContext(java.util.List<CarmenContext> context)
void	setPlaceName(java.lang.String placeName)
void	setRelevance(double relevance)
void	setText(java.lang.String text)
java.lang.String	toString() Human-readable text representing the full result hierarchy (e.g.

Methods inherited from class com.mapbox.services.commons.geojson.Feature

addBooleanProperty, addCharacterProperty, addNumberProperty, addProperty, addStringProperty, fromGeometry, fromGeometry, fromGeometry, getBooleanProperty, getCharacterProperty, getGeometry, getId, getNumberProperty, getProperties, getProperty, getStringProperty, getType, hasNonNullValueForProperty, hasProperty, removeProperty, setGeometry, setId, setProperties, toJson

Methods inherited from class java.lang.Object

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

Constructor Detail

CarmenFeature

public CarmenFeature()

Method Detail

getText

public java.lang.String getText()

Returns:

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

Since:

1.0.0

getPlaceName

public java.lang.String getPlaceName()

Returns:

Human-readable text representing the full result hierarchy (e.g. "Austin, Texas, United States").

Since:

1.0.0

getBbox

public double[] getBbox()

Returns:

Array bounding box of the form [minx, miny, maxx, maxy].

Since:

1.0.0

getAddress

public java.lang.String getAddress()

Returns:

Where applicable. While the string content isn't guaranteed, in many cases, this will be the house number. If the response doesn't contain an address this will be null.

Since:

1.0.0

getCenter

public double[] getCenter()

Returns:

Array of the form [lon, lat].

Since:

1.0.0

getContext

public java.util.List<CarmenContext> getContext()

Returns:

Array representing a hierarchy of parents. Each parent includes id, text keys.

Since:

1.0.0

getRelevance

public double getRelevance()

You can use the relevance property to remove rough results if you require a response that matches your whole query.

Returns:

double value between 0 and 1.

Since:

1.0.0

setText

public void setText(java.lang.String text)

setPlaceName

public void setPlaceName(java.lang.String placeName)

setBbox

public void setBbox(double[] bbox)

setAddress

public void setAddress(java.lang.String address)

setCenter

public void setCenter(double[] center)

setContext

public void setContext(java.util.List<CarmenContext> context)

setRelevance

public void setRelevance(double relevance)

fromJson

public static CarmenFeature fromJson(java.lang.String json)

Create a CarmenFeature object from JSON.

Parameters:

json - String of JSON making up a carmen feature.

Returns:

Carmen Feature

Since:

2.0.0

asPosition

public com.mapbox.services.commons.models.Position asPosition()

Util to transform center into a Position object

Returns:

a Position representing the center.

Since:

1.0.0

toString

public java.lang.String toString()

Human-readable text representing the full result hierarchy (e.g. "Austin, Texas, United States").

Overrides:

toString in class java.lang.Object

Returns:

String with human-readable text.

Since:

1.0.0