com.google.maps.TextSearchRequest Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 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 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 Text
 * Search request.
 */
public class TextSearchRequest
    extends PendingResultBase {

  static final ApiConfig API_CONFIG =
      new ApiConfig("/maps/api/place/textsearch/json")
          .fieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES);

  public TextSearchRequest(GeoApiContext context) {
    super(context, API_CONFIG, Response.class);
  }

  /**
   * Specifies the text string on which to search, for example: {@code "restaurant"}.
   *
   * @param query The query string to search for.
   * @return Returns this {@code TextSearchRequest} for call chaining.
   */
  public TextSearchRequest query(String query) {
    return param("query", query);
  }

  /**
   * Specifies the latitude/longitude around which to retrieve place information.
   *
   * @param location The location of the center of the search.
   * @return Returns this {@code TextSearchRequest} for call chaining.
   */
  public TextSearchRequest location(LatLng location) {
    return param("location", location);
  }

  /**
   * Region used to influence search results. This parameter will only influence, not fully
   * restrict, search results. If more relevant results exist outside of the specified region, they
   * may be included. When this parameter is used, the country name is omitted from the resulting
   * formatted_address for results in the specified region.
   *
   * @param region The ccTLD two-letter code of the region.
   * @return Returns this {@code TextSearchRequest} for call chaining.
   */
  public TextSearchRequest region(String region) {
    return param("region", region);
  }

  /**
   * Specifies the distance (in meters) within which to bias place results.
   *
   * @param radius The radius of the search bias.
   * @return Returns this {@code TextSearchRequest} for call chaining.
   */
  public TextSearchRequest radius(int radius) {
    if (radius > 50000) {
      throw new IllegalArgumentException("The maximum allowed radius is 50,000 meters.");
    }
    return param("radius", String.valueOf(radius));
  }

  /**
   * Restricts to places that are at least this price level.
   *
   * @param priceLevel The minimum price level to restrict results with.
   * @return Returns this {@code TextSearchRequest} for call chaining.
   */
  public TextSearchRequest minPrice(PriceLevel priceLevel) {
    return param("minprice", priceLevel);
  }

  /**
   * Restricts to places that are at most this price level.
   *
   * @param priceLevel The maximum price leve to restrict results with.
   * @return Returns this {@code TextSearchRequest} for call chaining.
   */
  public TextSearchRequest maxPrice(PriceLevel priceLevel) {
    return param("maxprice", priceLevel);
  }

  /**
   * Specifies one or more terms to be matched against the names of places, separated with space
   * characters.
   *
   * @param name The name to search for.
   * @return Returns this {@code TextSearchRequest} for call chaining.
   */
  public TextSearchRequest 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 this search to open places.
   * @return Returns this {@code TextSearchRequest} for call chaining.
   */
  public TextSearchRequest openNow(boolean openNow) {
    return param("opennow", String.valueOf(openNow));
  }

  /**
   * Returns the next 20 results from a previously run search. Setting pageToken will execute a
   * search with the same parameters used previously — all parameters other than pageToken will be
   * ignored.
   *
   * @param nextPageToken A {@code pageToken} from a prior result.
   * @return Returns this {@code TextSearchRequest} for call chaining.
   */
  public TextSearchRequest pageToken(String nextPageToken) {
    return param("pagetoken", nextPageToken);
  }

  /**
   * Specifies the order in which results are listed.
   *
   * @param ranking The rank by method.
   * @return Returns this {@code TextSearchRequest} for call chaining.
   */
  public TextSearchRequest rankby(RankBy ranking) {
    return param("rankby", ranking);
  }

  /**
   * Restricts the results to places matching the specified type.
   *
   * @param type The type of place to restrict the results with.
   * @return Returns this {@code TextSearchRequest} for call chaining.
   */
  public TextSearchRequest type(PlaceType type) {
    return param("type", type);
  }

  @Override
  protected void validateRequest() {

    // All other parameters are ignored if pagetoken is specified.
    if (params().containsKey("pagetoken")) {
      return;
    }

    if (!params().containsKey("query") && !params().containsKey("type")) {
      throw new IllegalArgumentException(
          "Request must contain 'query' or a 'pageToken'. If a 'type' is specified 'query' becomes optional.");
    }

    if (params().containsKey("location") && !params().containsKey("radius")) {
      throw new IllegalArgumentException(
          "Request must contain 'radius' parameter when it contains a 'location' parameter.");
    }
  }

  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);
    }
  }
}