Skip to content

Commit d5d5b4f

Browse files
author
Langston Smith
authored
Rename references of mapIds to tileSetIds (#1047)
1 parent be67752 commit d5d5b4f

4 files changed

Lines changed: 29 additions & 29 deletions

File tree

samples/src/main/java/com/mapbox/samples/BasicTilequery.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public class BasicTilequery {
1515
public static void main(String[] args) {
1616
MapboxTilequery tilequery = MapboxTilequery.builder()
1717
.accessToken(BuildConfig.MAPBOX_ACCESS_TOKEN)
18-
.mapIds("mapbox.mapbox-streets-v7")
18+
.tilesetIds("mapbox.mapbox-streets-v7")
1919
.query(Point.fromLngLat(-122.42901, 37.806332))
2020
.radius(500)
2121
.limit(2)

services-tilequery/src/main/java/com/mapbox/api/tilequery/MapboxTilequery.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ protected GsonBuilder getGsonBuilder() {
5252
@Override
5353
protected Call<FeatureCollection> initializeCall() {
5454
return getService().getCall(
55-
mapIds(),
55+
tilesetIds(),
5656
query(),
5757
accessToken(),
5858
radius(),
@@ -69,7 +69,7 @@ private Call<List<FeatureCollection>> getBatchCall() {
6969
}
7070

7171
batchCall = getService().getBatchCall(
72-
mapIds(),
72+
tilesetIds(),
7373
query(),
7474
accessToken(),
7575
radius(),
@@ -145,7 +145,7 @@ public static Builder builder() {
145145
abstract String accessToken();
146146

147147
@NonNull
148-
abstract String mapIds();
148+
abstract String tilesetIds();
149149

150150
@NonNull
151151
abstract String query();
@@ -167,7 +167,7 @@ public static Builder builder() {
167167

168168
/**
169169
* This builder is used to create a new request to the Mapbox Tilequery API. At a bare minimum,
170-
* your request must include an access token, a map ID, and a query of some kind. All other
170+
* your request must include an access token, a tileset ID, and a query of some kind. All other
171171
* fields can be left alone in order to use the default behaviour of the API.
172172
* <p>
173173
* Note to contributors: All optional booleans in this builder use the object {@code Boolean}
@@ -198,14 +198,14 @@ public abstract static class Builder {
198198
public abstract Builder accessToken(@NonNull String accessToken);
199199

200200
/**
201-
* The ID of the map being queried. If you need to composite multiple layers, the Tilequery
202-
* API endpoint can also support a comma-separated list of map IDs.
201+
* The ID of the tileset being queried. If you need to composite multiple layers, the Tilequery
202+
* API endpoint can also support a comma-separated list of tileset IDs.
203203
*
204-
* @param mapIds Map ID(s)
204+
* @param tilesetIds tile set ID(s)
205205
* @return this builder for chaining options together
206206
* @since 3.5.0
207207
*/
208-
public abstract Builder mapIds(String mapIds);
208+
public abstract Builder tilesetIds(String tilesetIds);
209209

210210
/**
211211
* The longitude and latitude to be queried.

services-tilequery/src/main/java/com/mapbox/api/tilequery/TilequeryService.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public interface TilequeryService {
1919
/**
2020
* Constructs the HTTP request for the specified parameters.
2121
*
22-
* @param mapIds Map ID(s)
22+
* @param tilesetIds tile set ID(s)
2323
* @param query query point
2424
* @param accessToken Mapbox access token
2525
* @param radius distance in meters to query for features
@@ -30,9 +30,9 @@ public interface TilequeryService {
3030
* @return A retrofit Call object
3131
* @since 3.5.0
3232
*/
33-
@GET("/v4/{mapIds}/tilequery/{query}.json")
33+
@GET("/v4/{tilesetIds}/tilequery/{query}.json")
3434
Call<FeatureCollection> getCall(
35-
@Path("mapIds") String mapIds,
35+
@Path("tilesetIds") String tilesetIds,
3636
@Path("query") String query,
3737
@Query("access_token") String accessToken,
3838
@Query("radius") Integer radius,
@@ -44,7 +44,7 @@ Call<FeatureCollection> getCall(
4444
/**
4545
* Constructs the HTTP request for the specified parameters.
4646
*
47-
* @param mapIds Map ID(s)
47+
* @param tilesetIds tile set ID(s)
4848
* @param query query point
4949
* @param accessToken Mapbox access token
5050
* @param radius distance in meters to query for features
@@ -55,9 +55,9 @@ Call<FeatureCollection> getCall(
5555
* @return A retrofit Call object
5656
* @since 3.5.0
5757
*/
58-
@GET("/v4/{mapIds}/tilequery/{query}.json")
58+
@GET("/v4/{tilesetIds}/tilequery/{query}.json")
5959
Call<List<FeatureCollection>> getBatchCall(
60-
@Path("mapIds") String mapIds,
60+
@Path("tilesetIds") String tilesetIds,
6161
@Path("query") String query,
6262
@Query("access_token") String accessToken,
6363
@Query("radius") Integer radius,

services-tilequery/src/test/java/com/mapbox/api/tilequery/MapboxTilequeryTest.java

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public void sanity() throws ServicesException, IOException {
2727
MapboxTilequery client = MapboxTilequery.builder()
2828
.accessToken(ACCESS_TOKEN)
2929
.query("-122.42901,37.80633")
30-
.mapIds("mapbox.mapbox-streets-v7")
30+
.tilesetIds("mapbox.mapbox-streets-v7")
3131
.baseUrl(mockUrl.toString())
3232
.build();
3333
Response<FeatureCollection> response = client.executeCall();
@@ -40,7 +40,7 @@ public void query_acceptsPointsCorrectly() throws Exception {
4040
MapboxTilequery client = MapboxTilequery.builder()
4141
.accessToken(ACCESS_TOKEN)
4242
.query(Point.fromLngLat(-122.42901,37.80633))
43-
.mapIds("mapbox.mapbox-streets-v7")
43+
.tilesetIds("mapbox.mapbox-streets-v7")
4444
.baseUrl(mockUrl.toString())
4545
.build();
4646

@@ -56,7 +56,7 @@ public void build_noAccessTokenExceptionThrown() throws Exception {
5656
thrown.expectMessage("Missing required properties: accessToken");
5757
MapboxTilequery.builder()
5858
.query("-122.42901,37.80633")
59-
.mapIds("mapbox.mapbox-streets-v7")
59+
.tilesetIds("mapbox.mapbox-streets-v7")
6060
.baseUrl(mockUrl.toString())
6161
.build();
6262
}
@@ -68,7 +68,7 @@ public void build_invalidAccessTokenExceptionThrown() throws ServicesException {
6868
MapboxTilequery.builder()
6969
.accessToken("")
7070
.query("-122.42901,37.80633")
71-
.mapIds("mapbox.mapbox-streets-v7")
71+
.tilesetIds("mapbox.mapbox-streets-v7")
7272
.baseUrl(mockUrl.toString())
7373
.build();
7474
}
@@ -79,7 +79,7 @@ public void build_noQueryExceptionThrown() throws Exception {
7979
thrown.expectMessage("Missing required properties: query");
8080
MapboxTilequery.builder()
8181
.accessToken(ACCESS_TOKEN)
82-
.mapIds("mapbox.mapbox-streets-v7")
82+
.tilesetIds("mapbox.mapbox-streets-v7")
8383
.baseUrl(mockUrl.toString())
8484
.build();
8585
}
@@ -91,15 +91,15 @@ public void build_invalidQueryExceptionThrown() throws ServicesException {
9191
MapboxTilequery.builder()
9292
.accessToken(ACCESS_TOKEN)
9393
.query("")
94-
.mapIds("mapbox.mapbox-streets-v7")
94+
.tilesetIds("mapbox.mapbox-streets-v7")
9595
.baseUrl(mockUrl.toString())
9696
.build();
9797
}
9898

9999
@Test
100100
public void build_noMapIdExceptionThrown() throws Exception {
101101
thrown.expect(IllegalStateException.class);
102-
thrown.expectMessage("Missing required properties: mapIds");
102+
thrown.expectMessage("Missing required properties: tilesetIds");
103103
MapboxTilequery.builder()
104104
.accessToken(ACCESS_TOKEN)
105105
.query("-122.42901,37.80633")
@@ -112,7 +112,7 @@ public void build_optionalParameters() throws Exception {
112112
MapboxTilequery client = MapboxTilequery.builder()
113113
.accessToken(ACCESS_TOKEN)
114114
.query("-122.42901,37.80633")
115-
.mapIds("mapbox.mapbox-streets-v7")
115+
.tilesetIds("mapbox.mapbox-streets-v7")
116116
.baseUrl(mockUrl.toString())
117117
.build();
118118

@@ -132,7 +132,7 @@ public void build_limitGetsAddedToListCorrectly() throws Exception {
132132
MapboxTilequery client = MapboxTilequery.builder()
133133
.accessToken(ACCESS_TOKEN)
134134
.query("-122.42901,37.80633")
135-
.mapIds("mapbox.mapbox-streets-v7")
135+
.tilesetIds("mapbox.mapbox-streets-v7")
136136
.baseUrl(mockUrl.toString())
137137
.limit(50)
138138
.build();
@@ -145,7 +145,7 @@ public void build_radiusGetsAddedToListCorrectly() throws Exception {
145145
MapboxTilequery client = MapboxTilequery.builder()
146146
.accessToken(ACCESS_TOKEN)
147147
.query("-122.42901,37.80633")
148-
.mapIds("mapbox.mapbox-streets-v7")
148+
.tilesetIds("mapbox.mapbox-streets-v7")
149149
.baseUrl(mockUrl.toString())
150150
.radius(200)
151151
.build();
@@ -158,7 +158,7 @@ public void build_geometryGetsAddedToListCorrectly() throws Exception {
158158
MapboxTilequery client = MapboxTilequery.builder()
159159
.accessToken(ACCESS_TOKEN)
160160
.query("-122.42901,37.80633")
161-
.mapIds("mapbox.mapbox-streets-v7")
161+
.tilesetIds("mapbox.mapbox-streets-v7")
162162
.baseUrl(mockUrl.toString())
163163
.geometry(TilequeryCriteria.TILEQUERY_GEOMETRY_LINESTRING)
164164
.build();
@@ -172,7 +172,7 @@ public void build_dedupeGetsAddedToListCorrectly() throws Exception {
172172
MapboxTilequery client = MapboxTilequery.builder()
173173
.accessToken(ACCESS_TOKEN)
174174
.query("-122.42901,37.80633")
175-
.mapIds("mapbox.mapbox-streets-v7")
175+
.tilesetIds("mapbox.mapbox-streets-v7")
176176
.baseUrl(mockUrl.toString())
177177
.dedupe(true)
178178
.build();
@@ -186,7 +186,7 @@ public void build_layersGetAddedToListCorrectly() throws Exception {
186186
MapboxTilequery client = MapboxTilequery.builder()
187187
.accessToken(ACCESS_TOKEN)
188188
.query("-122.42901,37.80633")
189-
.mapIds("mapbox.mapbox-streets-v7")
189+
.tilesetIds("mapbox.mapbox-streets-v7")
190190
.baseUrl(mockUrl.toString())
191191
.layers("poi_label")
192192
.build();
@@ -199,7 +199,7 @@ public void executeCall_optionalParamLimitHonored() throws Exception {
199199
MapboxTilequery clientAppParams = MapboxTilequery.builder()
200200
.accessToken(ACCESS_TOKEN)
201201
.query("-122.42901,37.80633")
202-
.mapIds("mapbox.mapbox-streets-v7")
202+
.tilesetIds("mapbox.mapbox-streets-v7")
203203
.baseUrl(mockUrl.toString())
204204
.layers("poi_label")
205205
.geometry("point")

0 commit comments

Comments
 (0)