com.mapbox.api.tilequery

Class MapboxTilequery.Builder

java.lang.Object

com.mapbox.api.tilequery.MapboxTilequery.Builder

Enclosing class:

MapboxTilequery

public abstract static class MapboxTilequery.Builder
extends java.lang.Object

This builder is used to create a new request to the Mapbox Tilequery API. At a bare minimum, your request must include an access token, a tileset ID, and a query of some kind. All other fields can be left alone in order to use the default behaviour of the API.

Note to contributors: All optional booleans in this builder use the object Boolean rather than the primitive to allow for unset (null) values.

Since:

3.5.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract MapboxTilequery.Builder	accessToken(java.lang.String accessToken) Required to call when this is being built.
abstract MapboxTilequery.Builder	baseUrl(java.lang.String baseUrl) Optionally change the APIs base URL to something other then the default Mapbox one.
MapboxTilequery	build() Build a new MapboxTilequery object.
abstract MapboxTilequery.Builder	dedupe(java.lang.Boolean dedupe) Determines whether results will be deduplicated or not.
abstract MapboxTilequery.Builder	geometry(java.lang.String geometry) Queries for a specific geometry type.
abstract MapboxTilequery.Builder	layers(java.lang.String layers) A comma-separated list of layers to query, rather than querying all layers.
abstract MapboxTilequery.Builder	limit(java.lang.Integer limit) The number of features between 1 - 50 to return.
MapboxTilequery.Builder	query(com.mapbox.geojson.Point point) The longitude and latitude to be queried.
abstract MapboxTilequery.Builder	query(java.lang.String query) The longitude and latitude to be queried.
abstract MapboxTilequery.Builder	radius(java.lang.Integer radius) The approximate distance in meters to query for features.
abstract MapboxTilequery.Builder	tilesetIds(java.lang.String tilesetIds) The ID of the tileset being queried.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

baseUrl

public abstract MapboxTilequery.Builder baseUrl(@NonNull
                                                java.lang.String baseUrl)

Optionally change the APIs base URL to something other then the default Mapbox one.

Parameters:

baseUrl - base url used as end point

Returns:

this builder for chaining options together

Since:

3.5.0

accessToken

public abstract MapboxTilequery.Builder accessToken(@NonNull
                                                    java.lang.String accessToken)

Required to call when this is being built. If no access token provided, ServicesException will be thrown.

Parameters:

accessToken - Mapbox access token

Returns:

this builder for chaining options together

Since:

3.5.0

tilesetIds

public abstract MapboxTilequery.Builder tilesetIds(java.lang.String tilesetIds)

The ID of the tileset being queried. If you need to composite multiple layers, the Tilequery API endpoint can also support a comma-separated list of tileset IDs.

Parameters:

tilesetIds - tile set ID(s)

Returns:

this builder for chaining options together

Since:

3.5.0

query

public MapboxTilequery.Builder query(@NonNull
                                     com.mapbox.geojson.Point point)

The longitude and latitude to be queried.

Parameters:

point - query point

Returns:

this builder for chaining options together

Since:

3.5.0

query

public abstract MapboxTilequery.Builder query(@NonNull
                                              java.lang.String query)

The longitude and latitude to be queried.

Parameters:

query - query point

Returns:

this builder for chaining options together

Since:

3.5.0

radius

public abstract MapboxTilequery.Builder radius(@Nullable
                                               java.lang.Integer radius)

The approximate distance in meters to query for features. Defaults to 0. Has no upper bound. Required for queries against point and line data. Due to the nature of tile buffering, a query with a large radius made against equally large point or line data may not include all possible features in the results. Queries will use tiles from the maximum zoom of the tileset, and will only include the intersecting tile plus 8 surrounding tiles when searching for nearby features.

Parameters:

radius - distance in meters to query for features

Returns:

this builder for chaining options together

Since:

3.5.0

limit

public abstract MapboxTilequery.Builder limit(@Nullable
                                              java.lang.Integer limit)

The number of features between 1 - 50 to return. Defaults to 5.

Parameters:

limit - the number of features

Returns:

this builder for chaining options together

Since:

3.5.0

dedupe

public abstract MapboxTilequery.Builder dedupe(@Nullable
                                               java.lang.Boolean dedupe)

Determines whether results will be deduplicated or not. Defaults to true.

Parameters:

dedupe - whether results will be deduplicated

Returns:

this builder for chaining options together

Since:

3.5.0

geometry

public abstract MapboxTilequery.Builder geometry(@Nullable
                                                 java.lang.String geometry)

Queries for a specific geometry type. Options are polygon, linestring, or point.

Parameters:

geometry - polygon, linestring, or point

Returns:

this builder for chaining options together

Since:

3.5.0

layers

public abstract MapboxTilequery.Builder layers(@Nullable
                                               java.lang.String layers)

A comma-separated list of layers to query, rather than querying all layers. If a specified layer does not exist, it is skipped. If no layers exist, returns an empty FeatureCollection.

Parameters:

layers - list of layers to query

Returns:

this builder for chaining options together

Since:

3.5.0

build

public MapboxTilequery build()

Build a new MapboxTilequery object.

Returns:

this builder for chaining options together

Since:

3.5.0