Perform valve isolation trace

View on GitHub
Sample viewer app

Run a filtered trace to locate operable features that will isolate an area from the flow of network resources.

Image of Perform valve isolation trace

Use case

Determine the set of operable features required to stop a network's resource, effectively isolating an area of the network. For example, you can choose to return only accessible and operable valves: ones that are not paved over or rusted shut.

How to use the sample

Click on one or more features on the map to add filter barriers (marked as red crosses) or create and set the configuration's filter barriers by selecting a utility category from the drop down menu. Toggle "Isolated Features" to update trace configuration. Click "Trace" to run a subnetwork-based isolation trace, and click "Reset" to clear filter barriers and trace results.

How it works

  1. Create an ArcGISMap and add it to a MapView.
  2. Create and load a ServiceGeodatabase with a feature service URL and get tables with their layer IDs.
  3. Create FeatureLayers from the service geodatabase's tables, and add them to the operational layers of the map.
  4. Create a UtilityNetwork with the same feature service URL and add it to the map's utility networks list, then load it.
  5. Get a default UtilityTraceConfiguration from a given tier in a domain network. Set its filter with a new UtilityTraceFilter.
  6. Create a UtilityElement to represent a default starting location from the UtilityNetwork, using a given asset type and global ID.
  7. Create a UtilityTraceParameters with a UtilityTraceType.ISOLATION and the starting location.
  8. Use utilityNetwork.fetchFeaturesForElementsAsync() to obtain the Geometry of this element, and create a Graphic with that geometry.
  9. Add a GraphicsOverlay with the graphic that represents the starting location.
  10. Populate the combo box for choosing the filter barrier category from UtilityNetworkDefinition.getCategories().
  11. When "Trace" is clicked,

    1. Create a new UtilityCategoryComparison with the selected category and UtilityCategoryComparisonOperator.EXISTS.
    2. Assign this condition to utilityTraceFilter.setBarriers() from the default configuration from step 5. Update this configuration's utilityTraceConfiguration.isIncludeIsolatedFeatures() property.
    3. Create a UtilityTraceParameters with UtilityTraceType.ISOLATION and default starting location from step 6.
    4. Set its utility trace configuration with this configuration and then, run a utilityNetwork.traceAsync().
  12. Add a listener for clicks on the map view. When the map view is clicked,

    1. Use mapView.identifyLayersAsync() to identify clicked features.
    2. Create a UtilityElement from the feature, and add it to the utilityTraceParameters list of filter barriers.

      • If the element is a junction with more than one terminal, display a terminal picker. Then set the junction's terminal property with the selected terminal.
      • If it is an edge, set its fractionAlongEdge property using GeometryEngine.fractionAlong() method.
    3. Create a Graphic for the filter barrier and add it to the map.
  13. Get the list of UtilityElements from the first trace result.
  14. For every feature layer in the map, select all the features for which the layer's FeatureTable.getTableName() matches the UtilityNetworkSource.getName() of one of the utility elements.

Relevant API

  • GeometryEngine.fractionAlong
  • ServiceGeodatabase
  • UtilityCategory
  • UtilityCategoryComparison
  • UtilityCategoryComparisonOperator
  • UtilityDomainNetwork
  • UtilityElement
  • UtilityElementTraceResult
  • UtilityNetwork
  • UtilityNetworkDefinition
  • UtilityTerminal
  • UtilityTier
  • UtilityTraceFilter
  • UtilityTraceParameters
  • UtilityTraceResult
  • UtilityTraceType

About the data

The Naperville gas network feature service, hosted on ArcGIS Online, contains a utility network used to run the isolation trace shown in this sample.

Tags

category comparison, condition barriers, filter barriers, isolated features, network analysis, subnetwork trace, trace configuration, trace filter, utility network

Sample Code

PerformValveIsolationTraceController.javaPerformValveIsolationTraceSample.javaUtilityCategoryListCell.javaUtilityTerminalListCell.javamain.fxml
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
/*
 * Copyright 2020 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.perform_valve_isolation_trace;

import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.concurrent.ListenableFuture;
import com.esri.arcgisruntime.data.ArcGISFeature;
import com.esri.arcgisruntime.data.FeatureQueryResult;
import com.esri.arcgisruntime.data.QueryParameters;
import com.esri.arcgisruntime.data.ServiceGeodatabase;
import com.esri.arcgisruntime.geometry.Geometry;
import com.esri.arcgisruntime.geometry.GeometryEngine;
import com.esri.arcgisruntime.geometry.Point;
import com.esri.arcgisruntime.geometry.Polyline;
import com.esri.arcgisruntime.geometry.ProximityResult;
import com.esri.arcgisruntime.layers.FeatureLayer;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.view.IdentifyLayerResult;
import com.esri.arcgisruntime.mapping.BasemapStyle;
import com.esri.arcgisruntime.mapping.Viewpoint;
import com.esri.arcgisruntime.mapping.view.Graphic;
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
import com.esri.arcgisruntime.mapping.view.MapView;
import com.esri.arcgisruntime.security.UserCredential;
import com.esri.arcgisruntime.symbology.ColorUtil;
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
import com.esri.arcgisruntime.symbology.SimpleRenderer;
import com.esri.arcgisruntime.utilitynetworks.*;

import javafx.fxml.FXML;
import javafx.geometry.Point2D;
import javafx.scene.control.Alert;
import javafx.scene.control.Button;
import javafx.scene.control.CheckBox;
import javafx.scene.control.ChoiceDialog;
import javafx.scene.control.ComboBox;
import javafx.scene.control.Label;
import javafx.scene.control.ProgressIndicator;
import javafx.scene.input.MouseButton;
import javafx.scene.input.MouseEvent;
import javafx.scene.layout.GridPane;
import javafx.scene.paint.Color;

import java.util.*;
import java.util.concurrent.ExecutionException;

public class PerformValveIsolationTraceController {

  @FXML private MapView mapView;
  @FXML private ProgressIndicator progressIndicator;
  @FXML private ComboBox<UtilityCategory> categorySelectionComboBox;
  @FXML private Button resetButton;
  @FXML private Button traceButton;
  @FXML private Label promptLabel;
  @FXML private Label statusLabel;
  @FXML private CheckBox includeIsolatedFeaturesCheckbox;

  private GraphicsOverlay filterBarriersGraphicsOverlay;
  private UtilityNetwork utilityNetwork;
  private UtilityTraceConfiguration traceConfiguration;
  private UtilityTraceParameters utilityTraceParameters;
  private UtilityElement startingLocation;

  public void initialize() {

    try {
      // authentication with an API key or named user is required to access basemaps and other location services
      String yourAPIKey = System.getProperty("apiKey");
      ArcGISRuntimeEnvironment.setApiKey(yourAPIKey);

      // create a map with the streets night basemap style and set it to the map view
      ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS_NIGHT);
      mapView.setMap(map);

      String featureServiceURL =
              "https://sampleserver7.arcgisonline.com/server/rest/services/UtilityNetwork/NapervilleGas/FeatureServer";
      // set user credentials to authenticate with the service
      // NOTE: a licensed user is required to perform utility network operations
      var userCredential = new UserCredential("viewer01", "I68VGU^nMurF");
      // create a new service geodatabase from the feature service url and set the user credential
      var serviceGeodatabase = new ServiceGeodatabase(featureServiceURL);
      serviceGeodatabase.setCredential(userCredential);

      // load the service geodatabase and get tables by their layer IDs
      serviceGeodatabase.loadAsync();
      serviceGeodatabase.addDoneLoadingListener(() -> {
        if (serviceGeodatabase.getLoadStatus() == LoadStatus.LOADED) {
          // the gas device layer ./0 and gas line layer ./3 are created from the service geodatabase
          var gasDeviceFeatureLayer = new FeatureLayer(serviceGeodatabase.getTable(0));
          var gasLineFeatureLayer = new FeatureLayer(serviceGeodatabase.getTable(3));
          // add the utility network feature layers to the map for display
          map.getOperationalLayers().addAll(Arrays.asList(gasDeviceFeatureLayer, gasLineFeatureLayer));

          // create and add the utility network to the map before loading
          utilityNetwork = new UtilityNetwork(featureServiceURL);
          map.getUtilityNetworks().add(utilityNetwork);
          // load the utility network
          utilityNetwork.loadAsync();
          utilityNetwork.addDoneLoadingListener(() -> {
            if (utilityNetwork.getLoadStatus() == LoadStatus.LOADED) {

              // get a trace configuration from a tier
              UtilityNetworkDefinition networkDefinition = utilityNetwork.getDefinition();
              UtilityDomainNetwork domainNetwork = networkDefinition.getDomainNetwork("Pipeline");
              UtilityTier tier = domainNetwork.getTier("Pipe Distribution System");
              traceConfiguration = tier.getDefaultTraceConfiguration();

              // create a trace filter
              traceConfiguration.setFilter(new UtilityTraceFilter());

              // get a default starting location
              UtilityNetworkSource networkSource = networkDefinition.getNetworkSource("Gas Device");
              UtilityAssetGroup assetGroup = networkSource.getAssetGroup("Meter");
              UtilityAssetType assetType = assetGroup.getAssetType("Customer");
              startingLocation = utilityNetwork.createElement(assetType, UUID.fromString("98A06E95-70BE-43E7-91B7-E34C9D3CB9FF"));
              // create new base trace parameters
              utilityTraceParameters = new UtilityTraceParameters(UtilityTraceType.ISOLATION, Collections.singletonList(startingLocation));

              // get the first feature for the starting location, and get its geometry
              ListenableFuture<List<ArcGISFeature>> elementFeaturesFuture =
                utilityNetwork.fetchFeaturesForElementsAsync(Collections.singletonList(startingLocation));

              elementFeaturesFuture.addDoneListener(() -> {
                try {
                  List<ArcGISFeature> startingLocationFeatures = elementFeaturesFuture.get();

                  if (!startingLocationFeatures.isEmpty()) {
                    Geometry startingLocationGeometry = startingLocationFeatures.get(0).getGeometry();

                    if (startingLocationGeometry instanceof Point) {
                      Point startingLocationGeometryPoint = (Point) startingLocationGeometry;

                      // create a graphics overlay for the starting location and add it to the map view
                      GraphicsOverlay startingLocationGraphicsOverlay = new GraphicsOverlay();
                      mapView.getGraphicsOverlays().add(startingLocationGraphicsOverlay);

                      // create and apply a renderer for the starting point graphics overlay
                      SimpleMarkerSymbol startingPointSymbol =
                        new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CROSS, ColorUtil.colorToArgb(Color.LIGHTGREEN), 25);
                      startingLocationGraphicsOverlay.setRenderer(new SimpleRenderer(startingPointSymbol));

                      // create a graphic for the starting location and add it to the graphics overlay
                      Graphic startingLocationGraphic = new Graphic(startingLocationGeometry, startingPointSymbol);
                      startingLocationGraphicsOverlay.getGraphics().add(startingLocationGraphic);

                      // create a graphics overlay for filter barriers and add it to the map view
                      filterBarriersGraphicsOverlay = new GraphicsOverlay();
                      mapView.getGraphicsOverlays().add(filterBarriersGraphicsOverlay);

                      // create and apply a renderer for the filter barriers graphics overlay
                      SimpleMarkerSymbol barrierPointSymbol =
                        new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CROSS, ColorUtil.colorToArgb(Color.RED), 25);
                      filterBarriersGraphicsOverlay.setRenderer(new SimpleRenderer(barrierPointSymbol));

                      // set the map's viewpoint to the starting location
                      mapView.setViewpointAsync(new Viewpoint(startingLocationGeometryPoint, 3000));

                      // build the choice list for categories populated with the 'Name' property of each 'UtilityCategory' in the 'UtilityNetworkDefinition'
                      categorySelectionComboBox.getItems().addAll(networkDefinition.getCategories());
                      categorySelectionComboBox.getSelectionModel().select(0);
                      categorySelectionComboBox.setCellFactory(param -> new UtilityCategoryListCell());
                      categorySelectionComboBox.setButtonCell(new UtilityCategoryListCell());

                      // enable the UI
                      categorySelectionComboBox.setDisable(false);
                      enableUI(true);

                      // update the status text
                      statusLabel.setText("Utility network loaded. Ready to perform trace...");
                    }

                  } else {
                    new Alert(Alert.AlertType.ERROR, "Error getting starting location geometry.").show();
                  }
                } catch (ExecutionException | InterruptedException e) {
                  new Alert(Alert.AlertType.ERROR, "Error getting starting location feature.").show();
                }
              });

            } else {
              new Alert(Alert.AlertType.ERROR, "Error loading Utility Network.").show();
            }
          });

        } else {
          new Alert(Alert.AlertType.ERROR, "Failed to load service geodatabase").show();
        }
      });

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

  /**
   * Uses the starting location and the selected filter barrier category to perform a valve isolation trace, then
   * selects all connected elements found in the trace to highlight them.
   */
  @FXML
  private void handleTraceClick() {
    try {

      clearSelectedFeatureLayersOnMap();

      // disable the UI, show the progress indicator and update the status text
      enableUI(false);
      statusLabel.setText("Running isolation trace...");

      // get the selected utility category
      UtilityCategory selectedCategory = categorySelectionComboBox.getSelectionModel().getSelectedItem();
      if (selectedCategory != null) {
        // create a category comparison for the trace
        // NOTE: UtilityNetworkAttributeComparison or UtilityCategoryComparison with Operator.DoesNotExists
        // can also be used. These conditions can be joined with either UtilityTraceOrCondition or UtilityTraceAndCondition.
        var utilityCategoryComparison = new UtilityCategoryComparison(selectedCategory, UtilityCategoryComparisonOperator.EXISTS);
        // set the category comparison to the barriers of the configuration's trace filter
        traceConfiguration.setFilter(new UtilityTraceFilter());
        traceConfiguration.getFilter().setBarriers(utilityCategoryComparison);

      }

      // set the configuration to include or leave out isolated features
      traceConfiguration.setIncludeIsolatedFeatures(includeIsolatedFeaturesCheckbox.isSelected());

      // build parameters for the isolation trace
      utilityTraceParameters.setTraceConfiguration(traceConfiguration);

      // run the trace and get the result
      ListenableFuture<List<UtilityTraceResult>> utilityTraceResultsFuture = utilityNetwork.traceAsync(utilityTraceParameters);
      utilityTraceResultsFuture.addDoneListener(() -> {
        try {
          List<UtilityTraceResult> utilityTraceResults = utilityTraceResultsFuture.get();

          if (utilityTraceResults.get(0) instanceof UtilityElementTraceResult) {
            var utilityElementTraceResult = (UtilityElementTraceResult) utilityTraceResults.get(0);

            if (!utilityElementTraceResult.getElements().isEmpty()) {

              // iterate through the map's feature layers
              mapView.getMap().getOperationalLayers().forEach(layer -> {
                if (layer instanceof FeatureLayer) {

                  // create query parameters to find features whose network source name matches the layer's feature
                  // table name
                  var queryParameters = new QueryParameters();
                  utilityElementTraceResult.getElements().forEach(utilityElement -> {

                    String networkSourceName = utilityElement.getNetworkSource().getName();
                    String featureTableName = ((FeatureLayer) layer).getFeatureTable().getTableName();

                    if (networkSourceName.equals(featureTableName)) {
                      queryParameters.getObjectIds().add(utilityElement.getObjectId());
                    }
                  });

                  // select features that match the query
                  ListenableFuture<FeatureQueryResult> featureQueryResultListenableFuture =
                          ((FeatureLayer) layer).selectFeaturesAsync(queryParameters, FeatureLayer.SelectionMode.NEW);

                  // wait for the selection to finish
                  featureQueryResultListenableFuture.addDoneListener(() -> {
                    // update the status text, enable the buttons and hide the progress indicator
                    statusLabel.setText("Isolation trace completed.");
                    enableUI(true);
                  });
                }
              });

            } else {
              statusLabel.setText("Isolation trace completed.");
              new Alert(Alert.AlertType.INFORMATION, "Isolation trace returned no elements.").show();
              enableUI(true);
            }

          } else {
            statusLabel.setText("Trace failed.");
            new Alert(Alert.AlertType.ERROR, "Isolation trace result is not a utility element.").show();
            enableUI(true);
          }

        } catch (Exception e) {
          statusLabel.setText("Trace failed.");
          new Alert(Alert.AlertType.ERROR, "Error getting isolation trace result.").show();
          enableUI(true);
        }
      });

    } catch (Exception e) {
      new Alert(Alert.AlertType.ERROR, "Error performing isolation trace.").show();
      enableUI(true);
    }
  }

  /**
   *  Uses the clicked map point to identify any utility elements in the utility network at the clicked location. The
   *  clicked utility element is added to the utility trace parameter's filter barrier list. A graphic is created
   *  at the clicked location to mark the element as a filter barrier.
   *
   *  @param e event registered when the map view is clicked on
   */
  @FXML
  private void handleMapViewClicked(MouseEvent e) {

    if (e.getButton() == MouseButton.PRIMARY && e.isStillSincePress()) {

      categorySelectionComboBox.setDisable(true);
      promptLabel.setText("Add another filter barrier by clicking the map or click Trace");

      // ensure the utility network is loaded before processing clicks on the map view
      if (utilityNetwork.getLoadStatus() == LoadStatus.LOADED && e.getButton() == MouseButton.PRIMARY &&
        e.isStillSincePress()) {

        // show the progress indicator
        progressIndicator.setVisible(true);

        // get the clicked map point
        Point2D screenPoint = new Point2D(e.getX(), e.getY());
        Point mapPoint = mapView.screenToLocation(screenPoint);

        // identify the feature to be used
        ListenableFuture<List<IdentifyLayerResult>> identifyLayerResultsFuture =
          mapView.identifyLayersAsync(screenPoint, 10, false);

        identifyLayerResultsFuture.addDoneListener(() -> {
          try {
            // get the result of the query
            List<IdentifyLayerResult> identifyLayerResults = identifyLayerResultsFuture.get();

            // return if no features are identified
            if (!identifyLayerResults.isEmpty()) {

              // get and store a list of features from the result of the query (there may be more than one)
              List<ArcGISFeature> listOfFeatures = new ArrayList<>();
              identifyLayerResults.forEach(result -> listOfFeatures.add((ArcGISFeature) result.getElements().get(0)));

              // create an utility element for each feature and store it in a list
              List<UtilityElement> utilityElementList = new ArrayList<>();
              listOfFeatures.forEach(feature -> utilityElementList.add(utilityNetwork.createElement(feature)));

              // check the utility network source type of every utility element
              utilityElementList.forEach(utilityElement -> {

                // check if the network source is a junction or an edge
                if (utilityElement.getNetworkSource().getSourceType() == UtilityNetworkSource.Type.JUNCTION) {

                  // check if the feature has a terminal configuration and multiple terminals
                  if (utilityElement.getAssetType().getTerminalConfiguration() != null) {
                    UtilityTerminalConfiguration utilityTerminalConfiguration = utilityElement.getAssetType().getTerminalConfiguration();
                    List<UtilityTerminal> terminals = utilityTerminalConfiguration.getTerminals();

                    if (terminals.size() > 1) {
                      // prompt the user to select a terminal for this feature
                      Optional<UtilityTerminal> userSelectedTerminal = promptForTerminalSelection(terminals);

                      // apply the selected terminal
                      if (userSelectedTerminal.isPresent()) {
                        UtilityTerminal terminal = userSelectedTerminal.get();
                        utilityElement.setTerminal(terminal);
                        // show the terminals name in the status label
                        String terminalName = terminal.getName() != null ? terminal.getName() : "default";
                        statusLabel.setText("Feature added at terminal: " + terminalName);

                        // don't create the element if no terminal was selected
                      } else {
                        statusLabel.setText("No terminal selected - no feature added");
                      }
                    }
                  }

                } else if (utilityElement.getNetworkSource().getSourceType() == UtilityNetworkSource.Type.EDGE) {

                  // get the geometry of the identified feature as a polyline, and remove the z component
                  Polyline polyline = (Polyline) GeometryEngine.removeZ(listOfFeatures.get(0).getGeometry());

                  // compute how far the clicked location is along the edge feature
                  double fractionAlongEdge = GeometryEngine.fractionAlong(polyline, mapPoint, -1);
                  if (Double.isNaN(fractionAlongEdge)) {
                    new Alert(Alert.AlertType.ERROR, "Cannot add starting location / barrier here.");
                    return;
                  }

                  // set the fraction along edge
                  utilityElement.setFractionAlongEdge(fractionAlongEdge);

                  // update the status label text
                  statusLabel.setText("Fraction along edge: " + Math.round(utilityElement.getFractionAlongEdge() * 1000d) / 1000d);
                }
              });

              // add the element to the list of filter barriers
              utilityTraceParameters.getFilterBarriers().add(utilityElementList.get(0));

              // create a graphic for the new utility element
              Graphic traceLocationGraphic = new Graphic();

              // find the closest coordinate on the selected element to the clicked point
              ProximityResult proximityResult =
                GeometryEngine.nearestCoordinate(listOfFeatures.get(0).getGeometry(), mapPoint);

              // set the graphic's geometry to the coordinate on the element and add it to the graphics overlay
              traceLocationGraphic.setGeometry(proximityResult.getCoordinate());
              filterBarriersGraphicsOverlay.getGraphics().add(traceLocationGraphic);
            }

          } catch (InterruptedException | ExecutionException ex) {
            statusLabel.setText("Error identifying clicked features.");
            new Alert(Alert.AlertType.ERROR, "Error identifying clicked features.").show();
          } finally {
            progressIndicator.setVisible(false);
          }
        });
      }
    }
  }

  /**
   * Prompts the user to select a terminal from a provided list.
   *
   * @param terminals a list of terminals for the user to choose from
   * @return the user's selected terminal
   */
  private Optional<UtilityTerminal> promptForTerminalSelection(List<UtilityTerminal> terminals) {

    // create a dialog for terminal selection
    ChoiceDialog<UtilityTerminal> utilityTerminalSelectionDialog = new ChoiceDialog<>(terminals.get(0), terminals);
    utilityTerminalSelectionDialog.initOwner(mapView.getScene().getWindow());
    utilityTerminalSelectionDialog.setTitle("Choose Utility Terminal");
    utilityTerminalSelectionDialog.setHeaderText("Junction selected. Choose the Utility Terminal to add as the trace element:");

    // override the list cell in the dialog's combo box to show the terminal name
    @SuppressWarnings("unchecked") ComboBox<UtilityTerminal> comboBox =
      (ComboBox<UtilityTerminal>) ((GridPane) utilityTerminalSelectionDialog.getDialogPane()
        .getContent()).getChildren().get(1);
    comboBox.setCellFactory(param -> new UtilityTerminalListCell());
    comboBox.setButtonCell(new UtilityTerminalListCell());

    // show the terminal selection dialog and capture the user selection
    return utilityTerminalSelectionDialog.showAndWait();
  }

  /**
   * Enables/disables the UI and hides/shows the progress indicator.
   *
   * @param enable whether to enable or disable the UI
   */
  private void enableUI(boolean enable) {
    progressIndicator.setVisible(!enable);
    traceButton.setDisable(!enable);
    resetButton.setDisable(!enable);
    includeIsolatedFeaturesCheckbox.setDisable(!enable);
  }

  /**
   * Clears the selection of feature layers from the map, clears the utility trace parameter's list of filter barriers
   * and clears the graphics within the filter barriers graphics overlay.
   */
  @FXML
  private void handleResetButtonClick() {
    statusLabel.setText("Ready to perform trace");
    promptLabel.setText("Choose category for filter barrier:");
    categorySelectionComboBox.setDisable(false);
    clearSelectedFeatureLayersOnMap();
    utilityTraceParameters.getFilterBarriers().clear();
    filterBarriersGraphicsOverlay.getGraphics().clear();
  }

  /**
   * Clears the previous selection of feature layers from the map.
   */
  private void clearSelectedFeatureLayersOnMap() {
    // clear previous selection from the layers
    mapView.getMap().getOperationalLayers().forEach(layer -> {
      if (layer instanceof FeatureLayer) {
        ((FeatureLayer) layer).clearSelection();
      }
    });
  }

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

    if (mapView != null) {
      mapView.dispose();
    }
  }
}

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