Search for an address

Learn how to find an address or place with a search bar and the geocoding service.

Geocoding is the process of converting address or place text into a location. The geocoding service can search for an address or a place and perform reverse geocoding.

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

Prerequisites

The following are required for this tutorial:

An ArcGIS account to access API keys. If you don't have an account, sign up for free.
A development and deployment environment that meets the system requirements.
An IDE for Android development in Kotlin.

Steps

Open an Android Studio project

To start this tutorial, complete the Display a map tutorial. Or download and unzip the Display a map solution in a new folder.
Modify the old project for use in this new tutorial. Expand More info for instructions.
1. On your file system, delete the .idea folder, if present, at the top level of your project.
2. In the Android tool window, open app > res > values > strings.xml.
  
  In the <string name="app_name"> element, change the text content to Search for an address.
  strings.xml
  Use dark colors for code blocks
  1 2 3 4 4 4 5
  Change line
  1 2 3 4 5 6 7 <resources> <string name="app_name">Search for an address</string> </resources>
3. Create a <string name ="search_hint"> element to define the default text that initially shows in the search field.
  strings.xml
  Use dark colors for code blocks
  1 2 3 4 5 6 7
  Add line.
  1 2 3 4 5 6 7 <resources> <string name="app_name">Search for an address</string> <string name="search_hint">Search for an address</string> </resources>
4. In the Android tool window, open Gradle Scripts > settings.gradle.
  
  Change the value of rootProject.name to "Search for an address".
  settings.gradle
  Expand
  Use dark colors for code blocks
  20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 20 21 22 23
  Change line
  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 rootProject.name = "Search for an address" include ':app'
5. Click File > Sync Project with Gradle files. Android Studio will recognize your changes and create a new .idea folder.

If you downloaded the solution project, set your API key.

An API Key enables access to services, web maps, and web scenes hosted in ArcGIS Online.

Go to your developer dashboard to get your API key. For these tutorials, use your default API key. It is scoped to include all of the services demonstrated in the tutorials.
In Android Studio: in the Android tool window, open app > java > com.example.app > MainActivity.

In the setApiKey() function, find the ApiKey.create() call and paste your API key inside the quotes, replacing YOUR_API_KEY.

MainActivity.kt
Use dark colors for code blocks
    private fun setApiKey() {
        // It is not best practice to store API keys in source code. We have you insert one here
        // to streamline this tutorial.

        ArcGISEnvironment.apiKey = ApiKey.create("YOUR_API_KEY")

    }

Add import statements

Modify import statements to reference the packages and classes required for this tutorial.

In Android Studio, in the Android tool window, open app > java > com.example.app > MainActivity.

Replace app-specific import statements with the imports needed for this tutorial.

MainActivity.kt
Use dark colors for code blocks
Change lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange lineChange linepackage com.example.app

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity

import android.util.Log
import android.widget.SearchView
import android.widget.Toast
import androidx.databinding.DataBindingUtil
import androidx.lifecycle.lifecycleScope

import com.arcgismaps.ApiKey
import com.arcgismaps.ArcGISEnvironment
import com.arcgismaps.Color
import com.arcgismaps.mapping.ArcGISMap
import com.arcgismaps.mapping.BasemapStyle
import com.arcgismaps.mapping.Viewpoint
import com.arcgismaps.mapping.symbology.HorizontalAlignment
import com.arcgismaps.mapping.symbology.SimpleMarkerSymbol
import com.arcgismaps.mapping.symbology.SimpleMarkerSymbolStyle
import com.arcgismaps.mapping.symbology.TextSymbol
import com.arcgismaps.mapping.symbology.VerticalAlignment
import com.arcgismaps.mapping.view.Graphic
import com.arcgismaps.mapping.view.GraphicsOverlay
import com.arcgismaps.mapping.view.MapView
import com.arcgismaps.tasks.geocode.GeocodeParameters
import com.arcgismaps.tasks.geocode.GeocodeResult
import com.arcgismaps.tasks.geocode.LocatorTask

import com.example.app.databinding.ActivityMainBinding
import kotlinx.coroutines.launch

Declare graphics overlay and locator task and initialize map view

A graphics overlay is a container for graphics. A locator task converts an address to a point. You will create the properties graphicsOverlay and locatorTask for use later in later steps. Next you will initialize the mapView.

In the MainActivitymethod, create a lazy property named graphicsOverlay that references a new GraphicsOverlay for storing geocode result graphics (address location and label).

Since graphicsOverlay is a lazy property, a GraphicsOverlay will not be created until the property is initialized, which occurs in the setupMap() method that you will modify shortly.

MainActivity.kt
Expand
Use dark colors for code blocks
Add line.Add line.Add line.class MainActivity : AppCompatActivity() {

    private val activityMainBinding: ActivityMainBinding by lazy {
        DataBindingUtil.setContentView(this, R.layout.activity_main)
    }

    private val mapView: MapView by lazy {
        activityMainBinding.mapView
    }

    private val graphicsOverlay: GraphicsOverlay by lazy {
        GraphicsOverlay()
    }

Expand

Create a property named locatorTask that references a new LocatorTask for geocoding an address.

MainActivity.kt
Expand
Use dark colors for code blocks
Add line.Add line.class MainActivity : AppCompatActivity() {

    private val activityMainBinding: ActivityMainBinding by lazy {
        DataBindingUtil.setContentView(this, R.layout.activity_main)
    }

    private val mapView: MapView by lazy {
        activityMainBinding.mapView
    }

    private val graphicsOverlay: GraphicsOverlay by lazy {
        GraphicsOverlay()
    }

    private val geocodeServerUri = "https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer"
    private val locatorTask = LocatorTask(geocodeServerUri)
Expand

At the end of the setupMap method, initialize the mapView by calling the scope function apply and passing a lambda expression that does the following:

Assigns the local variable topographicMap to the map property
Creates a Viewpoint and passes it to setViewpoint()
Adds graphicsOverlay to the GeoView.graphicsOverlays collection.

Declared at the start of the MainActivity class, the lazy property graphicsOverlay is initialized at its first access, which is in this lambda expression. The new GraphicsOverlay is not created until now.

MainActivity.kt
Expand
Use dark colors for code blocks
Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.    // Set up your map here. You will call this method from onCreate().
    private fun setupMap() {
        lifecycle.addObserver(mapView)
        // create a map with the BasemapStyle topographic
        val topographicMap = ArcGISMap(BasemapStyle.ArcGISTopographic)

        mapView.apply {
            // set the map to be displayed in the layout's MapView
            map = topographicMap

            // set the viewpoint, Viewpoint(latitude, longitude, scale)
            setViewpoint(Viewpoint(34.0270, -118.8050, 72000.0))

            graphicsOverlays.add(graphicsOverlay)
        }

    }
Expand

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.

In activity_main.xml, add a SearchView element. This widget will display a search text field at the top of the app window.

activity_main.xml
Expand
Use dark colors for code blocks
Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.<layout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools">
    <androidx.constraintlayout.widget.ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        tools:context=".MainActivity">

        <SearchView
                android:id="@+id/searchView"
                android:layout_width="0dp"
                android:layout_height="0dp"
                android:queryHint="@string/search_hint"
                app:layout_constraintBottom_toTopOf="@+id/guideline"
                app:layout_constraintEnd_toEndOf="parent"
                app:layout_constraintStart_toStartOf="parent"
                app:layout_constraintTop_toTopOf="parent" />
Expand

In MainActivity.kt, create a setupSearchViewListener() method to handle user activity by changing the current address in the search field and submitting the search. In the first line, get the bound searchView with activityMainBinding.searchView. Then call setOnQueryTextListener() and pass an anonymous class that implements the SearchView.OnQueryTextListener interface.

MainActivity.kt
Expand
Use dark colors for code blocks
Add line.Add line.Add line.Add line.Add line.Add line.    private fun setupSearchViewListener() {

        activityMainBinding.searchView.setOnQueryTextListener(object : SearchView.OnQueryTextListener {

        })
    }
Expand

Implement the two methods of the SearchView.OnQueryTextListener interface: onQueryTextChange() and onQueryTextSubmit().

Returning false specifies the standard Android behavior.

MainActivity.kt
Expand
Use dark colors for code blocks
Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.    private fun setupSearchViewListener() {

        activityMainBinding.searchView.setOnQueryTextListener(object : SearchView.OnQueryTextListener {

            override fun onQueryTextChange(newText: String): Boolean {
                return false
            }

            override fun onQueryTextSubmit(query: String): Boolean {

                return false
            }

        })
    }
Expand

In the onCreate() lifecycle method, add a setupSearchViewListener() call.

MainActivity.kt
Expand
Use dark colors for code blocks
Add line.    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        setApiKeyForApp()

        setupMap()

        setupSearchViewListener()

    }
Expand

Create a function to geocode an address

Geocoding is implemented with a locator, typically created by referencing a service such as the geocoding service or, for offline geocoding, by referencing locator data contained in a mobile package. Geocoding parameters can be used to refine the results, such as setting a maximum number of results or requesting additional attributes in the results.

Create a method named performGeocode().
Create a new GraphicsOverlay and initialize it by calling the scope function apply and passing a lambda expression that does the following:
- Adds the names of result attributes to the GeocodeParameters.resultAttributeNames collection. These are the names of attributes to be returned. An asterisk (*) indicates all attributes.
- Sets GeocodeParameters.maxResults to the maximum number of results to be returned. Results are ordered by score, so that the first result has the best match score (ranging from 0 for no match to 100 for the best match).
- Sets GeocodeParameters.outputSpatialReference to the spatial reference for result locations. By default, the output spatial reference is defined by the geocode service. For optimal performance when displaying the geocode result, you can ensure that returned coordinates match those of the map view by providing the map view's spatial reference.
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. For a list of attributes returned with geocode results, see Geocoding service output in the ArcGIS services reference.
MainActivity.kt
Expand
Use dark colors for code blocks
119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 119 118 117 117 117 117 117 117 117 118 119 120 121 122 123 124 125 125 125 125 125 125 125 125 125 125 125 125 125 125 126 127 127 126 125 124 123 122 121 120 119 118 117 116 115 114 113 112 111 110 109 108 107 106 105 104 103 102 101 100 99 98 97 96 95 94 93 92 91 90 89 88 87 86 85 84 83 82 81 80 80 80 80 80 80 80
Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.
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 private fun performGeocode(query: String) { val geocodeParameters = GeocodeParameters().apply { resultAttributeNames.add("*") maxResults = 1 outputSpatialReference = mapView.spatialReference.value } } }
Expand

To find the location for the provided address, call LocatorTask.geocode(), passing the query (the address to find) and the geocodeParameters. Since geocode()is a suspend function, we call it from a a coroutine scope, created with lifecycleScope.launch().

MainActivity.kt
Expand
Use dark colors for code blocks
Add line.Add line.    private fun performGeocode(query: String) {

        val geocodeParameters = GeocodeParameters().apply {
            resultAttributeNames.add("*")
            maxResults = 1
            outputSpatialReference = mapView.spatialReference.value
        }

        lifecycleScope.launch {
            locatorTask.geocode(query, geocodeParameters)

        }
    }
Expand

The LocatorTask.geocode() function returns a Result<List<GeocodeResult>>, on which we call .onSuccess and pass a lambda. In the lambda, check that the list of GeocodeResults is not empty and then call displayResult(geocodeResults[0]) to display the first item in the list. In this tutorial, the maximum results parameter was set to 1, so you pass the first and only item in the geocodeResult list.

MainActivity.kt
Expand
Use dark colors for code blocks
Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.    private fun performGeocode(query: String) {

        val geocodeParameters = GeocodeParameters().apply {
            resultAttributeNames.add("*")
            maxResults = 1
            outputSpatialReference = mapView.spatialReference.value
        }

        lifecycleScope.launch {
            locatorTask.geocode(query, geocodeParameters)

                .onSuccess { geocodeResults: List<GeocodeResult> ->
                        if (geocodeResults.isNotEmpty()) {
                            displayResult(geocodeResults[0])
                        } else {
                            showError("No address found for the given query.")
                        }
                }.onFailure { error ->
                    showError("The locatorTask.geocode() call failed. " + error.message)
                }

        }
    }
Expand

In the setupSearchViewListener() method, find the onQueryTextSubmit() method of the SearchView.OnQueryTextListener interface, and call performGeoCode(query).

MainActivity.kt
Expand
Use dark colors for code blocks
Add line.    private fun setupSearchViewListener() {

        activityMainBinding.searchView.setOnQueryTextListener(object : SearchView.OnQueryTextListener {

            override fun onQueryTextChange(newText: String): Boolean {
                return false
            }

            override fun onQueryTextSubmit(query: String): Boolean {

                performGeocode(query)

                return false
            }

        })
    }
Expand

Display the result

The result obtained from the geocode operation can be displayed by adding two graphics to the map view's graphics overlay: one graphic showing the address text and the other showing a red location marker.

Create a method named displayResult() and clear the graphics overlay of any previous result.

MainActivity.kt
Expand
Use dark colors for code blocks
Add line.Add line.    private fun displayResult(geocodeResult: GeocodeResult) {

        // clear the overlay of any previous result
        graphicsOverlay.graphics.clear()

    }
Expand

Create a TextSymbol for displaying the address text on the map. Then create a Graphic, passing the geocodeResult.displayLocation (the location on the map) and the textSymbol. Finally, add the graphic to the graphicsOverlay collection.

MainActivity.kt
Expand
Use dark colors for code blocks
Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.    private fun displayResult(geocodeResult: GeocodeResult) {

        // clear the overlay of any previous result
        graphicsOverlay.graphics.clear()

        // create a graphic to display the address text, and add styling to make it visually distinct