Find a route and directions | ArcGIS Maps SDK for Java

Learn how to find a route and directions with the route serviceA routing service is a service that uses network analysis and streets data to calculate the most effective path and turn-by-turn directions on a street network, optimize fleet routing and deliveries, find the closest facilities, calculate service areas, and more. It is hosted by Esri as the ArcGIS Routing service and can also be hosted in ArcGIS Enterprise.Learn more.

Routing is the process of finding the path from an originAn origin is a point that defines the start of a route.Learn more to a destinationA destination is a point that defines the final stop in a route.Learn more in a street network. You can use the Routing serviceA routing service is a service that uses network analysis and streets data to calculate the most effective path and turn-by-turn directions on a street network, optimize fleet routing and deliveries, find the closest facilities, calculate service areas, and more. It is hosted by Esri as the ArcGIS Routing service and can also be hosted in ArcGIS Enterprise.Learn more to find routesA route is a polyline that defines the best path between two or more points in a street network.Learn more, get driving directions, calculate drive times, and solve complicated, multiple vehicle routing problems. To create a route, you typically define a set of stops (origin and one or more destinations) and use the service to find a route with directions. You can also use a number of additional parameters such as barriers and mode of travel to refine the results.

In this tutorial, you define an origin and destination by clicking on the map. These values are used to get a route and directions from the route service. The directions are also displayed on the map.

Prerequisites

Before starting this tutorial:

You need an ArcGIS Location Platform or ArcGIS Online account.
Confirm that your system meets the minimum system requirements.
An IDE for Java.

Steps

Get an access token

You need an access tokenAn 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 servicesArcGIS 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.

Go to the Create an API key tutorial to obtain an access tokenAn 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 PlatformAn 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 OnlineAn 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.
Ensure that the following privilegesPrivileges 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 > Routing.
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

To start this tutorial, complete the Display a map tutorial, or download and unzip the Display a map solution into a new folder.
Open the build.gradle file as a project in IntelliJ IDEA.
In IntelliJ IDEA's Project tool window, open src/main/java/com.example.app and double-click App.
In the start() method, set the API key property on the ArcGISRuntimeEnvironment with your access tokenAn 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
Use dark colors for code blocks
```
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
    ArcGISRuntimeEnvironment.setApiKey("YOUR_ACCESS_TOKEN");
```
Warning
The access token is stored directly in the code as a convenience for this tutorial. Storing access tokens in the source code is not best practice.

Add import statements and variable declarations

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

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

Add the following imports above the existing imports:

App.java
Use dark colors for code blocks
16
16
16
16
16
16
16
16
16
16
16
16
16
16
16
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
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
49
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.Add line.Add line.Add line.Add line.Add line.Add line.Add line.import com.esri.arcgisruntime.concurrent.ListenableFuture;
import com.esri.arcgisruntime.geometry.Geometry;
import com.esri.arcgisruntime.mapping.view.Graphic;
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
import com.esri.arcgisruntime.symbology.SimpleLineSymbol;
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
import com.esri.arcgisruntime.tasks.networkanalysis.Route;
import com.esri.arcgisruntime.tasks.networkanalysis.RouteParameters;
import com.esri.arcgisruntime.tasks.networkanalysis.RouteResult;
import com.esri.arcgisruntime.tasks.networkanalysis.RouteTask;
import com.esri.arcgisruntime.tasks.networkanalysis.Stop;

import javafx.collections.FXCollections;
import javafx.collections.ListChangeListener;
import javafx.collections.ObservableList;
import javafx.geometry.Point2D;
import javafx.geometry.Pos;
import javafx.scene.paint.Color;
import javafx.scene.control.Alert;
import javafx.scene.control.ListView;
import javafx.scene.input.MouseButton;
import java.util.List;

import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.view.MapView;
import com.esri.arcgisruntime.mapping.BasemapStyle;
import com.esri.arcgisruntime.mapping.Viewpoint;

import javafx.application.Application;
import javafx.scene.Scene;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;

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

Member variables ensure that objects are not deallocated while asynchronous methods are executing. If an object is deallocated while one of its asynchronous methods is executing, the completion callback closure will never be called.

App.java
Use dark colors for code blocks
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
52
53
54
55
56
57
58
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
59
58
57
56
55
53
51
49
47
45
43
41
39
37
35
33
31
29
27
25
23
21
19
17
16
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
15
14
13
12
11
10
9
8
7
6
6
6
6
6
6
6
6
6
6
6
6
Add line.Add line.Add line.Add line.Add line.  private MapView mapView;

  private Graphic routeGraphic;
  private RouteTask routeTask;
  private RouteParameters routeParameters;
  private final ObservableList<Stop> routeStops = FXCollections.observableArrayList();
  private final ListView<String> directionsList = new ListView<>();

Update the map

A streets basemap layerA basemap layer is the layer in a map or scene that displays basemap data. The data source for a basemap layer is typically a basemap service.Learn more is typically used in routing applications. Update the basemap to use the ARCGIS_STREETS basemap style, and change the position of the map to center on Los Angeles.

Update the BasemapStyle from ARCGIS_TOPOGRAPHIC to ARCGIS_STREETS.

Update the latitude and longitude coordinates to center on Los Angeles.

App.java
Expand
Use dark colors for code blocks
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
82
83
84
85
86
87
88
89
90
91
92
92
91
90
89
88
86
84
82
80
78
76
74
72
70
68
66
64
62
60
58
56
54
52
50
49
48
47
46
45
44
43
42
41
40
39
38
37
36
35
34
33
32
31
30
29
28
27
26
25
24
23
22
21
20
19
18
17
16
15
14
13
12
11
10
9
8
7
6
5
4
3
2
1
0
-1
-2
-3
-4
-5
-6
-6
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15
-15
-15
-15
-15
-15
-15
-15
-15
-15
-15
-15
Change lineChange line    // create a MapView to display the map and add it to the stack pane
    mapView = new MapView();
    stackPane.getChildren().add(mapView);

    ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS);

    // set the map on the map view
    mapView.setMap(map);

    mapView.setViewpoint(new Viewpoint(34.05398, -118.24532, 144447.638572));
Expand

Add a UI to display driving directions

To display the turn-by-turn directions from the route, a UI element is required.

In the start() method, set the maximum size of the directionsList (a JavaFX ListView which will display a vertical list of directions), and then add it to the stackPane.

App.java
Expand
Use dark colors for code blocks
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
86
87
88
89
90
91
92
93
94
95
96
96
94
92
90
88
86
84
82
80
78
76
74
72
70
68
66
64
62
60
58
57
56
55
54
53
52
51
50
49
48
47
46
45
44
43
42
41
40
39
38
37
36
35
34
33
32
31
30
29
28
27
26
25
24
23
22
21
20
19
18
17
16
15
14
13
12
11
10
9
8
7
6
5
4
3
2
2
2
1
0
-1
-2
-3
-4
-5
-6
-7
-7
-7
-7
-7
-7
-7
-7
-7
-7
-7
-7
Add line.Add line.Add line.    ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS);

    // set the map on the map view
    mapView.setMap(map);

    mapView.setViewpoint(new Viewpoint(34.05398, -118.24532, 144447.638572));

    directionsList.setMaxSize(400, 250);
    stackPane.getChildren().add(directionsList);
    StackPane.setAlignment(directionsList, Pos.TOP_LEFT);
Expand

Add a graphics overlay

A graphics overlayA 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 graphicsA graphic is a visual element composed of a geometry, symbol, and attributes that is displayed on a map or scene.Learn more. Graphics will be added later in this tutorial as a visual means to display the route stops and route result on the mapA map is a collection of layers that are displayed in 2D. It is typically composed of a basemap layer and data layers.Learn more.

Create a new GraphicsOverlay and add it to the mapView.

App.java
Expand
Use dark colors for code blocks
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
93
94
95
96
97
98
99
99
98
97
96
95
94
93
92
91
90
89
88
87
86
85
84
83
82
81
80
79
78
77
76
75
74
73
72
71
70
69
68
67
66
65
64
63
62
61
60
59
58
57
56
55
54
53
52
51
50
49
48
47
46
45
44
43
42
41
40
39
38
37
36
35
34
33
32
31
30
29
28
27
27
27
26
25
24
23
22
21
20
19
18
18
18
18
18
18
18
18
18
18
18
18
Add line.Add line.    directionsList.setMaxSize(400, 250);
    stackPane.getChildren().add(directionsList);
    StackPane.setAlignment(directionsList, Pos.TOP_LEFT);

    GraphicsOverlay graphicsOverlay = new GraphicsOverlay();
    mapView.getGraphicsOverlays().add(graphicsOverlay);
Expand

Create a route task and route parameters

A task makes a request to a serviceA service, also known as an ArcGIS service, is software that supports an ArcGIS REST API and provides geospatial functionality or data. A service can be hosted by Esri or in ArcGIS Enterprise.Learn more and returns the results. Use the RouteTask class to access a routing serviceA routing service is a service that uses network analysis and streets data to calculate the most effective path and turn-by-turn directions on a street network, optimize fleet routing and deliveries, find the closest facilities, calculate service areas, and more. It is hosted by Esri as the ArcGIS Routing service and can also be hosted in ArcGIS Enterprise.Learn more. A routing service with global coverage is part of ArcGIS location services. You can also publish custom routing services using ArcGIS Enterprise.

Create a RouteTask(java.lang.String) with a string URL to reference the routing service.

App.java
Expand
Use dark colors for code blocks
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
97
98
99
100
101
102
102
102
102
102
102
102
102
102
102
102
102
102
102
101
100
99
98
97
96
95
94
93
92
91
90
89
88
87
86
85
84
83
82
81
80
79
78
77
76
75
74
73
72
71
70
69
68
67
66
65
64
63
62
61
60
59
58
57
56
55
54
53
52
51
50
49
48
47
46
45
45
45
44
43
42
41
40
39
38
37
36
36
36
36
36
36
36
36
36
36
36
36
Add line.    GraphicsOverlay graphicsOverlay = new GraphicsOverlay();
    mapView.getGraphicsOverlays().add(graphicsOverlay);

    routeTask = new RouteTask("https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World");

Expand

Get default RouteParameters objects from the routeTask and set the return directions property to true. This specifies that the route results should include turn-by-turn directions. Add a UI text prompt.

The createDefaultParametersAsync() method is asynchronous and you must handle its completion and check for errors.

App.java
Expand
Use dark colors for code blocks
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
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
79
78
77
76
75
74
73
72
71
70
69
68
67
66
65
64
63
62
61
60
59
59
59
58
57
56
55
54
53
52
51
50
50
50
50
50
50
50
50
50
50
50
50
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.    routeTask = new RouteTask("https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World");

    ListenableFuture<RouteParameters> routeParametersFuture = routeTask.createDefaultParametersAsync();
    routeParametersFuture.addDoneListener(() -> {
      try {
        routeParameters = routeParametersFuture.get();
        routeParameters.setReturnDirections(true);
        directionsList.getItems().add("Click to add two points to the map to find a route.");

      } catch (Exception e) {
        Alert alert = new Alert(Alert.AlertType.ERROR, e.toString());
        alert.show();
        e.printStackTrace();
      }
    });
Expand

Create origin and destination stops

A RouteTask requires at least a single originAn origin is a point that defines the start of a route.Learn more and destinationA destination is a point that defines the final stop in a route.Learn more stop to find a routeA route is a polyline that defines the best path between two or more points in a street network.Learn more. Use a click handler on the mapView to add stops and display them as graphics when the map is clicked.

When a user clicks on the map, a stop will be added to a list of route stops. In this tutorial, the first click will create the origin stop and the second will create the destination stop.

Create a new addStopsOnMouseClicked() method which adds a setOnMouseClicked() listener to the mapView. Convert the clicked JavaFX Point2D to a location Point. Use the point to create a new Stop and add it to the routeStops list.

App.java
Expand
Use dark colors for code blocks
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
172
171
170
168
166
164
162
160
158
156
154
152
150
148
146
144
142
140
138
136
134
132
130
128
126
124
122
120
118
116
114
112
110
108
106
104
102
100
98
96
93
90
87
84
81
78
76
74
71
68
65
62
59
57
55
54
53
54
55
56
57
58
59
60
61
62
63
63
63
63
63
63
63
63
63
63
63
63
63
Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.  }

  private void addStopsOnMouseClicked() {
    mapView.setOnMouseClicked(event -> {
      if (event.isStillSincePress() && event.getButton() == MouseButton.PRIMARY) {
        Point2D mapPoint = new Point2D(event.getX(), event.getY());
        routeStops.add(new Stop(mapView.screenToLocation(mapPoint)));
      }
    });
  }
Expand

Call addStopsOnMouseClicked() in the start() method.

App.java
Expand
Use dark colors for code blocks
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
109
110
111
112
113
114
115
116
117
117
115
113
111
109
107
105
103
101
99
97
95
93
91
89
87
85
83
81
79
77
75
73
71
69
67
65
63
61
59
57
55
53
51
49
47
45
43
40
37
34
31
28
25
23
21
18
15
12
9
6
4
2
1
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
0
Add line.      } catch (Exception e) {
        Alert alert = new Alert(Alert.AlertType.ERROR, e.toString());
        alert.show();
        e.printStackTrace();
      }
    });

    addStopsOnMouseClicked();
Expand

To display the stops on the map as they are added, add a listener to the routeStops ObservableList and create a new SimpleMarkerSymbol for each Stop. Use the stop's geometry to create a new Graphic and add it to the graphicsOverlay.

App.java
Expand
Use dark colors for code blocks
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
136
135
134
133
132
131
131
131
130
129
128
127
126
126
126
127
127
127
127
127
127
127
127
127
127
127
127
127
127
127
127
127
127
127
127
127
127
127
127
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.Add line.Add line.Add line.Add line.Add line.    addStopsOnMouseClicked();

    routeStops.addListener((ListChangeListener<Stop>) e -> {
      // tracks the number of stops added to the map, and use it to create graphic geometry and symbol text
      int routeStopsSize = routeStops.size();
      // handle user interaction
      if (routeStopsSize == 0) {
        return;
      } else if (routeStopsSize == 1) {
        graphicsOverlay.getGraphics().clear();
        if (!directionsList.getItems().isEmpty())
          directionsList.getItems().clear();
        directionsList.getItems().add("Click to add two points to the map to find a route.");
      }
      // create a blue circle symbol for the stop
      SimpleMarkerSymbol stopMarker = new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, Color.BLUE, 20);
      // get the stop's geometry
      Geometry routeStopGeometry = routeStops.get(routeStopsSize-1).getGeometry();

      graphicsOverlay.getGraphics().add(new Graphic(routeStopGeometry, stopMarker));

    });
Expand

Find and display the route

To find the routeA route is a polyline that defines the best path between two or more points in a street network.Learn more between the originAn origin is a point that defines the start of a route.Learn more and destinationA destination is a point that defines the final stop in a route.Learn more, set the stopsA stop is a single point along a route: it can be the origin, an intermediate stop, or destination.Learn more on the route parameters and solve the route using the RouteTask. Display the route result on the map as a graphic.

When an origin and destination stop have been created, set them on the routeParameters.

App.java
Expand
Use dark colors for code blocks
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
135
136
137
138
139
140
141
142
142
142
142
142
142
142
142
141
140
139
138
137
136
135
134
133
132
131
130
130
130
130
130
130
130
130
131
131
131
131
131
131
131
131
131
131
131
131
131
131
131
131
131
131
131
131
131
131
131
131
131
131
Add line.Add line.Add line.Add line.Add line.Add line.      graphicsOverlay.getGraphics().add(new Graphic(routeStopGeometry, stopMarker));

      if (routeStopsSize == 2) {
        // remove the mouse clicked event if two stops have been added
        mapView.setOnMouseClicked(null);
        routeParameters.setStops(routeStops);

      }
Expand

Solve (find) the route based on the provided route parameters to obtain a RouteResult. The result is a collection of computed routes. Then, get the list of Route objects from the result. Each element represents an independent route with its own driving directions. The routing service only returns the optimal route.

The solveRouteAsync() method is asynchronous and you must handle its completion, check for errors, and confirm that a populated list of Route objects has been returned.

App.java
Expand
Use dark colors for code blocks
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
137
138
139
140
141
142
143
144
145
146
147
148
149
148
147
146
145
144
143
142
141
140
139
138
137
137
137
138
139
140
141
142
143
143
143
143
143
143
143
143
143
143
143
143
143
143
143
143
143
143
143
143
143
143
143
143
143
143
Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.Add line.      if (routeStopsSize == 2) {
        // remove the mouse clicked event if two stops have been added
        mapView.setOnMouseClicked(null);
        routeParameters.setStops(routeStops);

        // get the route and display it
        ListenableFuture<RouteResult> routeResultFuture = routeTask.solveRouteAsync(routeParameters);
        routeResultFuture.addDoneListener(() -> {
          try {
            RouteResult result = routeResultFuture.get();
            List<Route> routes = result.getRoutes();

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

      }
Expand

Check that a route was returned, and retrieve the first one. Display this route to the map by creating a new Graphic using the route's Geometry and a SimpleLineSymbol, and add it to the graphicsOverlay.

App.java
Expand
Use dark colors for code blocks
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
142
143
144
145
146
147
148
149
150
151
152
153
154
155
155
155
155
155
155
155
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
156
Add line.Add line.Add line.Add line.Add line.Add line.Add line.        // get the route and display it
        ListenableFuture<RouteResult> routeResultFuture = routeTask.solveRouteAsync(routeParameters);
        routeResultFuture.addDoneListener(() -> {
          try {
            RouteResult result = routeResultFuture.get();
            List<Route> routes = result.getRoutes();

            if (!routes.isEmpty()) {
              Route route = routes.get(0);
              Geometry shape = route.getRouteGeometry();
              routeGraphic = new Graphic(shape, new SimpleLineSymbol(SimpleLineSymbol.Style.SOLID, Color.BLUE, 2));
              graphicsOverlay.getGraphics().add(routeGraphic);

            }
Expand

Get directions

You can get driving directions from the route serviceA routing service is a service that uses network analysis and streets data to calculate the most effective path and turn-by-turn directions on a street network, optimize fleet routing and deliveries, find the closest facilities, calculate service areas, and more. It is hosted by Esri as the ArcGIS Routing service and can also be hosted in ArcGIS Enterprise.Learn more with the setReturnDirections() method on RouteParameters. This property was set to true in the Create a route task and route parameters section of this tutorial.

To display the driving directions, get each DirectionManeuver from the route, and add them to the directionsList.

App.java
Expand
Use dark colors for code blocks
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
149
150
151
152
153
154
155
156
157
158
159
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
160
Add line.Add line.Add line.Add line.Add line.            if (!routes.isEmpty()) {
              Route route = routes.get(0);
              Geometry shape = route.getRouteGeometry();
              routeGraphic = new Graphic(shape, new SimpleLineSymbol(SimpleLineSymbol.Style.SOLID, Color.BLUE, 2));
              graphicsOverlay.getGraphics().add(routeGraphic);

              // get the direction text for each maneuver and display it as a list in the UI
              route.getDirectionManeuvers().forEach(step -> directionsList.getItems().add(step.getDirectionText()));
              // reset stops and re-enable mapview interactions once the route task has completed
              routeStops.clear();
              addStopsOnMouseClicked();
Expand

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.

The map should support two clicks to create an origin and destination point and then use the route serviceA routing service is a service that uses network analysis and streets data to calculate the most effective path and turn-by-turn directions on a street network, optimize fleet routing and deliveries, find the closest facilities, calculate service areas, and more. It is hosted by Esri as the ArcGIS Routing service and can also be hosted in ArcGIS Enterprise.Learn more to display the resulting route and turn-by-turn directions.

What's next?

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