Skip to content

Find place

View on GitHubSample viewer app

Find places of interest near a location or within a specific area.

Image of find place

Use case

When getting directions or looking for nearby places, users may only know what the place has ("food"), the type of place ("gym"), or the generic place name ("Starbucks"), rather than the specific address. You can get suggestions and locations for these places of interest (POIs) using a natural language query. Additionally, you can filter the results to a specific area.

How to use the sample

Choose a type of place in the first field and an area to search within in the second field. Click the "Search" button to show the results of the query on the map. Click on a result pin to show its name and address. If you pan away from the result area, the "Redo search in this area" button at the bottom of the screen will become active. Click it to query again for the currently viewed area on the map.

How it works

  1. Create a LocatorTask using a URL to a locator service.
  2. Find the location for an address (or city name) to build an envelope to search within:
    • Create GeocodeParameters.
    • Add return fields to the parameters' resultAttributeNames collection. Only add a single "*" option to return all fields.
    • Call locatorTask.geocodeAsync(locationQueryString, geocodeParameters) to get a list of GeocodeResults.
    • Use getDisplayLocation from each of the results to build an Envelope to view.
  3. Get place of interest (POI) suggestions based on a place name query:
    • Create SuggestParameters.
    • Add "POI" to the parameters' categories collection with getCategories().add("POI").
    • Call locatorTask.suggestAsync(placeQueryString, suggestParameters) to get a list of SuggestResults.
    • The SuggestResult will have a label to display in the search suggestions list.
  4. Use one of the suggestions or a user-written query to find the locations of POIs:
    • Create GeocodeParameters.
    • Set the parameters' search area to the envelope.
    • Call locatorTask.geocodeAsync(suggestionLabelOrPlaceQueryString, geocodeParameters) to get a list of GeocodeResults.
    • Display the places of interest using the results' displayLocations.

Relevant API

  • GeocodeParameters
  • GeocodeResult
  • LocatorTask
  • SuggestParameters
  • SuggestResult

Additional information

This sample uses the World Geocoding Service. For more information, see the Geocoding service help topic on the ArcGIS Developer website.

Tags

businesses, geocode, locations, locator, places of interest, POI, point of interest, search, suggestions

Sample Code

FindPlaceController.javaFindPlaceController.javaFindPlaceSample.java
Use dark colors for code blocksCopy
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 /*  * Copyright 2017 Esri.  *  * 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.esri.samples.find_place;  import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.concurrent.ExecutionException; import java.util.stream.Collectors;  import javafx.application.Platform; import javafx.fxml.FXML; import javafx.geometry.Point2D; import javafx.scene.control.Button; import javafx.scene.control.ComboBox; import javafx.scene.control.skin.ComboBoxListViewSkin; import javafx.scene.image.Image; import javafx.scene.input.KeyCode; import javafx.scene.input.KeyEvent; import javafx.scene.input.MouseButton; import javafx.util.Duration;  import com.esri.arcgisruntime.ArcGISRuntimeEnvironment; import com.esri.arcgisruntime.concurrent.ListenableFuture; import com.esri.arcgisruntime.geometry.Envelope; import com.esri.arcgisruntime.geometry.Point; import com.esri.arcgisruntime.mapping.ArcGISMap; import com.esri.arcgisruntime.mapping.BasemapStyle; import com.esri.arcgisruntime.mapping.Viewpoint; import com.esri.arcgisruntime.mapping.view.Callout; import com.esri.arcgisruntime.mapping.view.Graphic; import com.esri.arcgisruntime.mapping.view.GraphicsOverlay; import com.esri.arcgisruntime.mapping.view.IdentifyGraphicsOverlayResult; import com.esri.arcgisruntime.mapping.view.MapView; import com.esri.arcgisruntime.mapping.view.ViewpointChangedEvent; import com.esri.arcgisruntime.mapping.view.ViewpointChangedListener; import com.esri.arcgisruntime.mapping.view.WrapAroundMode; import com.esri.arcgisruntime.symbology.PictureMarkerSymbol; import com.esri.arcgisruntime.tasks.geocode.GeocodeParameters; import com.esri.arcgisruntime.tasks.geocode.GeocodeResult; import com.esri.arcgisruntime.tasks.geocode.LocatorTask; import com.esri.arcgisruntime.tasks.geocode.SuggestParameters; import com.esri.arcgisruntime.tasks.geocode.SuggestResult;  public class FindPlaceController {   @FXML private ComboBox<String> locationBox;  @FXML private MapView mapView;  @FXML private ComboBox<String> placeBox;  @FXML private Button redoButton;   private Callout callout;  private GraphicsOverlay graphicsOverlay;  private LocatorTask locatorTask;  private PictureMarkerSymbol pinSymbol;   @FXML  public void initialize() {  // authentication with an API key or named user is required to access basemaps and other location services  String yourAPIKey = System.getProperty("apiKey");  ArcGISRuntimeEnvironment.setApiKey(yourAPIKey);   // handle JavaFX bug where entering a space between words in the combobox editor will reset the text there  handleSpaceEntered(placeBox);  handleSpaceEntered(locationBox);   // create a map with the streets basemap style  ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS);   // set the map to the map view  mapView.setMap(map);  mapView.setWrapAroundMode(WrapAroundMode.DISABLED);   // add a graphics overlay to the map view  graphicsOverlay = new GraphicsOverlay();  mapView.getGraphicsOverlays().add(graphicsOverlay);   // set the callout's default style  callout = mapView.getCallout();  callout.setLeaderPosition(Callout.LeaderPosition.BOTTOM);   // create a locator task  locatorTask = new LocatorTask("https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer");   // create a pin graphic  Image img = new Image(getClass().getResourceAsStream("/find_place/pin.png"), 0, 80, true, true);  pinSymbol = new PictureMarkerSymbol(img);  pinSymbol.loadAsync();   // event to get auto-complete suggestions when the user types a place query  placeBox.getEditor().setOnKeyTyped((KeyEvent evt) -> {   // get the search box text for auto-complete suggestions  String typed = placeBox.getEditor().getText();   if (!"".equals(typed)) {   // suggest places only  SuggestParameters geocodeParameters = new SuggestParameters();  geocodeParameters.getCategories().add("POI");   // get suggestions from the locatorTask  ListenableFuture<List<SuggestResult>> suggestions = locatorTask.suggestAsync(typed, geocodeParameters);   // add a listener to update suggestions list when loaded  suggestions.addDoneListener(new SuggestionsLoadedListener(suggestions, placeBox));  }  });   // event to get auto-complete suggestions for location when the user types a search location  locationBox.getEditor().setOnKeyTyped((KeyEvent evt) -> {   // get the search box text for auto-complete suggestions  String typed = locationBox.getEditor().getText();   if (!typed.equals("")) {   // get suggestions from the locatorTask  ListenableFuture<List<SuggestResult>> suggestions = locatorTask.suggestAsync(typed);   // add a listener to update suggestions list when loaded  suggestions.addDoneListener(new SuggestionsLoadedListener(suggestions, locationBox));  }  });   // event to display a callout for a selected result  mapView.setOnMouseClicked(evt -> {  // check that the primary mouse button was clicked and the user is not panning  if (evt.isStillSincePress() && evt.getButton() == MouseButton.PRIMARY) {  // create a point from where the user clicked  Point2D point = new Point2D(evt.getX(), evt.getY());   // get layers with elements near the clicked location  ListenableFuture<IdentifyGraphicsOverlayResult> identifyResults =  mapView.identifyGraphicsOverlayAsync(graphicsOverlay, point,  10, false);  identifyResults.addDoneListener(() -> {  try {  List<Graphic> graphics = identifyResults.get().getGraphics();  if (graphics.size() > 0) {  Graphic marker = graphics.get(0);  // update the callout  Platform.runLater(() -> {  callout.setTitle(marker.getAttributes().get("title").toString());  callout.setDetail(marker.getAttributes().get("detail").toString());  callout.showCalloutAt((Point) marker.getGeometry(), new Point2D(0, -24), Duration.ZERO);  });  }  } catch (Exception e) {  e.printStackTrace();  }  });  }  });  }   /**  * Handles a JavaFX bug (https://bugs.openjdk.org/browse/JDK-8087549) where when the user enters a space the combobox editor TextField is reset.  *  * @param comboBox the comboBox to apply the JavaFX bug work around to  */  private void handleSpaceEntered(ComboBox<String> comboBox) {   var comboBoxListViewSkin = new ComboBoxListViewSkin<>(comboBox);  comboBoxListViewSkin.getPopupContent().addEventFilter(KeyEvent.ANY, (event -> {  if (event.getCode() == KeyCode.SPACE) {  event.consume();  }  })  );  comboBox.setSkin(comboBoxListViewSkin);  }   /**  * Searches for places near the chosen location when the "search" button is clicked.  */  @FXML  private void search() {  String placeQuery = placeBox.getEditor().getText();  String locationQuery = locationBox.getEditor().getText();  if (placeQuery != null && locationQuery != null && !"".equals(placeQuery) && !"".equals(locationQuery)) {  GeocodeParameters geocodeParameters = new GeocodeParameters();  geocodeParameters.getResultAttributeNames().add("*"); // return all attributes  geocodeParameters.setOutputSpatialReference(mapView.getSpatialReference());   // run the locatorTask geocode task  ListenableFuture<List<GeocodeResult>> results = locatorTask.geocodeAsync(locationQuery, geocodeParameters);  results.addDoneListener(() -> {  try {  List<GeocodeResult> points = results.get();  if (points.size() > 0) {  // create a search area envelope around the location  Point p = points.get(0).getDisplayLocation();  Envelope preferredSearchArea = new Envelope(p.getX() - 10000, p.getY() - 10000, p.getX() + 10000, p.getY  () + 10000, p.getSpatialReference());  // set the geocode parameters search area to the envelope  geocodeParameters.setSearchArea(preferredSearchArea);  // zoom to the envelope  mapView.setViewpointAsync(new Viewpoint(preferredSearchArea));  // perform the geocode operation  ListenableFuture<List<GeocodeResult>> geocodeTask = locatorTask.geocodeAsync(placeQuery,  geocodeParameters);   // add a listener to display the results when loaded  geocodeTask.addDoneListener(new ResultsLoadedListener(geocodeTask));  }  } catch (Exception e) {  e.printStackTrace();  }  });  }  }   /**  * Searches for places within the current map extent when the "redo search in this area" button is clicked.  */  @FXML  private void searchByCurrentViewpoint() {  String placeQuery = placeBox.getEditor().getText();  GeocodeParameters geocodeParameters = new GeocodeParameters();  geocodeParameters.getResultAttributeNames().add("*"); // return all attributes  geocodeParameters.setOutputSpatialReference(mapView.getSpatialReference());  geocodeParameters.setSearchArea(mapView.getCurrentViewpoint(Viewpoint.Type.BOUNDING_GEOMETRY).getTargetGeometry());   //perform the geocode operation  ListenableFuture<List<GeocodeResult>> geocodeTask = locatorTask.geocodeAsync(placeQuery, geocodeParameters);   // add a listener to display the results when loaded  geocodeTask.addDoneListener(new ResultsLoadedListener(geocodeTask));  }   /**  * A listener to update a {@link ComboBox} when suggestions from a call to  * {@link LocatorTask#suggestAsync(String, SuggestParameters)} are loaded.  */  private class SuggestionsLoadedListener implements Runnable {   private final ListenableFuture<List<SuggestResult>> results;  private final ComboBox<String> comboBox;   /**  * Constructs a listener to update an auto-complete list for geocode  * suggestions.  *  * @param results suggestion results from a {@link LocatorTask}  * @param box the {@link ComboBox} to update with the suggestions  */  SuggestionsLoadedListener(ListenableFuture<List<SuggestResult>> results, ComboBox<String> box) {  this.results = results;  this.comboBox = box;  }   @Override  public void run() {   try {  List<SuggestResult> suggestResult = results.get();  List<String> suggestions = suggestResult.stream().map(SuggestResult::getLabel).collect(Collectors.toList());   // update the combo box with suggestions  Platform.runLater(() -> {  comboBox.getItems().clear();  comboBox.getItems().addAll(suggestions);  comboBox.show();  });   } catch (InterruptedException | ExecutionException e) {  e.printStackTrace();  }  }  }   /**  * Runnable listener to update marker and callout when new results are loaded.  */  private class ResultsLoadedListener implements Runnable {   private final ListenableFuture<List<GeocodeResult>> results;   /**  * Constructs a runnable listener for the geocode results.  *  * @param results results from a {@link LocatorTask#geocodeAsync} task  */  ResultsLoadedListener(ListenableFuture<List<GeocodeResult>> results) {  this.results = results;  }   @Override  public void run() {   // hide callout if showing  mapView.getCallout().dismiss();   List<Graphic> markers = new ArrayList<>();  try {  List<GeocodeResult> geocodes = results.get();  for (GeocodeResult geocode : geocodes) {   // get attributes from the result for the callout  String addrType = geocode.getAttributes().get("Addr_type").toString();  String placeName = geocode.getAttributes().get("PlaceName").toString();  String placeAddr = geocode.getAttributes().get("Place_addr").toString();  String matchAddr = geocode.getAttributes().get("Match_addr").toString();  String locType = geocode.getAttributes().get("Type").toString();   // format callout details  String title;  String detail;  switch (addrType) {  case "POI":  title = placeName.equals("") ? "" : placeName;  if (!placeAddr.equals("")) {  detail = placeAddr;  } else if (!matchAddr.equals("") && !locType.equals("")) {  detail = !matchAddr.contains(",") ? locType : matchAddr.substring(matchAddr.indexOf(", ") + 2);  } else {  detail = "";  }  break;  case "StreetName":  case "PointAddress":  case "Postal":  if (matchAddr.contains(",")) {  title = matchAddr.equals("") ? "" : matchAddr.split(",")[0];  detail = matchAddr.equals("") ? "" : matchAddr.substring(matchAddr.indexOf(", ") + 2);  break;  }  default:  title = "";  detail = matchAddr.equals("") ? "" : matchAddr;  break;  }   HashMap<String, Object> attributes = new HashMap<>();  attributes.put("title", title);  attributes.put("detail", detail);   // create the marker  Graphic marker = new Graphic(geocode.getDisplayLocation(), attributes, pinSymbol);  markers.add(marker);  }   // update the markers  if (markers.size() > 0) {  Platform.runLater(() -> {  // clear out previous results  graphicsOverlay.getGraphics().clear();  placeBox.hide();   // add the markers to the graphics overlay  graphicsOverlay.getGraphics().addAll(markers);   //reset redo search button  redoButton.setDisable(true);   // listener to enable the redo-search button the first time the user moves away from the initial search area  ViewpointChangedListener changedListener = new ViewpointChangedListener() {   @Override  public void viewpointChanged(ViewpointChangedEvent arg0) {   redoButton.setDisable(false);  mapView.removeViewpointChangedListener(this);  }  };   mapView.addViewpointChangedListener(changedListener);  });  }   } catch (InterruptedException | ExecutionException e) {  e.printStackTrace();  }  }  }   /**  * Stops the animation and disposes of application resources.  */  void terminate() {   if (mapView != null) {  mapView.dispose();  }  }  }

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.