Skip to content

Batch geocoding support #267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zugaldia merged 7 commits into from
Jan 11, 2017
Merged

Batch geocoding support #267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5d04003
new geocoding batch fixture
zugaldia Jan 10, 2017
9d3ad90
add a new geocoding-batch-fixtures rule and fix the paths
zugaldia Jan 10, 2017
40830a1
reformat fixture for easy reading
zugaldia Jan 10, 2017
3dd4daf
add batch methods and tests
zugaldia Jan 10, 2017
d5ff6e7
update @since 2.0.0 tags
zugaldia Jan 11, 2017
f2b2ce8
remove unnecessary code from MapboxGeocodingBatchTest
zugaldia Jan 11, 2017
2ca64e2
o o p s
zugaldia Jan 11, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,33 +55,37 @@ dex-count:
geocoding-fixtures:
# Geocoding: 1600 Pennsylvania Ave NW
curl "https://api.mapbox.com/geocoding/v5/mapbox.places/1600+pennsylvania+ave+nw.json?access_token=$(MAPBOX_ACCESS_TOKEN)" \
-o libjava/lib/src/test/fixtures/geocoding.json
-o mapbox/libjava-services/src/test/fixtures/geocoding.json

# Reverse geocoding: -77.0366, 38.8971
curl "https://api.mapbox.com/geocoding/v5/mapbox.places/-77.0366,38.8971.json?access_token=$(MAPBOX_ACCESS_TOKEN)" \
-o libjava/lib/src/test/fixtures/geocoding_reverse.json
-o mapbox/libjava-services/src/test/fixtures/geocoding_reverse.json

#
# Not supported country
curl "https://api.mapbox.com/geocoding/v5/mapbox.places/1600+pennsylvania+ave+nw.json?country=aq&access_token=$(MAPBOX_ACCESS_TOKEN)" \
-o libjava/lib/src/test/fixtures/geocoding_country_not_supported.json
-o mapbox/libjava-services/src/test/fixtures/geocoding_country_not_supported.json

geocoding-batch-fixtures:
curl "https://api.mapbox.com/geocoding/v5/mapbox.places-permanent/20001;20009;22209.json?access_token=$(MAPBOX_ACCESS_TOKEN)" \
-o mapbox/libjava-services/src/test/fixtures/geocoding_batch.json

directions-fixtures:
curl "https://api.mapbox.com/directions/v5/mapbox/driving/-122.416667,37.783333;-121.900000,37.333333?geometries=polyline&steps=true&access_token=$(MAPBOX_ACCESS_TOKEN)" \
-o libjava/lib/src/test/fixtures/directions_v5.json
-o mapbox/libjava-services/src/test/fixtures/directions_v5.json

mapmatching-fixtures:
# Geometry polyline
curl -X POST --header "Content-Type:application/json" -d @libjava/lib/src/test/fixtures/mapmatching_trace.json \
curl -X POST --header "Content-Type:application/json" -d @mapbox/libjava-services/src/test/fixtures/mapmatching_trace.json \
"https://api.mapbox.com/matching/v4/mapbox.driving.json?geometry=polyline&access_token=$(MAPBOX_ACCESS_TOKEN)" \
-o libjava/lib/src/test/fixtures/mapmatching_v5_polyline.json
-o mapbox/libjava-services/src/test/fixtures/mapmatching_v5_polyline.json

# No geometry
curl -X POST --header "Content-Type:application/json" -d @libjava/lib/src/test/fixtures/mapmatching_trace.json \
curl -X POST --header "Content-Type:application/json" -d @mapbox/libjava-services/src/test/fixtures/mapmatching_trace.json \
"https://api.mapbox.com/matching/v4/mapbox.driving.json?geometry=false&access_token=$(MAPBOX_ACCESS_TOKEN)" \
-o libjava/lib/src/test/fixtures/mapmatching_v5_no_geometry.json
-o mapbox/libjava-services/src/test/fixtures/mapmatching_v5_no_geometry.json

distance-fixtures:
# Retrieve a duration matrix
curl -X POST --header "Content-Type:application/json" -d @libjava/lib/src/test/fixtures/distance_coordinates.json \
curl -X POST --header "Content-Type:application/json" -d @mapbox/libjava-services/src/test/fixtures/distance_coordinates.json \
"https://api.mapbox.com/distances/v1/mapbox/driving?access_token=$(MAPBOX_ACCESS_TOKEN)" \
-o libjava/lib/src/test/fixtures/distance_v1.json
-o mapbox/libjava-services/src/test/fixtures/distance_v1.json
34 changes: 33 additions & 1 deletion ...libjava-services/src/main/java/com/mapbox/services/api/geocoding/v5/GeocodingService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

import com.mapbox.services.api.geocoding.v5.models.GeocodingResponse;

import java.util.List;

import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Header;
Expand All @@ -19,7 +21,7 @@ public interface GeocodingService {
* Call-based interface
*
* @param userAgent The user
* @param mode mapbox.places or mapbox.places-permanent for enterprise/batch geocoding.
* @param mode mapbox.places or mapbox.places-permanent for enterprise geocoding.
* @param query a location; a place name for forward geocoding or a coordinate pair
* (longitude, latitude location) for reverse geocoding
* @param accessToken Mapbox access token.
Expand All @@ -44,4 +46,34 @@ Call<GeocodingResponse> getCall(
@Query("autocomplete") Boolean autocomplete,
@Query("bbox") String bbox,
@Query("limit") String limit);

/**
* Call-based interface
*
* @param userAgent The user
* @param mode mapbox.places-permanent for batch geocoding.
* @param query a location; a place name for forward geocoding or a coordinate pair
* (longitude, latitude location) for reverse geocoding
* @param accessToken Mapbox access token.
* @param country ISO 3166 alpha 2 country codes, separated by commas.
* @param proximity Location around which to bias results.
* @param types Filter results by one or more type.
* @param autocomplete True if you want auto complete.
* @param bbox Optionally pass in a bounding box to limit results in.
* @param limit Optionally pass in a limit the amount of returning results.
* @return A retrofit Call object
* @since 1.0.0

@cammace cammace Jan 10, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@since 2.0.0

*/
@GET("/geocoding/v5/{mode}/{query}.json")
Call<List<GeocodingResponse>> getBatchCall(
@Header("User-Agent") String userAgent,
@Path("mode") String mode,
@Path("query") String query,
@Query("access_token") String accessToken,
@Query("country") String country,
@Query("proximity") String proximity,
@Query("types") String types,
@Query("autocomplete") Boolean autocomplete,
@Query("bbox") String bbox,
@Query("limit") String limit);
}
77 changes: 77 additions & 0 deletions .../libjava-services/src/main/java/com/mapbox/services/api/geocoding/v5/MapboxGeocoding.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import com.mapbox.services.api.geocoding.v5.models.GeocodingResponse;

import java.io.IOException;
import java.util.List;
import java.util.Locale;

import retrofit2.Call;
Expand All @@ -30,6 +31,7 @@ public class MapboxGeocoding extends MapboxService<GeocodingResponse> {
private Builder builder = null;
private GeocodingService service = null;
private Call<GeocodingResponse> call = null;
private Call<List<GeocodingResponse>> batchCall = null;

/**
* Public constructor.
Expand Down Expand Up @@ -80,6 +82,10 @@ public Call<GeocodingResponse> getCall() {
return call;
}

if (builder.getQuery().contains(";")) {
throw new IllegalArgumentException("Use getBatchCall() for batch calls.");

@cammace cammace Jan 10, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

niceee

}

call = getService().getCall(
getHeaderUserAgent(builder.getClientAppName()),
builder.getMode(),
Expand All @@ -95,6 +101,37 @@ public Call<GeocodingResponse> getCall() {
return call;
}

/**
* Used internally.
*
* @return batch call
* @since 2.0.0
*/
public Call<List<GeocodingResponse>> getBatchCall() {
// No need to recreate it
if (batchCall != null) {
return batchCall;
}

if (!builder.getQuery().contains(";")) {
throw new IllegalArgumentException("Use getCall() for non-batch calls.");
}

batchCall = getService().getBatchCall(
getHeaderUserAgent(builder.getClientAppName()),
builder.getMode(),
builder.getQuery(),
builder.getAccessToken(),
builder.getCountry(),
builder.getProximity(),
builder.getGeocodingTypes(),
builder.getAutocomplete(),
builder.getBbox(),
builder.getLimit());

return batchCall;
}

/**
* Execute the call
*
Expand All @@ -107,6 +144,17 @@ public Response<GeocodingResponse> executeCall() throws IOException {
return getCall().execute();
}

/**
* Execute the batch call
*
* @return The Geocoding v5 response
* @throws IOException Signals that an I/O exception of some sort has occurred.
* @since 2.0.0
*/
public Response<List<GeocodingResponse>> executeBatchCall() throws IOException {
return getBatchCall().execute();
}

/**
* Execute the call
*
Expand All @@ -118,6 +166,16 @@ public void enqueueCall(Callback<GeocodingResponse> callback) {
getCall().enqueue(callback);
}

/**
* Execute the batch call
*
* @param callback A Retrofit callback.
* @since 2.0.0
*/
public void enqueueBatchCall(Callback<List<GeocodingResponse>> callback) {
getBatchCall().enqueue(callback);
}

/**
* Cancel the call
*
Expand All @@ -128,6 +186,15 @@ public void cancelCall() {
getCall().cancel();
}

/**
* Cancel the batch call
*
* @since 2.0.0
*/
public void cancelBatchCall() {
getBatchCall().cancel();
}

/**
* clone the call
*
Expand All @@ -139,6 +206,16 @@ public Call<GeocodingResponse> cloneCall() {
return getCall().clone();
}

/**
* clone the batch call
*
* @return cloned call
* @since 2.0.0
*/
public Call<List<GeocodingResponse>> cloneBatchCall() {
return getBatchCall().clone();
}

/**
* Builds your geocoder query by adding parameters.
*
Expand Down
Loading