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

Class CarmenFeatureCollection

java.lang.Object

com.mapbox.services.commons.geojson.BaseFeatureCollection

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

All Implemented Interfaces:

com.mapbox.services.commons.geojson.GeoJSON

Direct Known Subclasses:

GeocodingResponse

public class CarmenFeatureCollection
extends com.mapbox.services.commons.geojson.BaseFeatureCollection

The Geocoding API hierarchy starts with this class.

Since:

1.0.0

Constructor Summary

Constructors

Modifier	Constructor and Description
	CarmenFeatureCollection()
protected	CarmenFeatureCollection(java.util.List<CarmenFeature> features) Protected constructor.

Method Summary

Modifier and Type	Method and Description
static CarmenFeatureCollection	fromFeatures(java.util.List<CarmenFeature> features) Create a FeatureCollection from a List of features.
java.lang.String	getAttribution() Mapbox attribution.
java.util.List<CarmenFeature>	getFeatures() Get the List containing all the features within collection.
java.util.List<java.lang.String>	getQuery() A place name for forward geocoding or a coordinate pair (longitude, latitude location) for reverse geocoding.
void	setAttribution(java.lang.String attribution)
void	setQuery(java.util.List<java.lang.String> query) A place name for forward geocoding or a coordinate pair (longitude, latitude location) for reverse geocoding.

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

fromJson, getType, toJson

Methods inherited from class java.lang.Object

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

Constructor Detail

CarmenFeatureCollection

public CarmenFeatureCollection()

CarmenFeatureCollection

protected CarmenFeatureCollection(java.util.List<CarmenFeature> features)

Protected constructor. Unlike other GeoJSON objects, this constructor is protected to enable the deserialization of the Geocoding service responses.

Parameters:

features - List of Feature.

Since:

1.0.0

Method Detail

getQuery

public java.util.List<java.lang.String> getQuery()

A place name for forward geocoding or a coordinate pair (longitude, latitude location) for reverse geocoding.

Returns:

a List containing your search query.

Since:

1.0.0

setQuery

public void setQuery(java.util.List<java.lang.String> query)

A place name for forward geocoding or a coordinate pair (longitude, latitude location) for reverse geocoding.

Parameters:

query - The search terms used.

Since:

1.0.0

getAttribution

public java.lang.String getAttribution()

Mapbox attribution.

Returns:

String with Mapbox attribution.

Since:

1.0.0

setAttribution

public void setAttribution(java.lang.String attribution)

Parameters:

attribution - String with Mapbox attribution.

Since:

1.0.0

getFeatures

public java.util.List<CarmenFeature> getFeatures()

Get the List containing all the features within collection.

Returns:

List of features within collection.

Since:

1.0.0

fromFeatures

public static CarmenFeatureCollection fromFeatures(java.util.List<CarmenFeature> features)

Create a FeatureCollection from a List of features.

Parameters:

features - List of Feature

Returns:

new FeatureCollection

Since:

1.0.0