com.mapbox.mapboxsdk.style.sources

Class GeoJsonSource

java.lang.Object

com.mapbox.mapboxsdk.style.sources.Source

com.mapbox.mapboxsdk.style.sources.GeoJsonSource

@UiThread
public class GeoJsonSource
extends Source

GeoJson source, allows using FeatureCollections from Json.

See Also:

the style specification

Field Summary

Fields inherited from class com.mapbox.mapboxsdk.style.sources.Source

detached

Constructor Summary

Constructors

Constructor and Description
GeoJsonSource(java.lang.String id) Create an empty GeoJsonSource
GeoJsonSource(java.lang.String id, com.mapbox.geojson.Feature feature) Create a GeoJsonSource from a Feature
GeoJsonSource(java.lang.String id, com.mapbox.geojson.FeatureCollection features) Create a GeoJsonSource from a FeatureCollection.
GeoJsonSource(java.lang.String id, com.mapbox.geojson.FeatureCollection features, GeoJsonOptions options) Create a GeoJsonSource from a FeatureCollection and non-default GeoJsonOptions.
GeoJsonSource(java.lang.String id, com.mapbox.geojson.Feature feature, GeoJsonOptions options) Create a GeoJsonSource from a Feature and non-default GeoJsonOptions
GeoJsonSource(java.lang.String id, GeoJsonOptions options) Create an empty GeoJsonSource with non-default GeoJsonOptions.
GeoJsonSource(java.lang.String id, com.mapbox.geojson.Geometry geometry) Create a GeoJsonSource from a Geometry
GeoJsonSource(java.lang.String id, com.mapbox.geojson.Geometry geometry, GeoJsonOptions options) Create a GeoJsonSource from a Geometry and non-default GeoJsonOptions
GeoJsonSource(java.lang.String id, java.lang.String geoJson) Create a GeoJsonSource from a raw json string
GeoJsonSource(java.lang.String id, java.lang.String geoJson, GeoJsonOptions options) Create a GeoJsonSource from a raw json string and non-default GeoJsonOptions
GeoJsonSource(java.lang.String id, java.net.URI uri) Create a GeoJsonSource from a geo json URI
GeoJsonSource(java.lang.String id, java.net.URI uri, GeoJsonOptions options) Create a GeoJsonSource from a geo json URI and non-default GeoJsonOptions
GeoJsonSource(java.lang.String id, java.net.URL url) Deprecated. use GeoJsonSource(String, URI) instead
GeoJsonSource(java.lang.String id, java.net.URL url, GeoJsonOptions options) Deprecated. use GeoJsonSource(String, URI, GeoJsonOptions) instead

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
com.mapbox.geojson.FeatureCollection	getClusterChildren(com.mapbox.geojson.Feature cluster) Returns the children of a cluster (on the next zoom level) given its id (cluster_id value from feature properties).
int	getClusterExpansionZoom(com.mapbox.geojson.Feature cluster) Returns the zoom on which the cluster expands into several children (useful for "click to zoom" feature) given the cluster's cluster_id (cluster_id value from feature properties).
com.mapbox.geojson.FeatureCollection	getClusterLeaves(com.mapbox.geojson.Feature cluster, long limit, long offset) Returns all the leaves of a cluster (given its cluster_id), with pagination support: limit is the number of leaves to return (set to Infinity for all points), and offset is the amount of points to skip (for pagination).
java.lang.String	getUri() Get the URI of the source.
java.lang.String	getUrl() Deprecated. use getUri() instead
protected void	initialize(java.lang.String layerId, java.lang.Object options)
protected java.lang.String	nativeGetUrl()
protected void	nativeSetUrl(java.lang.String url)
java.util.List<com.mapbox.geojson.Feature>	querySourceFeatures(Expression filter) Queries the source for features.
void	setGeoJson(com.mapbox.geojson.Feature feature) Updates the GeoJson with a single feature.
void	setGeoJson(com.mapbox.geojson.FeatureCollection featureCollection) Updates the GeoJson.
void	setGeoJson(com.mapbox.geojson.Geometry geometry) Updates the GeoJson with a single geometry.
void	setGeoJson(java.lang.String json) Updates the GeoJson.
void	setUri(java.lang.String uri) Updates the URI of the source.
void	setUri(java.net.URI uri) Updates the URI of the source.
void	setUrl(java.lang.String url) Deprecated. use setUri(String) instead
void	setUrl(java.net.URL url) Deprecated. use setUri(URI) instead

Methods inherited from class com.mapbox.mapboxsdk.style.sources.Source

checkThread, getAttribution, getId, getMaxOverscaleFactorForParentTiles, getMinimumTileUpdateInterval, getNativePtr, getPrefetchZoomDelta, isVolatile, nativeGetAttribution, nativeGetId, nativeGetMaxOverscaleFactorForParentTiles, nativeGetMinimumTileUpdateInterval, nativeGetPrefetchZoomDelta, nativeIsVolatile, nativeSetMaxOverscaleFactorForParentTiles, nativeSetMinimumTileUpdateInterval, nativeSetPrefetchZoomDelta, nativeSetVolatile, setDetached, setMaxOverscaleFactorForParentTiles, setMinimumTileUpdateInterval, setPrefetchZoomDelta, setVolatile

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoJsonSource

public GeoJsonSource(java.lang.String id)

Create an empty GeoJsonSource

Parameters:

id - the source id

GeoJsonSource

public GeoJsonSource(java.lang.String id,
                     GeoJsonOptions options)

Create an empty GeoJsonSource with non-default GeoJsonOptions.

Parameters:

id - the source id

options - options

GeoJsonSource

public GeoJsonSource(java.lang.String id,
                     @Nullable
                     java.lang.String geoJson)

Create a GeoJsonSource from a raw json string

Parameters:

id - the source id

geoJson - raw Json FeatureCollection

GeoJsonSource

public GeoJsonSource(java.lang.String id,
                     @Nullable
                     java.lang.String geoJson,
                     GeoJsonOptions options)

Create a GeoJsonSource from a raw json string and non-default GeoJsonOptions

Parameters:

id - the source id

geoJson - raw Json body

options - options

GeoJsonSource

@Deprecated
public GeoJsonSource(java.lang.String id,
                                 java.net.URL url)

Deprecated. use GeoJsonSource(String, URI) instead

Create a GeoJsonSource from a remote geo json file

Parameters:

id - the source id

url - remote json file

GeoJsonSource

@Deprecated
public GeoJsonSource(java.lang.String id,
                                 java.net.URL url,
                                 GeoJsonOptions options)

Deprecated. use GeoJsonSource(String, URI, GeoJsonOptions) instead

Create a GeoJsonSource from a remote geo json file and non-default GeoJsonOptions

Parameters:

id - the source id

url - remote json file

options - options

GeoJsonSource

public GeoJsonSource(java.lang.String id,
                     java.net.URI uri)

Create a GeoJsonSource from a geo json URI

An URI is a combination of a protocol and a resource path. The following URI protocol schemes are supported:

• http://
• load resources using HyperText Transfer Protocol
• file://
• load resources from the Android file system
• asset://
• load resources from the binary packaged assets folder

Parameters:

id - the source id

uri - unique resource identifier

GeoJsonSource

public GeoJsonSource(java.lang.String id,
                     java.net.URI uri,
                     GeoJsonOptions options)

Create a GeoJsonSource from a geo json URI and non-default GeoJsonOptions

An URI is a combination of a protocol and a resource path. The following URI protocol schemes are supported:

• http://
• load resources using HyperText Transfer Protocol
• file://
• load resources from the Android file system
• asset://
• load resources from the binary packaged assets folder

Parameters:

id - the source id

uri - remote json file

options - options

GeoJsonSource

public GeoJsonSource(java.lang.String id,
                     com.mapbox.geojson.FeatureCollection features)

Create a GeoJsonSource from a FeatureCollection.

Parameters:

id - the source id

features - the features

GeoJsonSource

public GeoJsonSource(java.lang.String id,
                     com.mapbox.geojson.FeatureCollection features,
                     GeoJsonOptions options)

Create a GeoJsonSource from a FeatureCollection and non-default GeoJsonOptions.

Parameters:

id - the source id

features - the features

options - options

GeoJsonSource

public GeoJsonSource(java.lang.String id,
                     com.mapbox.geojson.Feature feature)

Create a GeoJsonSource from a Feature

Parameters:

id - the source id

feature - the feature

GeoJsonSource

public GeoJsonSource(java.lang.String id,
                     com.mapbox.geojson.Feature feature,
                     GeoJsonOptions options)

Create a GeoJsonSource from a Feature and non-default GeoJsonOptions

Parameters:

id - the source id

feature - the feature

options - options

GeoJsonSource

public GeoJsonSource(java.lang.String id,
                     com.mapbox.geojson.Geometry geometry)

Create a GeoJsonSource from a Geometry

Parameters:

id - the source id

geometry - the geometry

GeoJsonSource

public GeoJsonSource(java.lang.String id,
                     com.mapbox.geojson.Geometry geometry,
                     GeoJsonOptions options)

Create a GeoJsonSource from a Geometry and non-default GeoJsonOptions

Parameters:

id - the source id

geometry - the geometry

options - options

Method Detail

setGeoJson

public void setGeoJson(com.mapbox.geojson.Feature feature)

Updates the GeoJson with a single feature. The update is performed asynchronously, so the data won't be immediately visible or available to query when this method returns. Note: This method is not thread-safe. The Feature is parsed on a worker thread, please make sure the Feature is immutable.

Parameters:

feature - the GeoJSON Feature to set

setGeoJson

public void setGeoJson(com.mapbox.geojson.Geometry geometry)

Updates the GeoJson with a single geometry. The update is performed asynchronously, so the data won't be immediately visible or available to query when this method returns. Note: This method is not thread-safe. The Geometry is parsed on a worker thread, please make sure the Geometry is immutable.

Parameters:

geometry - the GeoJSON Geometry to set

setGeoJson

public void setGeoJson(@Nullable
                       com.mapbox.geojson.FeatureCollection featureCollection)

Updates the GeoJson. The update is performed asynchronously, so the data won't be immediately visible or available to query when this method returns. Note: This method is not thread-safe. The FeatureCollection is parsed on a worker thread, please make sure the FeatureCollection is immutable.

Parameters:

featureCollection - the GeoJSON FeatureCollection

setGeoJson

public void setGeoJson(java.lang.String json)

Updates the GeoJson. The update is performed asynchronously, so the data won't be immediately visible or available to query when this method returns.

Parameters:

json - the raw GeoJson FeatureCollection string

setUrl

@Deprecated
public void setUrl(@NonNull
                               java.net.URL url)

Deprecated. use setUri(URI) instead

Updates the url

Parameters:

url - the GeoJSON FeatureCollection url

setUri

public void setUri(@NonNull
                   java.net.URI uri)

Updates the URI of the source.

An URI is a combination of a protocol and a resource path. The following URI protocol schemes are supported:

• http://
• load resources using HyperText Transfer Protocol
• file://
• load resources from the Android file system
• asset://
• load resources from the binary packaged assets folder

Parameters:

uri - the GeoJSON FeatureCollection uri

setUrl

@Deprecated
public void setUrl(java.lang.String url)

Deprecated. use setUri(String) instead

Updates the url

Parameters:

url - the GeoJSON FeatureCollection url

setUri

public void setUri(java.lang.String uri)

Updates the URI of the source.

An URI is a combination of a protocol and a resource path. The following URI protocol schemes are supported:

• http://
• load resources using HyperText Transfer Protocol
• file://
• load resources from the Android file system
• asset://
• load resources from the binary packaged assets folder

Parameters:

uri - the GeoJSON FeatureCollection uri

getUrl

@Nullable
public java.lang.String getUrl()

Deprecated. use getUri() instead

Returns:

The url or null

getUri

@Nullable
public java.lang.String getUri()

Get the URI of the source.

Returns:

The uri or null

querySourceFeatures

@NonNull
public java.util.List<com.mapbox.geojson.Feature> querySourceFeatures(@Nullable
                                                                               Expression filter)

Queries the source for features.

Parameters:

filter - an optional filter expression to filter the returned Features

Returns:

the features

getClusterChildren

@NonNull
public com.mapbox.geojson.FeatureCollection getClusterChildren(@NonNull
                                                                        com.mapbox.geojson.Feature cluster)

Returns the children of a cluster (on the next zoom level) given its id (cluster_id value from feature properties).

Requires configuring this source as a cluster by calling GeoJsonOptions.withCluster(boolean).

Parameters:

cluster - cluster from which to retrieve children from

Returns:

a list of features for the underlying children

getClusterLeaves

@NonNull
public com.mapbox.geojson.FeatureCollection getClusterLeaves(@NonNull
                                                                      com.mapbox.geojson.Feature cluster,
                                                                      long limit,
                                                                      long offset)

Returns all the leaves of a cluster (given its cluster_id), with pagination support: limit is the number of leaves to return (set to Infinity for all points), and offset is the amount of points to skip (for pagination).

Requires configuring this source as a cluster by calling GeoJsonOptions.withCluster(boolean).

Parameters:

cluster - cluster from which to retrieve leaves from

limit - limit is the number of points to return

offset - offset is the amount of points to skip (for pagination)

Returns:

a list of features for the underlying leaves

getClusterExpansionZoom

public int getClusterExpansionZoom(@NonNull
                                   com.mapbox.geojson.Feature cluster)

Returns the zoom on which the cluster expands into several children (useful for "click to zoom" feature) given the cluster's cluster_id (cluster_id value from feature properties).

Requires configuring this source as a cluster by calling GeoJsonOptions.withCluster(boolean).

Parameters:

cluster - cluster from which to retrieve the expansion zoom from

Returns:

the zoom on which the cluster expands into several children

initialize

protected void initialize(java.lang.String layerId,
                          java.lang.Object options)

nativeSetUrl

protected void nativeSetUrl(java.lang.String url)

nativeGetUrl

@NonNull
protected java.lang.String nativeGetUrl()

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable