Search for an address

Learn how to find an address or place with a search bar and the geocoding service A geocoding service is a service that can search for addresses, place addresses, businesses, reverse geocode coordinates to addresses, provide suggestions for places, and perform bulk geocoding. It is hosted by Esri as the ArcGIS Geocoding service and can also be hosted in ArcGIS Enterprise. Learn more .

Geocoding is the process of converting address or place A place, also known as a point of interest (POI), is a location that represents a business, administrative entity, or geographic feature around the world. A place can also have attributes associated with it, such as a name, address, category, and ID. Learn more text into a location A location is a position or region (point, line, or polygon) on the earth's surface. Learn more . The geocoding service A geocoding service is a service that can search for addresses, place addresses, businesses, reverse geocode coordinates to addresses, provide suggestions for places, and perform bulk geocoding. It is hosted by Esri as the ArcGIS Geocoding service and can also be hosted in ArcGIS Enterprise. Learn more can search for an address or a place and perform reverse geocoding Reverse geocoding is the process of converting a point to its nearest address or place. Learn more .

In this tutorial, you use a search bar in the user interface to access the Geocoding service and search for addresses and places.

Prerequisites

Steps

Get an access token

You need an access token An access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication. Learn more to use the location services ArcGIS Location Services, also referred to as Location Services, are services hosted by Esri that provide geospatial functionality for developing mapping applications. They include the ArcGIS Basemap Styles service, ArcGIS Static Basemap Tiles service, ArcGIS Places service, ArcGIS Geocoding service, ArcGIS Routing service, ArcGIS GeoEnrichment service, and ArcGIS Elevation service. An ArcGIS Location Platform or ArcGIS Online account is required to use the services. Learn more used in this tutorial.

1. Go to the Create an API key tutorial to obtain an access token An access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication. Learn more using your ArcGIS Location Platform An ArcGIS Location Platform account, formerly known as an ArcGIS Developer account, is an identity associated with an ArcGIS Location Platform subscription. Learn more or ArcGIS Online An ArcGIS Online account, also known as an ArcGIS Organization account, is an identity associated with an ArcGIS Online subscription. It can be used to access ArcGIS tools and develop applications with ArcGIS location services for an organization. Learn more account.

2. Ensure that the following privileges Privileges are a set of permissions assigned to ArcGIS accounts, developer credentials, and applications that grant access to secure resources and functionality in ArcGIS. Learn more are enabled: Location services > Basemaps > Basemap styles service and Location services > Geocoding.

3. Copy the access token as it will be used in the next step.

To learn more about other ways to get an access token, go to Types of authentication.

Open a Java project with Gradle

1. To start this tutorial, complete the Display a map tutorial, or download and unzip the Display a map solution into a new folder.

2. Open the build.gradle file as a project in IntelliJ IDEA.

3. In IntelliJ IDEA’s Project tool window, open src/main/java/com.example.app and double-click App.

4. In the start() method, set the API key property on the ArcGISRuntimeEnvironment with your access token An access token is an authorization string that provides access to secure ArcGIS content, data, and services. Its capabilities are determined by the privileges it supports. It is obtained by implementing API key authentication, User authentication, or App authentication. Learn more . Replace YOUR_ACCESS_TOKEN with your copied access token. Be sure to surround your access token with double quotes as it is a string.

   App.java

       ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");

Add import statements and variable declarations

Add import statements and variable declarations to reference the packages and classes required for this tutorial.

1. In IntelliJ IDEA’s Project tool window, open src/main/java/com.example.app and double-click App.

2. Add the following imports above the existing imports:

   App.java

   1
   import java.util.List;
   2
   import java.util.concurrent.ExecutionException;
   3
   
   4
   import javafx.geometry.Insets;
   5
   import javafx.geometry.Pos;
   6
   import javafx.scene.paint.Color;
   7
   import javafx.scene.control.Alert;
   8
   import javafx.scene.control.TextField;
   9
   
   10
   import com.esri.arcgisruntime.concurrent.ListenableFuture;
   11
   import com.esri.arcgisruntime.mapping.view.Graphic;
   12
   import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
   13
   import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
   14
   import com.esri.arcgisruntime.symbology.TextSymbol;
   15
   import com.esri.arcgisruntime.tasks.geocode.GeocodeParameters;
   16
   import com.esri.arcgisruntime.tasks.geocode.GeocodeResult;
   17
   import com.esri.arcgisruntime.tasks.geocode.LocatorTask;
   18
   
   19
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   20
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   21
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   22
   import com.esri.arcgisruntime.mapping.Viewpoint;
   23
   import com.esri.arcgisruntime.mapping.view.MapView;
   24
   
   25
   import javafx.application.Application;
   26
   import javafx.scene.Scene;
   27
   import javafx.scene.layout.StackPane;
   28
   import javafx.stage.Stage;

3. Within the App class, add the following member variables to easily reference them from other parts of the application:

   App.java

   1
   public class App extends Application {
   2
   
   3
     private MapView mapView;
   4
   
   5
     private GeocodeParameters geocodeParameters;
   6
     private GraphicsOverlay graphicsOverlay;
   7
     private LocatorTask locatorTask;
   8
   
   9
     private TextField searchBox;

Add a graphics overlay

A graphics overlay A graphics overlay is a client-side, temporary container of graphics to display on a map view or scene view. Learn more is a container for graphics A graphic is a visual element composed of a geometry, symbol, and attributes that is displayed on a map or scene. Learn more . A graphic will be added later in this tutorial as a visual means to display the search result on the map A map is a collection of layers that are displayed in 2D. It is typically composed of a basemap layer and data layers. Learn more .

1. In the start() method, create a new GraphicsOverlay and add it to the mapView.

   App.java

   80 collapsed lines
   2
   //   Copyright 2020 Esri
   3
   //   Licensed under the Apache License, Version 2.0 (the "License");
   4
   //   you may not use this file except in compliance with the License.
   5
   //   You may obtain a copy of the License at
   6
   //
   7
   //   http://www.apache.org/licenses/LICENSE-2.0
   8
   //
   9
   //   Unless required by applicable law or agreed to in writing, software
   10
   //   distributed under the License is distributed on an "AS IS" BASIS,
   11
   //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   12
   //   See the License for the specific language governing permissions and
   13
   //   limitations under the License.
   14
   
   15
   package com.example.app;
   16
   
   17
   import java.util.List;
   18
   import java.util.concurrent.ExecutionException;
   19
   
   20
   import javafx.geometry.Insets;
   21
   import javafx.geometry.Pos;
   22
   import javafx.scene.paint.Color;
   23
   import javafx.scene.control.Alert;
   24
   import javafx.scene.control.TextField;
   25
   
   26
   import com.esri.arcgisruntime.concurrent.ListenableFuture;
   27
   import com.esri.arcgisruntime.mapping.view.Graphic;
   28
   import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
   29
   import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
   30
   import com.esri.arcgisruntime.symbology.TextSymbol;
   31
   import com.esri.arcgisruntime.tasks.geocode.GeocodeParameters;
   32
   import com.esri.arcgisruntime.tasks.geocode.GeocodeResult;
   33
   import com.esri.arcgisruntime.tasks.geocode.LocatorTask;
   34
   
   35
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   36
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   37
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   38
   import com.esri.arcgisruntime.mapping.Viewpoint;
   39
   import com.esri.arcgisruntime.mapping.view.MapView;
   40
   
   41
   import javafx.application.Application;
   42
   import javafx.scene.Scene;
   43
   import javafx.scene.layout.StackPane;
   44
   import javafx.stage.Stage;
   45
   
   46
   public class App extends Application {
   47
   
   48
     private MapView mapView;
   49
   
   50
     private GeocodeParameters geocodeParameters;
   51
     private GraphicsOverlay graphicsOverlay;
   52
     private LocatorTask locatorTask;
   53
   
   54
     private TextField searchBox;
   55
   
   56
     public static void main(String[] args) {
   57
       Application.launch(args);
   58
     }
   59
   
   60
   
   61
     @Override
   62
     public void start(Stage stage) {
   63
   
   64
       // set the title and size of the stage and show it
   65
       stage.setTitle("Search for an address tutorial");
   66
       stage.setWidth(800);
   67
       stage.setHeight(700);
   68
       stage.show();
   69
       // create a JavaFX scene with a stack pane as the root node
   70
       // and add it to the scene
   71
   
   72
       StackPane stackPane = new StackPane();
   73
       Scene scene = new Scene(stackPane);
   74
       stage.setScene(scene);
   75
   
   76
       ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
   77
   
   78
       // create a map view to display the map and add it to the stack pane
   79
       mapView = new MapView();
   80
       stackPane.getChildren().add(mapView);
   81
   
   82
       ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   83
       // set the map on the map view
   84
       mapView.setMap(map);
   85
       mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572));
   86
   
   87
       // create a graphics overlay and add it to the map view
   88
       graphicsOverlay = new GraphicsOverlay();
   89
   
   90
       mapView.getGraphicsOverlays().add(graphicsOverlay);
   14 collapsed lines
   91
   
   92
     }
   93
   
   94
     /**
   95
      * Stops and releases all resources used in application.
   96
      */
   97
     @Override
   98
     public void stop() {
   99
       if (mapView != null) {
   100
         mapView.dispose();
   101
       }
   102
     }
   103
   
   104
   }

Add a UI for user input

To search an address using the application, add a UI element to prompt the user for text input. The text input will be used as the geocode search text in a later step.

1. Create a new private method named setupTextField().

2. Within the method body, create a JavaFX TextField, assign it to the searchBox member variable, and set its width and prompt text.

   App.java

   88 collapsed lines
   2
   //   Copyright 2020 Esri
   3
   //   Licensed under the Apache License, Version 2.0 (the "License");
   4
   //   you may not use this file except in compliance with the License.
   5
   //   You may obtain a copy of the License at
   6
   //
   7
   //   http://www.apache.org/licenses/LICENSE-2.0
   8
   //
   9
   //   Unless required by applicable law or agreed to in writing, software
   10
   //   distributed under the License is distributed on an "AS IS" BASIS,
   11
   //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   12
   //   See the License for the specific language governing permissions and
   13
   //   limitations under the License.
   14
   
   15
   package com.example.app;
   16
   
   17
   import java.util.List;
   18
   import java.util.concurrent.ExecutionException;
   19
   
   20
   import javafx.geometry.Insets;
   21
   import javafx.geometry.Pos;
   22
   import javafx.scene.paint.Color;
   23
   import javafx.scene.control.Alert;
   24
   import javafx.scene.control.TextField;
   25
   
   26
   import com.esri.arcgisruntime.concurrent.ListenableFuture;
   27
   import com.esri.arcgisruntime.mapping.view.Graphic;
   28
   import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
   29
   import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
   30
   import com.esri.arcgisruntime.symbology.TextSymbol;
   31
   import com.esri.arcgisruntime.tasks.geocode.GeocodeParameters;
   32
   import com.esri.arcgisruntime.tasks.geocode.GeocodeResult;
   33
   import com.esri.arcgisruntime.tasks.geocode.LocatorTask;
   34
   
   35
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   36
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   37
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   38
   import com.esri.arcgisruntime.mapping.Viewpoint;
   39
   import com.esri.arcgisruntime.mapping.view.MapView;
   40
   
   41
   import javafx.application.Application;
   42
   import javafx.scene.Scene;
   43
   import javafx.scene.layout.StackPane;
   44
   import javafx.stage.Stage;
   45
   
   46
   public class App extends Application {
   47
   
   48
     private MapView mapView;
   49
   
   50
     private GeocodeParameters geocodeParameters;
   51
     private GraphicsOverlay graphicsOverlay;
   52
     private LocatorTask locatorTask;
   53
   
   54
     private TextField searchBox;
   55
   
   56
     public static void main(String[] args) {
   57
       Application.launch(args);
   58
     }
   59
   
   60
   
   61
     @Override
   62
     public void start(Stage stage) {
   63
   
   64
       // set the title and size of the stage and show it
   65
       stage.setTitle("Search for an address tutorial");
   66
       stage.setWidth(800);
   67
       stage.setHeight(700);
   68
       stage.show();
   69
       // create a JavaFX scene with a stack pane as the root node
   70
       // and add it to the scene
   71
   
   72
       StackPane stackPane = new StackPane();
   73
       Scene scene = new Scene(stackPane);
   74
       stage.setScene(scene);
   75
   
   76
       ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
   77
   
   78
       // create a map view to display the map and add it to the stack pane
   79
       mapView = new MapView();
   80
       stackPane.getChildren().add(mapView);
   81
   
   82
       ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   83
       // set the map on the map view
   84
       mapView.setMap(map);
   85
       mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572));
   86
   
   87
       // create a graphics overlay and add it to the map view
   88
       graphicsOverlay = new GraphicsOverlay();
   89
   
   90
       mapView.getGraphicsOverlays().add(graphicsOverlay);
   91
   
   92
     }
   93
   
   94
     private void setupTextField() {
   95
       searchBox = new TextField();
   96
       searchBox.setMaxWidth(400);
   97
       searchBox.setPromptText("Search for an address");
   98
     }
   12 collapsed lines
   99
   
   100
     /**
   101
      * Stops and releases all resources used in application.
   102
      */
   103
     @Override
   104
     public void stop() {
   105
       if (mapView != null) {
   106
         mapView.dispose();
   107
       }
   108
     }
   109
   
   110
   }

3. Call the setupTextField() method in the start() method.

   App.java

   88 collapsed lines
   2
   //   Copyright 2020 Esri
   3
   //   Licensed under the Apache License, Version 2.0 (the "License");
   4
   //   you may not use this file except in compliance with the License.
   5
   //   You may obtain a copy of the License at
   6
   //
   7
   //   http://www.apache.org/licenses/LICENSE-2.0
   8
   //
   9
   //   Unless required by applicable law or agreed to in writing, software
   10
   //   distributed under the License is distributed on an "AS IS" BASIS,
   11
   //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   12
   //   See the License for the specific language governing permissions and
   13
   //   limitations under the License.
   14
   
   15
   package com.example.app;
   16
   
   17
   import java.util.List;
   18
   import java.util.concurrent.ExecutionException;
   19
   
   20
   import javafx.geometry.Insets;
   21
   import javafx.geometry.Pos;
   22
   import javafx.scene.paint.Color;
   23
   import javafx.scene.control.Alert;
   24
   import javafx.scene.control.TextField;
   25
   
   26
   import com.esri.arcgisruntime.concurrent.ListenableFuture;
   27
   import com.esri.arcgisruntime.mapping.view.Graphic;
   28
   import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
   29
   import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
   30
   import com.esri.arcgisruntime.symbology.TextSymbol;
   31
   import com.esri.arcgisruntime.tasks.geocode.GeocodeParameters;
   32
   import com.esri.arcgisruntime.tasks.geocode.GeocodeResult;
   33
   import com.esri.arcgisruntime.tasks.geocode.LocatorTask;
   34
   
   35
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   36
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   37
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   38
   import com.esri.arcgisruntime.mapping.Viewpoint;
   39
   import com.esri.arcgisruntime.mapping.view.MapView;
   40
   
   41
   import javafx.application.Application;
   42
   import javafx.scene.Scene;
   43
   import javafx.scene.layout.StackPane;
   44
   import javafx.stage.Stage;
   45
   
   46
   public class App extends Application {
   47
   
   48
     private MapView mapView;
   49
   
   50
     private GeocodeParameters geocodeParameters;
   51
     private GraphicsOverlay graphicsOverlay;
   52
     private LocatorTask locatorTask;
   53
   
   54
     private TextField searchBox;
   55
   
   56
     public static void main(String[] args) {
   57
       Application.launch(args);
   58
     }
   59
   
   60
   
   61
     @Override
   62
     public void start(Stage stage) {
   63
   
   64
       // set the title and size of the stage and show it
   65
       stage.setTitle("Search for an address tutorial");
   66
       stage.setWidth(800);
   67
       stage.setHeight(700);
   68
       stage.show();
   69
       // create a JavaFX scene with a stack pane as the root node
   70
       // and add it to the scene
   71
   
   72
       StackPane stackPane = new StackPane();
   73
       Scene scene = new Scene(stackPane);
   74
       stage.setScene(scene);
   75
   
   76
       ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
   77
   
   78
       // create a map view to display the map and add it to the stack pane
   79
       mapView = new MapView();
   80
       stackPane.getChildren().add(mapView);
   81
   
   82
       ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   83
       // set the map on the map view
   84
       mapView.setMap(map);
   85
       mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572));
   86
   
   87
       // create a graphics overlay and add it to the map view
   88
       graphicsOverlay = new GraphicsOverlay();
   89
   
   90
       mapView.getGraphicsOverlays().add(graphicsOverlay);
   91
   
   92
       setupTextField();
   20 collapsed lines
   93
   
   94
     }
   95
   
   96
     private void setupTextField() {
   97
       searchBox = new TextField();
   98
       searchBox.setMaxWidth(400);
   99
       searchBox.setPromptText("Search for an address");
   100
     }
   101
   
   102
     /**
   103
      * Stops and releases all resources used in application.
   104
      */
   105
     @Override
   106
     public void stop() {
   107
       if (mapView != null) {
   108
         mapView.dispose();
   109
       }
   110
     }
   111
   
   112
   }

4. Add the searchBox to the top left of the map, setting its alignment and margins as shown:

   App.java

   90 collapsed lines
   2
   //   Copyright 2020 Esri
   3
   //   Licensed under the Apache License, Version 2.0 (the "License");
   4
   //   you may not use this file except in compliance with the License.
   5
   //   You may obtain a copy of the License at
   6
   //
   7
   //   http://www.apache.org/licenses/LICENSE-2.0
   8
   //
   9
   //   Unless required by applicable law or agreed to in writing, software
   10
   //   distributed under the License is distributed on an "AS IS" BASIS,
   11
   //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   12
   //   See the License for the specific language governing permissions and
   13
   //   limitations under the License.
   14
   
   15
   package com.example.app;
   16
   
   17
   import java.util.List;
   18
   import java.util.concurrent.ExecutionException;
   19
   
   20
   import javafx.geometry.Insets;
   21
   import javafx.geometry.Pos;
   22
   import javafx.scene.paint.Color;
   23
   import javafx.scene.control.Alert;
   24
   import javafx.scene.control.TextField;
   25
   
   26
   import com.esri.arcgisruntime.concurrent.ListenableFuture;
   27
   import com.esri.arcgisruntime.mapping.view.Graphic;
   28
   import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
   29
   import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
   30
   import com.esri.arcgisruntime.symbology.TextSymbol;
   31
   import com.esri.arcgisruntime.tasks.geocode.GeocodeParameters;
   32
   import com.esri.arcgisruntime.tasks.geocode.GeocodeResult;
   33
   import com.esri.arcgisruntime.tasks.geocode.LocatorTask;
   34
   
   35
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   36
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   37
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   38
   import com.esri.arcgisruntime.mapping.Viewpoint;
   39
   import com.esri.arcgisruntime.mapping.view.MapView;
   40
   
   41
   import javafx.application.Application;
   42
   import javafx.scene.Scene;
   43
   import javafx.scene.layout.StackPane;
   44
   import javafx.stage.Stage;
   45
   
   46
   public class App extends Application {
   47
   
   48
     private MapView mapView;
   49
   
   50
     private GeocodeParameters geocodeParameters;
   51
     private GraphicsOverlay graphicsOverlay;
   52
     private LocatorTask locatorTask;
   53
   
   54
     private TextField searchBox;
   55
   
   56
     public static void main(String[] args) {
   57
       Application.launch(args);
   58
     }
   59
   
   60
   
   61
     @Override
   62
     public void start(Stage stage) {
   63
   
   64
       // set the title and size of the stage and show it
   65
       stage.setTitle("Search for an address tutorial");
   66
       stage.setWidth(800);
   67
       stage.setHeight(700);
   68
       stage.show();
   69
       // create a JavaFX scene with a stack pane as the root node
   70
       // and add it to the scene
   71
   
   72
       StackPane stackPane = new StackPane();
   73
       Scene scene = new Scene(stackPane);
   74
       stage.setScene(scene);
   75
   
   76
       ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
   77
   
   78
       // create a map view to display the map and add it to the stack pane
   79
       mapView = new MapView();
   80
       stackPane.getChildren().add(mapView);
   81
   
   82
       ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   83
       // set the map on the map view
   84
       mapView.setMap(map);
   85
       mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572));
   86
   
   87
       // create a graphics overlay and add it to the map view
   88
       graphicsOverlay = new GraphicsOverlay();
   89
   
   90
       mapView.getGraphicsOverlays().add(graphicsOverlay);
   91
   
   92
       setupTextField();
   93
   
   94
       stackPane.getChildren().add(searchBox);
   95
       StackPane.setAlignment(searchBox, Pos.TOP_LEFT);
   96
       StackPane.setMargin(searchBox, new Insets(10, 0, 0, 10));
   97
   
   98
     }
   18 collapsed lines
   99
   
   100
     private void setupTextField() {
   101
       searchBox = new TextField();
   102
       searchBox.setMaxWidth(400);
   103
       searchBox.setPromptText("Search for an address");
   104
     }
   105
   
   106
     /**
   107
      * Stops and releases all resources used in application.
   108
      */
   109
     @Override
   110
     public void stop() {
   111
       if (mapView != null) {
   112
         mapView.dispose();
   113
       }
   114
     }
   115
   
   116
   }

Create a locator task with geocode parameters

Geocoding is implemented with a locator A locator is an ArcGIS dataset that stores address information and the rules for translating descriptions of places (such as street addresses or place names) into spatial data that can be displayed on a map. Learn more , typically created by referencing a service such as the Geocoding service A geocoding service is a service that can search for addresses, place addresses, businesses, reverse geocode coordinates to addresses, provide suggestions for places, and perform bulk geocoding. It is hosted by Esri as the ArcGIS Geocoding service and can also be hosted in ArcGIS Enterprise. Learn more or, for offline geocoding, by referencing locator data contained in a mobile package A mobile package is a stand-alone Mobile Map Package (MMPK) or Mobile Scene Package (MSPK) file for use in offline applications built with ArcGIS Maps SDKs for Native Apps. Learn more . Geocoding parameters can be used to fine-tune the results, such as setting the maximum number of results or requesting additional attributes in the results.

1. Create a new private method named createLocatorTaskAndDefaultParameters().

2. Within the method body, create a new LocatorTask based on the Geocoding service, and assign it to the locatorTask member variable.

   More info

   A locator task is used to convert an address to a point (geocode) or vice-versa (reverse geocode). An address includes any type of information that distinguishes a place. A locator A locator is an ArcGIS dataset that stores address information and the rules for translating descriptions of places (such as street addresses or place names) into spatial data that can be displayed on a map. Learn more involves finding matching locations for a given address. Reverse-geocoding is the opposite and finds the closest address for a given location.

3. Create new GeocodeParameters, and assign it to the geocodeParameters member variable. Specify the geocode’s attributes as follows:

   • Specify which attributes to return by calling the .add() method on the GeocodeParameters.getResultAttributeNames(). * is used to return all attributes.
   • Set the maximum number of results to be returned with GeocodeParameters.setMaxResults(). In this tutorial, only return the best match by passing in 1. Results are ordered by score, so returning only the first result will return the highest scoring result.
   • Set the spatial reference A spatial reference is a set of parameters, typically defined by a WKID, that define the coordinate system and spatial properties for geographic data. Applications use a spatial reference to correctly display the position of geographic data in a map or scene. Learn more with GeocodeParameters.setOutputSpatialReference(). By default the output spatial reference is determined by the geocode service. For optimal performance when displaying the geocode result, ensure the returned coordinates match those of the map view by providing mapView.getSpatialReference() as a parameter.
   More info

   When geocoding an address, you can optionally provide GeocodeParameters to control certain aspects of the geocoding operation, and specify the kinds of results to return from the locator task.

   App.java

   98 collapsed lines
   2
   //   Copyright 2020 Esri
   3
   //   Licensed under the Apache License, Version 2.0 (the "License");
   4
   //   you may not use this file except in compliance with the License.
   5
   //   You may obtain a copy of the License at
   6
   //
   7
   //   http://www.apache.org/licenses/LICENSE-2.0
   8
   //
   9
   //   Unless required by applicable law or agreed to in writing, software
   10
   //   distributed under the License is distributed on an "AS IS" BASIS,
   11
   //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   12
   //   See the License for the specific language governing permissions and
   13
   //   limitations under the License.
   14
   
   15
   package com.example.app;
   16
   
   17
   import java.util.List;
   18
   import java.util.concurrent.ExecutionException;
   19
   
   20
   import javafx.geometry.Insets;
   21
   import javafx.geometry.Pos;
   22
   import javafx.scene.paint.Color;
   23
   import javafx.scene.control.Alert;
   24
   import javafx.scene.control.TextField;
   25
   
   26
   import com.esri.arcgisruntime.concurrent.ListenableFuture;
   27
   import com.esri.arcgisruntime.mapping.view.Graphic;
   28
   import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
   29
   import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
   30
   import com.esri.arcgisruntime.symbology.TextSymbol;
   31
   import com.esri.arcgisruntime.tasks.geocode.GeocodeParameters;
   32
   import com.esri.arcgisruntime.tasks.geocode.GeocodeResult;
   33
   import com.esri.arcgisruntime.tasks.geocode.LocatorTask;
   34
   
   35
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   36
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   37
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   38
   import com.esri.arcgisruntime.mapping.Viewpoint;
   39
   import com.esri.arcgisruntime.mapping.view.MapView;
   40
   
   41
   import javafx.application.Application;
   42
   import javafx.scene.Scene;
   43
   import javafx.scene.layout.StackPane;
   44
   import javafx.stage.Stage;
   45
   
   46
   public class App extends Application {
   47
   
   48
     private MapView mapView;
   49
   
   50
     private GeocodeParameters geocodeParameters;
   51
     private GraphicsOverlay graphicsOverlay;
   52
     private LocatorTask locatorTask;
   53
   
   54
     private TextField searchBox;
   55
   
   56
     public static void main(String[] args) {
   57
       Application.launch(args);
   58
     }
   59
   
   60
   
   61
     @Override
   62
     public void start(Stage stage) {
   63
   
   64
       // set the title and size of the stage and show it
   65
       stage.setTitle("Search for an address tutorial");
   66
       stage.setWidth(800);
   67
       stage.setHeight(700);
   68
       stage.show();
   69
       // create a JavaFX scene with a stack pane as the root node
   70
       // and add it to the scene
   71
   
   72
       StackPane stackPane = new StackPane();
   73
       Scene scene = new Scene(stackPane);
   74
       stage.setScene(scene);
   75
   
   76
       ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
   77
   
   78
       // create a map view to display the map and add it to the stack pane
   79
       mapView = new MapView();
   80
       stackPane.getChildren().add(mapView);
   81
   
   82
       ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   83
       // set the map on the map view
   84
       mapView.setMap(map);
   85
       mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572));
   86
   
   87
       // create a graphics overlay and add it to the map view
   88
       graphicsOverlay = new GraphicsOverlay();
   89
   
   90
       mapView.getGraphicsOverlays().add(graphicsOverlay);
   91
   
   92
       setupTextField();
   93
   
   94
       stackPane.getChildren().add(searchBox);
   95
       StackPane.setAlignment(searchBox, Pos.TOP_LEFT);
   96
       StackPane.setMargin(searchBox, new Insets(10, 0, 0, 10));
   97
   
   98
     }
   99
   
   100
     private void setupTextField() {
   101
       searchBox = new TextField();
   102
       searchBox.setMaxWidth(400);
   103
       searchBox.setPromptText("Search for an address");
   104
     }
   105
   
   106
     private void createLocatorTaskAndDefaultParameters() {
   107
       locatorTask = new LocatorTask("https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer");
   108
   
   109
       geocodeParameters = new GeocodeParameters();
   110
       geocodeParameters.getResultAttributeNames().add("*");
   111
       geocodeParameters.setMaxResults(1);
   112
       geocodeParameters.setOutputSpatialReference(mapView.getSpatialReference());
   113
     }
   12 collapsed lines
   114
   
   115
     /**
   116
      * Stops and releases all resources used in application.
   117
      */
   118
     @Override
   119
     public void stop() {
   120
       if (mapView != null) {
   121
         mapView.dispose();
   122
       }
   123
     }
   124
   
   125
   }

4. Call the createLocatorTaskAndDefaultParameters() method in the start() method.

   App.java

   90 collapsed lines
   2
   //   Copyright 2020 Esri
   3
   //   Licensed under the Apache License, Version 2.0 (the "License");
   4
   //   you may not use this file except in compliance with the License.
   5
   //   You may obtain a copy of the License at
   6
   //
   7
   //   http://www.apache.org/licenses/LICENSE-2.0
   8
   //
   9
   //   Unless required by applicable law or agreed to in writing, software
   10
   //   distributed under the License is distributed on an "AS IS" BASIS,
   11
   //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   12
   //   See the License for the specific language governing permissions and
   13
   //   limitations under the License.
   14
   
   15
   package com.example.app;
   16
   
   17
   import java.util.List;
   18
   import java.util.concurrent.ExecutionException;
   19
   
   20
   import javafx.geometry.Insets;
   21
   import javafx.geometry.Pos;
   22
   import javafx.scene.paint.Color;
   23
   import javafx.scene.control.Alert;
   24
   import javafx.scene.control.TextField;
   25
   
   26
   import com.esri.arcgisruntime.concurrent.ListenableFuture;
   27
   import com.esri.arcgisruntime.mapping.view.Graphic;
   28
   import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
   29
   import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
   30
   import com.esri.arcgisruntime.symbology.TextSymbol;
   31
   import com.esri.arcgisruntime.tasks.geocode.GeocodeParameters;
   32
   import com.esri.arcgisruntime.tasks.geocode.GeocodeResult;
   33
   import com.esri.arcgisruntime.tasks.geocode.LocatorTask;
   34
   
   35
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   36
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   37
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   38
   import com.esri.arcgisruntime.mapping.Viewpoint;
   39
   import com.esri.arcgisruntime.mapping.view.MapView;
   40
   
   41
   import javafx.application.Application;
   42
   import javafx.scene.Scene;
   43
   import javafx.scene.layout.StackPane;
   44
   import javafx.stage.Stage;
   45
   
   46
   public class App extends Application {
   47
   
   48
     private MapView mapView;
   49
   
   50
     private GeocodeParameters geocodeParameters;
   51
     private GraphicsOverlay graphicsOverlay;
   52
     private LocatorTask locatorTask;
   53
   
   54
     private TextField searchBox;
   55
   
   56
     public static void main(String[] args) {
   57
       Application.launch(args);
   58
     }
   59
   
   60
   
   61
     @Override
   62
     public void start(Stage stage) {
   63
   
   64
       // set the title and size of the stage and show it
   65
       stage.setTitle("Search for an address tutorial");
   66
       stage.setWidth(800);
   67
       stage.setHeight(700);
   68
       stage.show();
   69
       // create a JavaFX scene with a stack pane as the root node
   70
       // and add it to the scene
   71
   
   72
       StackPane stackPane = new StackPane();
   73
       Scene scene = new Scene(stackPane);
   74
       stage.setScene(scene);
   75
   
   76
       ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
   77
   
   78
       // create a map view to display the map and add it to the stack pane
   79
       mapView = new MapView();
   80
       stackPane.getChildren().add(mapView);
   81
   
   82
       ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   83
       // set the map on the map view
   84
       mapView.setMap(map);
   85
       mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572));
   86
   
   87
       // create a graphics overlay and add it to the map view
   88
       graphicsOverlay = new GraphicsOverlay();
   89
   
   90
       mapView.getGraphicsOverlays().add(graphicsOverlay);
   91
   
   92
       setupTextField();
   93
   
   94
       createLocatorTaskAndDefaultParameters();
   24 collapsed lines
   95
   
   96
       stackPane.getChildren().add(searchBox);
   97
       StackPane.setAlignment(searchBox, Pos.TOP_LEFT);
   98
       StackPane.setMargin(searchBox, new Insets(10, 0, 0, 10));
   99
   
   100
     }
   101
   
   102
     private void setupTextField() {
   103
       searchBox = new TextField();
   104
       searchBox.setMaxWidth(400);
   105
       searchBox.setPromptText("Search for an address");
   106
     }
   107
   
   108
     /**
   109
      * Stops and releases all resources used in application.
   110
      */
   111
     @Override
   112
     public void stop() {
   113
       if (mapView != null) {
   114
         mapView.dispose();
   115
       }
   116
     }
   117
   
   118
   }

Get the geocode results with a geocode operation

An asynchronous geocode operation is required to find and return the location candidates for a given address and geocode parameters.

1. Create a new private method named performGeocode() that takes a String parameter for the address.

2. To find the location for a given address, call the LocatorTask.geocodeAsync() method on the locatorTask, providing the address string and geocodeParameters as parameters, and store the result in a local variable named geocodeResults. The result is an immutable list of GeocodeResult objects. In this tutorial, only one result will be returned, as the maximum results parameter was set to 1. Get the location result by calling an ListenableFuture.addDoneListener() on the geocodeResults. The result will be displayed visually in the next step.

   App.java

   106 collapsed lines
   2
   //   Copyright 2020 Esri
   3
   //   Licensed under the Apache License, Version 2.0 (the "License");
   4
   //   you may not use this file except in compliance with the License.
   5
   //   You may obtain a copy of the License at
   6
   //
   7
   //   http://www.apache.org/licenses/LICENSE-2.0
   8
   //
   9
   //   Unless required by applicable law or agreed to in writing, software
   10
   //   distributed under the License is distributed on an "AS IS" BASIS,
   11
   //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   12
   //   See the License for the specific language governing permissions and
   13
   //   limitations under the License.
   14
   
   15
   package com.example.app;
   16
   
   17
   import java.util.List;
   18
   import java.util.concurrent.ExecutionException;
   19
   
   20
   import javafx.geometry.Insets;
   21
   import javafx.geometry.Pos;
   22
   import javafx.scene.paint.Color;
   23
   import javafx.scene.control.Alert;
   24
   import javafx.scene.control.TextField;
   25
   
   26
   import com.esri.arcgisruntime.concurrent.ListenableFuture;
   27
   import com.esri.arcgisruntime.mapping.view.Graphic;
   28
   import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
   29
   import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
   30
   import com.esri.arcgisruntime.symbology.TextSymbol;
   31
   import com.esri.arcgisruntime.tasks.geocode.GeocodeParameters;
   32
   import com.esri.arcgisruntime.tasks.geocode.GeocodeResult;
   33
   import com.esri.arcgisruntime.tasks.geocode.LocatorTask;
   34
   
   35
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   36
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   37
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   38
   import com.esri.arcgisruntime.mapping.Viewpoint;
   39
   import com.esri.arcgisruntime.mapping.view.MapView;
   40
   
   41
   import javafx.application.Application;
   42
   import javafx.scene.Scene;
   43
   import javafx.scene.layout.StackPane;
   44
   import javafx.stage.Stage;
   45
   
   46
   public class App extends Application {
   47
   
   48
     private MapView mapView;
   49
   
   50
     private GeocodeParameters geocodeParameters;
   51
     private GraphicsOverlay graphicsOverlay;
   52
     private LocatorTask locatorTask;
   53
   
   54
     private TextField searchBox;
   55
   
   56
     public static void main(String[] args) {
   57
       Application.launch(args);
   58
     }
   59
   
   60
   
   61
     @Override
   62
     public void start(Stage stage) {
   63
   
   64
       // set the title and size of the stage and show it
   65
       stage.setTitle("Search for an address tutorial");
   66
       stage.setWidth(800);
   67
       stage.setHeight(700);
   68
       stage.show();
   69
       // create a JavaFX scene with a stack pane as the root node
   70
       // and add it to the scene
   71
   
   72
       StackPane stackPane = new StackPane();
   73
       Scene scene = new Scene(stackPane);
   74
       stage.setScene(scene);
   75
   
   76
       ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
   77
   
   78
       // create a map view to display the map and add it to the stack pane
   79
       mapView = new MapView();
   80
       stackPane.getChildren().add(mapView);
   81
   
   82
       ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   83
       // set the map on the map view
   84
       mapView.setMap(map);
   85
       mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572));
   86
   
   87
       // create a graphics overlay and add it to the map view
   88
       graphicsOverlay = new GraphicsOverlay();
   89
   
   90
       mapView.getGraphicsOverlays().add(graphicsOverlay);
   91
   
   92
       setupTextField();
   93
   
   94
       createLocatorTaskAndDefaultParameters();
   95
   
   96
       stackPane.getChildren().add(searchBox);
   97
       StackPane.setAlignment(searchBox, Pos.TOP_LEFT);
   98
       StackPane.setMargin(searchBox, new Insets(10, 0, 0, 10));
   99
   
   100
     }
   101
   
   102
     private void setupTextField() {
   103
       searchBox = new TextField();
   104
       searchBox.setMaxWidth(400);
   105
       searchBox.setPromptText("Search for an address");
   106
     }
   107
   
   108
     private void createLocatorTaskAndDefaultParameters() {
   109
       locatorTask = new LocatorTask("https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer");
   110
   
   111
       geocodeParameters = new GeocodeParameters();
   112
       geocodeParameters.getResultAttributeNames().add("*");
   113
       geocodeParameters.setMaxResults(1);
   114
       geocodeParameters.setOutputSpatialReference(mapView.getSpatialReference());
   115
     }
   116
   
   117
     private void performGeocode(String address) {
   118
       ListenableFuture<List<GeocodeResult>> geocodeResults = locatorTask.geocodeAsync(address, geocodeParameters);
   119
   
   120
       geocodeResults.addDoneListener(() -> {
   121
         try {
   122
           List<GeocodeResult> geocodes = geocodeResults.get();
   123
           if (geocodes.size() > 0) {
   124
             GeocodeResult result = geocodes.get(0);
   125
   
   126
           } else {
   127
             new Alert(Alert.AlertType.INFORMATION, "No results found.").show();
   128
           }
   129
         } catch (InterruptedException | ExecutionException e) {
   130
           new Alert(Alert.AlertType.ERROR, "Error getting result.").show();
   131
           e.printStackTrace();
   132
         }
   133
       });
   134
     }
   12 collapsed lines
   135
   
   136
     /**
   137
      * Stops and releases all resources used in application.
   138
      */
   139
     @Override
   140
     public void stop() {
   141
       if (mapView != null) {
   142
         mapView.dispose();
   143
       }
   144
     }
   145
   
   146
   }

Display the result

The result obtained from the geocode operation can be displayed by adding a graphic A graphic is a visual element composed of a geometry, symbol, and attributes that is displayed on a map or scene. Learn more to the map view’s graphics overlay A graphics overlay is a client-side, temporary container of graphics to display on a map view or scene view. Learn more .

1. Create a new private method taking a GeocodeResult (the result to be displayed on the map) as a parameter, and name it displayResult().

2. Within the method body, create and style two Graphic objects and add them to the graphicsOverlay. Use the geocodeResult’s label and display location to add one graphic showing the geocode result’s label text (the address), and another showing the geocode result’s location.

   App.java

   124 collapsed lines
   2
   //   Copyright 2020 Esri
   3
   //   Licensed under the Apache License, Version 2.0 (the "License");
   4
   //   you may not use this file except in compliance with the License.
   5
   //   You may obtain a copy of the License at
   6
   //
   7
   //   http://www.apache.org/licenses/LICENSE-2.0
   8
   //
   9
   //   Unless required by applicable law or agreed to in writing, software
   10
   //   distributed under the License is distributed on an "AS IS" BASIS,
   11
   //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   12
   //   See the License for the specific language governing permissions and
   13
   //   limitations under the License.
   14
   
   15
   package com.example.app;
   16
   
   17
   import java.util.List;
   18
   import java.util.concurrent.ExecutionException;
   19
   
   20
   import javafx.geometry.Insets;
   21
   import javafx.geometry.Pos;
   22
   import javafx.scene.paint.Color;
   23
   import javafx.scene.control.Alert;
   24
   import javafx.scene.control.TextField;
   25
   
   26
   import com.esri.arcgisruntime.concurrent.ListenableFuture;
   27
   import com.esri.arcgisruntime.mapping.view.Graphic;
   28
   import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
   29
   import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
   30
   import com.esri.arcgisruntime.symbology.TextSymbol;
   31
   import com.esri.arcgisruntime.tasks.geocode.GeocodeParameters;
   32
   import com.esri.arcgisruntime.tasks.geocode.GeocodeResult;
   33
   import com.esri.arcgisruntime.tasks.geocode.LocatorTask;
   34
   
   35
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   36
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   37
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   38
   import com.esri.arcgisruntime.mapping.Viewpoint;
   39
   import com.esri.arcgisruntime.mapping.view.MapView;
   40
   
   41
   import javafx.application.Application;
   42
   import javafx.scene.Scene;
   43
   import javafx.scene.layout.StackPane;
   44
   import javafx.stage.Stage;
   45
   
   46
   public class App extends Application {
   47
   
   48
     private MapView mapView;
   49
   
   50
     private GeocodeParameters geocodeParameters;
   51
     private GraphicsOverlay graphicsOverlay;
   52
     private LocatorTask locatorTask;
   53
   
   54
     private TextField searchBox;
   55
   
   56
     public static void main(String[] args) {
   57
       Application.launch(args);
   58
     }
   59
   
   60
   
   61
     @Override
   62
     public void start(Stage stage) {
   63
   
   64
       // set the title and size of the stage and show it
   65
       stage.setTitle("Search for an address tutorial");
   66
       stage.setWidth(800);
   67
       stage.setHeight(700);
   68
       stage.show();
   69
       // create a JavaFX scene with a stack pane as the root node
   70
       // and add it to the scene
   71
   
   72
       StackPane stackPane = new StackPane();
   73
       Scene scene = new Scene(stackPane);
   74
       stage.setScene(scene);
   75
   
   76
       ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
   77
   
   78
       // create a map view to display the map and add it to the stack pane
   79
       mapView = new MapView();
   80
       stackPane.getChildren().add(mapView);
   81
   
   82
       ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   83
       // set the map on the map view
   84
       mapView.setMap(map);
   85
       mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572));
   86
   
   87
       // create a graphics overlay and add it to the map view
   88
       graphicsOverlay = new GraphicsOverlay();
   89
   
   90
       mapView.getGraphicsOverlays().add(graphicsOverlay);
   91
   
   92
       setupTextField();
   93
   
   94
       createLocatorTaskAndDefaultParameters();
   95
   
   96
       stackPane.getChildren().add(searchBox);
   97
       StackPane.setAlignment(searchBox, Pos.TOP_LEFT);
   98
       StackPane.setMargin(searchBox, new Insets(10, 0, 0, 10));
   99
   
   100
     }
   101
   
   102
     private void setupTextField() {
   103
       searchBox = new TextField();
   104
       searchBox.setMaxWidth(400);
   105
       searchBox.setPromptText("Search for an address");
   106
     }
   107
   
   108
     private void createLocatorTaskAndDefaultParameters() {
   109
       locatorTask = new LocatorTask("https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer");
   110
   
   111
       geocodeParameters = new GeocodeParameters();
   112
       geocodeParameters.getResultAttributeNames().add("*");
   113
       geocodeParameters.setMaxResults(1);
   114
       geocodeParameters.setOutputSpatialReference(mapView.getSpatialReference());
   115
     }
   116
   
   117
     private void performGeocode(String address) {
   118
       ListenableFuture<List<GeocodeResult>> geocodeResults = locatorTask.geocodeAsync(address, geocodeParameters);
   119
   
   120
       geocodeResults.addDoneListener(() -> {
   121
         try {
   122
           List<GeocodeResult> geocodes = geocodeResults.get();
   123
           if (geocodes.size() > 0) {
   124
             GeocodeResult result = geocodes.get(0);
   125
   
   126
           } else {
   127
             new Alert(Alert.AlertType.INFORMATION, "No results found.").show();
   128
           }
   129
         } catch (InterruptedException | ExecutionException e) {
   130
           new Alert(Alert.AlertType.ERROR, "Error getting result.").show();
   131
           e.printStackTrace();
   132
         }
   133
       });
   134
     }
   135
   
   136
     private void displayResult(GeocodeResult geocodeResult) {
   137
       graphicsOverlay.getGraphics().clear(); // clears the overlay of any previous result
   138
   
   139
       // create a graphic to display the address text
   140
       String label = geocodeResult.getLabel();
   141
       TextSymbol textSymbol = new TextSymbol(18, label, Color.BLACK, TextSymbol.HorizontalAlignment.CENTER, TextSymbol.VerticalAlignment.BOTTOM);
   142
       Graphic textGraphic = new Graphic(geocodeResult.getDisplayLocation(), textSymbol);
   143
       graphicsOverlay.getGraphics().add(textGraphic);
   144
   
   145
       // create a graphic to display the location as a red square
   146
       SimpleMarkerSymbol markerSymbol = new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.SQUARE, Color.RED, 12.0f);
   147
       Graphic markerGraphic = new Graphic(geocodeResult.getDisplayLocation(), geocodeResult.getAttributes(), markerSymbol);
   148
       graphicsOverlay.getGraphics().add(markerGraphic);
   149
   
   150
       mapView.setViewpointCenterAsync(geocodeResult.getDisplayLocation());
   151
     }
   12 collapsed lines
   152
   
   153
     /**
   154
      * Stops and releases all resources used in application.
   155
      */
   156
     @Override
   157
     public void stop() {
   158
       if (mapView != null) {
   159
         mapView.dispose();
   160
       }
   161
     }
   162
   
   163
   }

3. In the performGeocode() method, in the lambda expression body, call the displayResult() method, passing in result as the parameter. This will display the result of the geocode operation on the map.

   App.java

   118 collapsed lines
   2
   //   Copyright 2020 Esri
   3
   //   Licensed under the Apache License, Version 2.0 (the "License");
   4
   //   you may not use this file except in compliance with the License.
   5
   //   You may obtain a copy of the License at
   6
   //
   7
   //   http://www.apache.org/licenses/LICENSE-2.0
   8
   //
   9
   //   Unless required by applicable law or agreed to in writing, software
   10
   //   distributed under the License is distributed on an "AS IS" BASIS,
   11
   //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   12
   //   See the License for the specific language governing permissions and
   13
   //   limitations under the License.
   14
   
   15
   package com.example.app;
   16
   
   17
   import java.util.List;
   18
   import java.util.concurrent.ExecutionException;
   19
   
   20
   import javafx.geometry.Insets;
   21
   import javafx.geometry.Pos;
   22
   import javafx.scene.paint.Color;
   23
   import javafx.scene.control.Alert;
   24
   import javafx.scene.control.TextField;
   25
   
   26
   import com.esri.arcgisruntime.concurrent.ListenableFuture;
   27
   import com.esri.arcgisruntime.mapping.view.Graphic;
   28
   import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
   29
   import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
   30
   import com.esri.arcgisruntime.symbology.TextSymbol;
   31
   import com.esri.arcgisruntime.tasks.geocode.GeocodeParameters;
   32
   import com.esri.arcgisruntime.tasks.geocode.GeocodeResult;
   33
   import com.esri.arcgisruntime.tasks.geocode.LocatorTask;
   34
   
   35
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   36
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   37
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   38
   import com.esri.arcgisruntime.mapping.Viewpoint;
   39
   import com.esri.arcgisruntime.mapping.view.MapView;
   40
   
   41
   import javafx.application.Application;
   42
   import javafx.scene.Scene;
   43
   import javafx.scene.layout.StackPane;
   44
   import javafx.stage.Stage;
   45
   
   46
   public class App extends Application {
   47
   
   48
     private MapView mapView;
   49
   
   50
     private GeocodeParameters geocodeParameters;
   51
     private GraphicsOverlay graphicsOverlay;
   52
     private LocatorTask locatorTask;
   53
   
   54
     private TextField searchBox;
   55
   
   56
     public static void main(String[] args) {
   57
       Application.launch(args);
   58
     }
   59
   
   60
   
   61
     @Override
   62
     public void start(Stage stage) {
   63
   
   64
       // set the title and size of the stage and show it
   65
       stage.setTitle("Search for an address tutorial");
   66
       stage.setWidth(800);
   67
       stage.setHeight(700);
   68
       stage.show();
   69
       // create a JavaFX scene with a stack pane as the root node
   70
       // and add it to the scene
   71
   
   72
       StackPane stackPane = new StackPane();
   73
       Scene scene = new Scene(stackPane);
   74
       stage.setScene(scene);
   75
   
   76
       ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
   77
   
   78
       // create a map view to display the map and add it to the stack pane
   79
       mapView = new MapView();
   80
       stackPane.getChildren().add(mapView);
   81
   
   82
       ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   83
       // set the map on the map view
   84
       mapView.setMap(map);
   85
       mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572));
   86
   
   87
       // create a graphics overlay and add it to the map view
   88
       graphicsOverlay = new GraphicsOverlay();
   89
   
   90
       mapView.getGraphicsOverlays().add(graphicsOverlay);
   91
   
   92
       setupTextField();
   93
   
   94
       createLocatorTaskAndDefaultParameters();
   95
   
   96
       stackPane.getChildren().add(searchBox);
   97
       StackPane.setAlignment(searchBox, Pos.TOP_LEFT);
   98
       StackPane.setMargin(searchBox, new Insets(10, 0, 0, 10));
   99
   
   100
     }
   101
   
   102
     private void setupTextField() {
   103
       searchBox = new TextField();
   104
       searchBox.setMaxWidth(400);
   105
       searchBox.setPromptText("Search for an address");
   106
     }
   107
   
   108
     private void createLocatorTaskAndDefaultParameters() {
   109
       locatorTask = new LocatorTask("https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer");
   110
   
   111
       geocodeParameters = new GeocodeParameters();
   112
       geocodeParameters.getResultAttributeNames().add("*");
   113
       geocodeParameters.setMaxResults(1);
   114
       geocodeParameters.setOutputSpatialReference(mapView.getSpatialReference());
   115
     }
   116
   
   117
     private void performGeocode(String address) {
   118
       ListenableFuture<List<GeocodeResult>> geocodeResults = locatorTask.geocodeAsync(address, geocodeParameters);
   119
   
   120
       geocodeResults.addDoneListener(() -> {
   121
         try {
   122
           List<GeocodeResult> geocodes = geocodeResults.get();
   123
           if (geocodes.size() > 0) {
   124
             GeocodeResult result = geocodes.get(0);
   125
   
   126
             displayResult(result);
   39 collapsed lines
   127
   
   128
           } else {
   129
             new Alert(Alert.AlertType.INFORMATION, "No results found.").show();
   130
           }
   131
         } catch (InterruptedException | ExecutionException e) {
   132
           new Alert(Alert.AlertType.ERROR, "Error getting result.").show();
   133
           e.printStackTrace();
   134
         }
   135
       });
   136
     }
   137
   
   138
     private void displayResult(GeocodeResult geocodeResult) {
   139
       graphicsOverlay.getGraphics().clear(); // clears the overlay of any previous result
   140
   
   141
       // create a graphic to display the address text
   142
       String label = geocodeResult.getLabel();
   143
       TextSymbol textSymbol = new TextSymbol(18, label, Color.BLACK, TextSymbol.HorizontalAlignment.CENTER, TextSymbol.VerticalAlignment.BOTTOM);
   144
       Graphic textGraphic = new Graphic(geocodeResult.getDisplayLocation(), textSymbol);
   145
       graphicsOverlay.getGraphics().add(textGraphic);
   146
   
   147
       // create a graphic to display the location as a red square
   148
       SimpleMarkerSymbol markerSymbol = new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.SQUARE, Color.RED, 12.0f);
   149
       Graphic markerGraphic = new Graphic(geocodeResult.getDisplayLocation(), geocodeResult.getAttributes(), markerSymbol);
   150
       graphicsOverlay.getGraphics().add(markerGraphic);
   151
   
   152
       mapView.setViewpointCenterAsync(geocodeResult.getDisplayLocation());
   153
     }
   154
   
   155
     /**
   156
      * Stops and releases all resources used in application.
   157
      */
   158
     @Override
   159
     public void stop() {
   160
       if (mapView != null) {
   161
         mapView.dispose();
   162
       }
   163
     }
   164
   
   165
   }

4. In the start() method, set an action on the searchBox to get the input text. Get the text from the search box and call performGeocode(), passing in the text as the parameter.

   App.java

   92 collapsed lines
   2
   //   Copyright 2020 Esri
   3
   //   Licensed under the Apache License, Version 2.0 (the "License");
   4
   //   you may not use this file except in compliance with the License.
   5
   //   You may obtain a copy of the License at
   6
   //
   7
   //   http://www.apache.org/licenses/LICENSE-2.0
   8
   //
   9
   //   Unless required by applicable law or agreed to in writing, software
   10
   //   distributed under the License is distributed on an "AS IS" BASIS,
   11
   //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   12
   //   See the License for the specific language governing permissions and
   13
   //   limitations under the License.
   14
   
   15
   package com.example.app;
   16
   
   17
   import java.util.List;
   18
   import java.util.concurrent.ExecutionException;
   19
   
   20
   import javafx.geometry.Insets;
   21
   import javafx.geometry.Pos;
   22
   import javafx.scene.paint.Color;
   23
   import javafx.scene.control.Alert;
   24
   import javafx.scene.control.TextField;
   25
   
   26
   import com.esri.arcgisruntime.concurrent.ListenableFuture;
   27
   import com.esri.arcgisruntime.mapping.view.Graphic;
   28
   import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
   29
   import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
   30
   import com.esri.arcgisruntime.symbology.TextSymbol;
   31
   import com.esri.arcgisruntime.tasks.geocode.GeocodeParameters;
   32
   import com.esri.arcgisruntime.tasks.geocode.GeocodeResult;
   33
   import com.esri.arcgisruntime.tasks.geocode.LocatorTask;
   34
   
   35
   import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
   36
   import com.esri.arcgisruntime.mapping.ArcGISMap;
   37
   import com.esri.arcgisruntime.mapping.BasemapStyle;
   38
   import com.esri.arcgisruntime.mapping.Viewpoint;
   39
   import com.esri.arcgisruntime.mapping.view.MapView;
   40
   
   41
   import javafx.application.Application;
   42
   import javafx.scene.Scene;
   43
   import javafx.scene.layout.StackPane;
   44
   import javafx.stage.Stage;
   45
   
   46
   public class App extends Application {
   47
   
   48
     private MapView mapView;
   49
   
   50
     private GeocodeParameters geocodeParameters;
   51
     private GraphicsOverlay graphicsOverlay;
   52
     private LocatorTask locatorTask;
   53
   
   54
     private TextField searchBox;
   55
   
   56
     public static void main(String[] args) {
   57
       Application.launch(args);
   58
     }
   59
   
   60
   
   61
     @Override
   62
     public void start(Stage stage) {
   63
   
   64
       // set the title and size of the stage and show it
   65
       stage.setTitle("Search for an address tutorial");
   66
       stage.setWidth(800);
   67
       stage.setHeight(700);
   68
       stage.show();
   69
       // create a JavaFX scene with a stack pane as the root node
   70
       // and add it to the scene
   71
   
   72
       StackPane stackPane = new StackPane();
   73
       Scene scene = new Scene(stackPane);
   74
       stage.setScene(scene);
   75
   
   76
       ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
   77
   
   78
       // create a map view to display the map and add it to the stack pane
   79
       mapView = new MapView();
   80
       stackPane.getChildren().add(mapView);
   81
   
   82
       ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
   83
       // set the map on the map view
   84
       mapView.setMap(map);
   85
       mapView.setViewpoint(new Viewpoint(34.02700, -118.80543, 144447.638572));
   86
   
   87
       // create a graphics overlay and add it to the map view
   88
       graphicsOverlay = new GraphicsOverlay();
   89
   
   90
       mapView.getGraphicsOverlays().add(graphicsOverlay);
   91
   
   92
       setupTextField();
   93
   
   94
       createLocatorTaskAndDefaultParameters();
   95
   
   96
       searchBox.setOnAction(event -> {
   97
         String address = searchBox.getText();
   98
         if (!address.isBlank()) {
   99
           performGeocode(address);
   100
         }
   101
       });
   71 collapsed lines
   102
   
   103
       stackPane.getChildren().add(searchBox);
   104
       StackPane.setAlignment(searchBox, Pos.TOP_LEFT);
   105
       StackPane.setMargin(searchBox, new Insets(10, 0, 0, 10));
   106
   
   107
     }
   108
   
   109
     private void setupTextField() {
   110
       searchBox = new TextField();
   111
       searchBox.setMaxWidth(400);
   112
       searchBox.setPromptText("Search for an address");
   113
     }
   114
   
   115
     private void createLocatorTaskAndDefaultParameters() {
   116
       locatorTask = new LocatorTask("https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer");
   117
   
   118
       geocodeParameters = new GeocodeParameters();
   119
       geocodeParameters.getResultAttributeNames().add("*");
   120
       geocodeParameters.setMaxResults(1);
   121
       geocodeParameters.setOutputSpatialReference(mapView.getSpatialReference());
   122
     }
   123
   
   124
     private void performGeocode(String address) {
   125
       ListenableFuture<List<GeocodeResult>> geocodeResults = locatorTask.geocodeAsync(address, geocodeParameters);
   126
   
   127
       geocodeResults.addDoneListener(() -> {
   128
         try {
   129
           List<GeocodeResult> geocodes = geocodeResults.get();
   130
           if (geocodes.size() > 0) {
   131
             GeocodeResult result = geocodes.get(0);
   132
   
   133
             displayResult(result);
   134
   
   135
           } else {
   136
             new Alert(Alert.AlertType.INFORMATION, "No results found.").show();
   137
           }
   138
         } catch (InterruptedException | ExecutionException e) {
   139
           new Alert(Alert.AlertType.ERROR, "Error getting result.").show();
   140
           e.printStackTrace();
   141
         }
   142
       });
   143
     }
   144
   
   145
     private void displayResult(GeocodeResult geocodeResult) {
   146
       graphicsOverlay.getGraphics().clear(); // clears the overlay of any previous result
   147
   
   148
       // create a graphic to display the address text
   149
       String label = geocodeResult.getLabel();
   150
       TextSymbol textSymbol = new TextSymbol(18, label, Color.BLACK, TextSymbol.HorizontalAlignment.CENTER, TextSymbol.VerticalAlignment.BOTTOM);
   151
       Graphic textGraphic = new Graphic(geocodeResult.getDisplayLocation(), textSymbol);
   152
       graphicsOverlay.getGraphics().add(textGraphic);
   153
   
   154
       // create a graphic to display the location as a red square
   155
       SimpleMarkerSymbol markerSymbol = new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.SQUARE, Color.RED, 12.0f);
   156
       Graphic markerGraphic = new Graphic(geocodeResult.getDisplayLocation(), geocodeResult.getAttributes(), markerSymbol);
   157
       graphicsOverlay.getGraphics().add(markerGraphic);
   158
   
   159
       mapView.setViewpointCenterAsync(geocodeResult.getDisplayLocation());
   160
     }
   161
   
   162
     /**
   163
      * Stops and releases all resources used in application.
   164
      */
   165
     @Override
   166
     public void stop() {
   167
       if (mapView != null) {
   168
         mapView.dispose();
   169
       }
   170
     }
   171
   
   172
   }

5. Run the app. Ensure to run the app as a Gradle task and not as an application in your IDE. In the Gradle tool window, under Tasks > application, double-click run.

You should see a search box on the top left of the map. Search for an address by entering an address and press Return on the keyboard. The result of the search should display on the map as a red square.

What’s next?

Learn how to use additional API features, ArcGIS location services, and ArcGIS tools in these tutorials:

• Find a route and directions
• Add a point, line, and polygon