com.google.maps.NearbySearchRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-maps-services Show documentation
Show all versions of google-maps-services Show documentation
Use the Google Maps API Web Services in Java! https://developers.google.com/maps/documentation/webservices/
/*
* Copyright 2016 Google Inc. All rights reserved.
*
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
* file except in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
* ANY KIND, either express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.google.maps;
import static com.google.maps.internal.StringJoin.join;
import com.google.gson.FieldNamingPolicy;
import com.google.maps.errors.ApiException;
import com.google.maps.internal.ApiConfig;
import com.google.maps.internal.ApiResponse;
import com.google.maps.model.LatLng;
import com.google.maps.model.PlaceType;
import com.google.maps.model.PlacesSearchResponse;
import com.google.maps.model.PlacesSearchResult;
import com.google.maps.model.PriceLevel;
import com.google.maps.model.RankBy;
/**
* A Nearby
* Search request.
*/
public class NearbySearchRequest
extends PendingResultBase<
PlacesSearchResponse, NearbySearchRequest, NearbySearchRequest.Response> {
static final ApiConfig API_CONFIG =
new ApiConfig("/maps/api/place/nearbysearch/json")
.fieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES);
/**
* Constructs a new {@code NearbySearchRequest}.
*
* @param context The {@code GeoApiContext} to make requests through.
*/
public NearbySearchRequest(GeoApiContext context) {
super(context, API_CONFIG, Response.class);
}
/**
* Specifies the latitude/longitude around which to retrieve place information.
*
* @param location The location to use as the center of the Nearby Search.
* @return Returns this {@code NearbyApiRequest} for call chaining.
*/
public NearbySearchRequest location(LatLng location) {
return param("location", location);
}
/**
* Specifies the distance (in meters) within which to return place results. The maximum allowed
* radius is 50,000 meters. Note that radius must not be included if {@code rankby=DISTANCE} is
* specified.
*
* @param distance The distance in meters around the {@link #location(LatLng)} to search.
* @return Returns this {@code NearbyApiRequest} for call chaining.
*/
public NearbySearchRequest radius(int distance) {
if (distance > 50000) {
throw new IllegalArgumentException("The maximum allowed radius is 50,000 meters.");
}
return param("radius", String.valueOf(distance));
}
/**
* Specifies the order in which results are listed.
*
* @param ranking The rank by method.
* @return Returns this {@code NearbyApiRequest} for call chaining.
*/
public NearbySearchRequest rankby(RankBy ranking) {
return param("rankby", ranking);
}
/**
* Specifies a term to be matched against all content that Google has indexed for this place. This
* includes but is not limited to name, type, and address, as well as customer reviews and other
* third-party content.
*
* @param keyword The keyword to search for.
* @return Returns this {@code NearbyApiRequest} for call chaining.
*/
public NearbySearchRequest keyword(String keyword) {
return param("keyword", keyword);
}
/**
* Restricts to places that are at least this price level.
*
* @param priceLevel The price level to set as minimum.
* @return Returns this {@code NearbyApiRequest} for call chaining.
*/
public NearbySearchRequest minPrice(PriceLevel priceLevel) {
return param("minprice", priceLevel);
}
/**
* Restricts to places that are at most this price level.
*
* @param priceLevel The price level to set as maximum.
* @return Returns this {@code NearbyApiRequest} for call chaining.
*/
public NearbySearchRequest maxPrice(PriceLevel priceLevel) {
return param("maxprice", priceLevel);
}
/**
* Specifies one or more terms to be matched against the names of places, separated by spaces.
*
* @param name Search for Places with this name.
* @return Returns this {@code NearbyApiRequest} for call chaining.
*/
public NearbySearchRequest name(String name) {
return param("name", name);
}
/**
* Restricts to only those places that are open for business at the time the query is sent.
*
* @param openNow Whether to restrict to places that are open.
* @return Returns this {@code NearbyApiRequest} for call chaining.
*/
public NearbySearchRequest openNow(boolean openNow) {
return param("opennow", String.valueOf(openNow));
}
/**
* Returns the next 20 results from a previously run search. Setting {@code pageToken} will
* execute a search with the same parameters used previously — all parameters other than {@code
* pageToken} will be ignored.
*
* @param nextPageToken The page token from a previous result.
* @return Returns this {@code NearbyApiRequest} for call chaining.
*/
public NearbySearchRequest pageToken(String nextPageToken) {
return param("pagetoken", nextPageToken);
}
/**
* Restricts the results to places matching the specified type.
*
* @param type The {@link PlaceType} to restrict results to.
* @return Returns this {@code NearbyApiRequest} for call chaining.
*/
public NearbySearchRequest type(PlaceType type) {
return param("type", type);
}
/**
* Restricts the results to places matching the specified type. Provides support for multiple
* types.
*
* @deprecated Multiple search types are ignored by the Places API.
* @param types The {@link PlaceType}s to restrict results to.
* @return Returns this {@code NearbyApiRequest} for call chaining.
*/
@Deprecated
public NearbySearchRequest type(PlaceType... types) {
return param("type", join('|', types));
}
@Override
protected void validateRequest() {
// If pagetoken is included, all other parameters are ignored.
if (params().containsKey("pagetoken")) {
return;
}
// radius must not be included if rankby=distance
if (params().containsKey("rankby")
&& params().get("rankby").get(0).equals(RankBy.DISTANCE.toString())
&& params().containsKey("radius")) {
throw new IllegalArgumentException("Request must not contain radius with rankby=distance");
}
// If rankby=distance is specified, then one or more of keyword, name, or type is required.
if (params().containsKey("rankby")
&& params().get("rankby").get(0).equals(RankBy.DISTANCE.toString())
&& !params().containsKey("keyword")
&& !params().containsKey("name")
&& !params().containsKey("type")) {
throw new IllegalArgumentException(
"With rankby=distance is specified, then one or more of keyword, name, or type is required");
}
}
public static class Response implements ApiResponse {
public String status;
public String htmlAttributions[];
public PlacesSearchResult results[];
public String nextPageToken;
public String errorMessage;
@Override
public boolean successful() {
return "OK".equals(status) || "ZERO_RESULTS".equals(status);
}
@Override
public PlacesSearchResponse getResult() {
PlacesSearchResponse result = new PlacesSearchResponse();
result.htmlAttributions = htmlAttributions;
result.results = results;
result.nextPageToken = nextPageToken;
return result;
}
@Override
public ApiException getError() {
if (successful()) {
return null;
}
return ApiException.from(status, errorMessage);
}
}
}