Offline geocode

View on GitHub
Sample viewer app

Geocode addresses to locations and reverse geocode locations to addresses offline.

Image of offline geocode

Use case

You can use an address locator file to geocode addresses and locations. For example, you could provide offline geocoding capabilities to field workers repairing critical infrastructure in a disaster when network availability is limited.

How to use the sample

Select an address from the drop-down list to geocode the address and view the result on the map. Click the location you want to reverse geocode. Click on the pin to highlight it and then move the mouse to perform reverse geocoding in real-time.

How it works

  1. Use the path of a .loc file to create a LocatorTask object.
  2. Set up GeocodeParameters and call GeocodeAsync to get geocode results.

Relevant API

  • GeocodeParameters
  • GeocodeResult
  • LocatorTask
  • ReverseGeocodeParameters

Tags

geocode, geocoder, locator, offline, package, query, search

Sample Code

OfflineGeocodeSample.java
                                                                                                                                                                                                                                                                                                                                                                                                
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
/*
 * 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.offline_geocode;

import java.io.File;
import java.util.HashMap;
import java.util.List;

import javafx.application.Application;
import javafx.application.Platform;
import javafx.event.EventHandler;
import javafx.geometry.Insets;
import javafx.geometry.Point2D;
import javafx.geometry.Pos;
import javafx.scene.Scene;
import javafx.scene.control.Alert;
import javafx.scene.control.ComboBox;
import javafx.scene.image.Image;
import javafx.scene.input.MouseButton;
import javafx.scene.input.MouseEvent;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;
import javafx.util.Duration;

import com.esri.arcgisruntime.concurrent.ListenableFuture;
import com.esri.arcgisruntime.data.TileCache;
import com.esri.arcgisruntime.geometry.Point;
import com.esri.arcgisruntime.layers.ArcGISTiledLayer;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.Basemap;
import com.esri.arcgisruntime.mapping.view.Callout;
import com.esri.arcgisruntime.mapping.view.Callout.LeaderPosition;
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.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.ReverseGeocodeParameters;

public class OfflineGeocodeSample extends Application {

  private MapView mapView;
  private ArcGISTiledLayer tiledLayer;
  private LocatorTask locatorTask;
  private GeocodeParameters geocodeParameters;
  private ReverseGeocodeParameters reverseGeocodeParameters;
  private GraphicsOverlay graphicsOverlay;
  private PictureMarkerSymbol pinSymbol;
  private ComboBox<String> searchBox;
  private ListenableFuture<IdentifyGraphicsOverlayResult> identifyResults;
  private boolean realtimeMode = false;

  @Override
  public void start(Stage stage) {

    try {
      // create stack pane and application scene
      StackPane stackPane = new StackPane();
      Scene scene = new Scene(stackPane);

      // set title, size, and add scene to stage
      stage.setTitle("Offline Geocode Sample");
      stage.setWidth(800);
      stage.setHeight(700);
      stage.setScene(scene);
      stage.show();

      // create search box
      searchBox = new ComboBox<>();
      searchBox.setPromptText("Search");
      searchBox.setEditable(true);
      searchBox.setMaxWidth(260.0);

      // add example address suggestions
      String[] recent = {
          "1455 Market St, San Francisco, CA 94103", "2011 Mission St, San Francisco  CA  94110",
          "820 Bryant St, San Francisco  CA  94103", "1 Zoo Rd, San Francisco, 944132",
          "1201 Mason Street, San Francisco, CA 94108", "151 Third Street, San Francisco, CA 94103",
          "1050 Lombard Street, San Francisco, CA 94109"
      };
      searchBox.getItems().addAll(recent);

      // event to get geocode when query is submitted
      searchBox.setOnAction((e) -> {

        // get the user's query
        String query;
        if (searchBox.getSelectionModel().getSelectedIndex() == -1) {
          // user supplied their own query
          query = searchBox.getEditor().getText();
        } else {
          // user chose a suggested query
          query = searchBox.getSelectionModel().getSelectedItem();
        }

        if (!query.equals("")) {
          // hide callout if showing
          mapView.getCallout().dismiss();

          // run the locatorTask geocode task
          ListenableFuture<List<GeocodeResult>> results = locatorTask.geocodeAsync(query, geocodeParameters);

          // add a listener to display the result when loaded
          results.addDoneListener(new ResultsLoadedListener(results));
        }
      });

      // create a basemap from a local tile package
      File tpkFile = new File(System.getProperty("data.dir"), "./samples-data/sanfrancisco/SanFrancisco.tpk");
      TileCache tileCache = new TileCache(tpkFile.getAbsolutePath());
      tiledLayer = new ArcGISTiledLayer(tileCache);
      Basemap basemap = new Basemap(tiledLayer);

      // create ArcGISMap with imagery basemap
      ArcGISMap map = new ArcGISMap(basemap);

      // create a view and set ArcGISMap to it
      mapView = new MapView();
      mapView.setMap(map);

      // add a graphics overlay
      graphicsOverlay = new GraphicsOverlay();
      mapView.getGraphicsOverlays().add(graphicsOverlay);

      // create a pin graphic
      Image img = new Image(getClass().getResourceAsStream("/pin.png"), 0, 80, true, true);
      pinSymbol = new PictureMarkerSymbol(img);
      pinSymbol.loadAsync();

      tiledLayer.addDoneLoadingListener(() -> {
        if (tiledLayer.getLoadStatus() == LoadStatus.LOADED) {
          Platform.runLater(() -> {
            // center the view over the tiled layer's extent
            mapView.setViewpointGeometryAsync(tiledLayer.getFullExtent());
          });
        } else {
          Alert alert = new Alert(Alert.AlertType.ERROR, "Tiled Layer Failed to Load!");
          alert.show();
        }
      });

      // set the callout's default style
      Callout callout = mapView.getCallout();
      callout.setLeaderPosition(LeaderPosition.BOTTOM);

      // create a locator task
      final String locatorPath =
              new File(System.getProperty("data.dir"), "./samples-data/sanfrancisco/SanFranciscoLocator.loc").getAbsolutePath();
      locatorTask = new LocatorTask(locatorPath);

      // set geocode task parameters
      geocodeParameters = new GeocodeParameters();
      geocodeParameters.getResultAttributeNames().add("*"); // return all attributes
      geocodeParameters.setMaxResults(1); // get closest match

      // set reverse geocode task parameters
      reverseGeocodeParameters = new ReverseGeocodeParameters();
      reverseGeocodeParameters.getResultAttributeNames().add("*");
      reverseGeocodeParameters.setOutputSpatialReference(mapView.getSpatialReference());

      // create mouse moved event handler
      MouseMovedHandler handler = new MouseMovedHandler();

      // start or stop real-time geocoding mode
      mapView.setOnMouseClicked(event -> {

        if (event.isStillSincePress() && event.getButton() == MouseButton.PRIMARY) {
          Point2D clickLocation = new Point2D(event.getX(), event.getY());
          Point point = mapView.screenToLocation(clickLocation);

          if (realtimeMode) {
            // disable the real-time geocoding mode
            realtimeMode = false;
            // clear graphic selections
            graphicsOverlay.clearSelection();
            // remove the mouse moved handler
            mapView.setOnMouseMoved(null);
          } else {
            // identify the selected graphic
            identifyResults = mapView.identifyGraphicsOverlayAsync(graphicsOverlay, clickLocation, 10, false);
            identifyResults.addDoneListener(() -> {
              try {
                List<Graphic> graphics = identifyResults.get().getGraphics();
                if (graphics.size() > 0) {
                  // set the graphic as selected
                  Graphic graphic = graphics.get(0);
                  graphic.setSelected(true);
                  // start real-time mode
                  realtimeMode = true;
                  // add a mouse move event handler to get real-time geocodes
                  mapView.setOnMouseMoved(handler);
                } else {
                  // reverse geocode the selected point
                  ListenableFuture<List<GeocodeResult>> results = locatorTask.reverseGeocodeAsync(point,
                      reverseGeocodeParameters);
                  results.addDoneListener(new ResultsLoadedListener(results));
                }
              } catch (Exception e) {
                e.printStackTrace();
              }
            });
          }
        }
      });

      // add map view and searchBox to stack pane
      stackPane.getChildren().addAll(mapView, searchBox);
      StackPane.setAlignment(searchBox, Pos.TOP_LEFT);
      StackPane.setMargin(searchBox, new Insets(10, 0, 0, 10));

    } catch (Exception e) {
      // on any error, print the stack trace
      e.printStackTrace();
    }
  }

  /**
   * Performs reverse geocode based on mouse location and display the result in
   * real-time.
   */
  private class MouseMovedHandler implements EventHandler<MouseEvent> {

    @Override
    public void handle(MouseEvent event) {

      // get the mouse location coordinates
      Point point = mapView.screenToLocation(new Point2D(event.getX(), event.getY()));

      // disable the move event listener to reduce unnecessary geocode calls
      mapView.setOnMouseMoved(null);

      // run the locator task
      ListenableFuture<List<GeocodeResult>> results = locatorTask.reverseGeocodeAsync(point, reverseGeocodeParameters);
      results.addDoneListener(() -> {
        try {
          // get the geocode from the result
          List<GeocodeResult> geocodes = results.get();
          GeocodeResult geocode = geocodes.get(0);

          // update the marker's position
          graphicsOverlay.getGraphics().get(0).setGeometry(geocode.getDisplayLocation());

          // format result's attributes for callout
          String street = geocode.getAttributes().get("Street").toString();
          String city = geocode.getAttributes().get("City").toString();
          String state = geocode.getAttributes().get("State").toString();
          String zip = geocode.getAttributes().get("ZIP").toString();

          // update the callout
          Platform.runLater(() -> {
            Callout callout = mapView.getCallout();
            callout.setTitle(street);
            callout.setDetail(city + ", " + state + " " + zip);
            callout.showCalloutAt(geocode.getDisplayLocation(), new Point2D(0, -24), Duration.ZERO);
          });

        } catch (Exception e) {
          // mouse is out of bounds
        }
        // re-enable the mouse move listener
        mapView.setOnMouseMoved(this);
      });
    }
  }

  /**
   * Updates 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() {

      try {
        List<GeocodeResult> geocodes = results.get();
        if (geocodes.size() > 0) {
          // get the top result
          GeocodeResult geocode = geocodes.get(0);

          // set the viewpoint to the marker
          Point location = geocode.getDisplayLocation();
          mapView.setViewpointCenterAsync(location, 10000);

          // get attributes from the result for the callout
          String title;
          String detail;
          Object matchAddr = geocode.getAttributes().get("Match_addr");
          if (matchAddr != null) {
            // attributes from a query-based search
            title = matchAddr.toString().split(",")[0];
            detail = matchAddr.toString().substring(matchAddr.toString().indexOf(",") + 1);
          } else {
            // attributes from a click-based search
            String street = geocode.getAttributes().get("Street").toString();
            String city = geocode.getAttributes().get("City").toString();
            String state = geocode.getAttributes().get("State").toString();
            String zip = geocode.getAttributes().get("ZIP").toString();
            title = street;
            detail = city + ", " + state + " " + zip;
          }

          // get attributes from the result for the callout
          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);

          // update the callout
          Platform.runLater(() -> {
            // clear out previous results
            graphicsOverlay.getGraphics().clear();

            // add the markers to the graphics overlay
            graphicsOverlay.getGraphics().add(marker);

            // display the callout
            Callout callout = mapView.getCallout();
            callout.setTitle(marker.getAttributes().get("title").toString());
            callout.setDetail(marker.getAttributes().get("detail").toString());
            callout.showCalloutAt(location, new Point2D(0, -24), Duration.ZERO);
          });
        }

      } catch (Exception e) {
        e.printStackTrace();
      }
    }

  }

  /**
   * Stops and releases all resources used in application.
   */
  @Override
  public void stop() {

    // release resources when the application closes
    if (mapView != null) {
      mapView.dispose();
    }
  }

  /**
   * Opens and runs application.
   *
   * @param args arguments passed to this application
   */
  public static void main(String[] args) {

    Application.launch(args);
  }

}

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