Set up location driven Geotriggers

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 /*  * Copyright 2021 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.set_up_location_driven_geotriggers;  import java.io.IOException; import java.io.InputStream; import java.nio.charset.StandardCharsets; import java.util.ArrayList; import java.util.Arrays; import java.util.Calendar; import java.util.HashSet; import java.util.List; import java.util.concurrent.ExecutionException;  import javafx.fxml.FXML; import javafx.geometry.Insets; import javafx.scene.control.Alert; import javafx.scene.control.Label; import javafx.scene.image.Image; import javafx.scene.image.ImageView; import javafx.scene.layout.VBox;  import com.esri.arcgisruntime.arcade.ArcadeExpression; import com.esri.arcgisruntime.concurrent.ListenableFuture; import com.esri.arcgisruntime.data.ArcGISFeature; import com.esri.arcgisruntime.data.Attachment; import com.esri.arcgisruntime.data.ServiceFeatureTable; import com.esri.arcgisruntime.geometry.Geometry; import com.esri.arcgisruntime.geometry.Polyline; import com.esri.arcgisruntime.geometry.SpatialReferences; import com.esri.arcgisruntime.geotriggers.FeatureFenceParameters; import com.esri.arcgisruntime.geotriggers.FenceGeotrigger; import com.esri.arcgisruntime.geotriggers.FenceGeotriggerNotificationInfo; import com.esri.arcgisruntime.geotriggers.FenceNotificationType; import com.esri.arcgisruntime.geotriggers.FenceRuleType; import com.esri.arcgisruntime.geotriggers.GeotriggerMonitor; import com.esri.arcgisruntime.geotriggers.LocationGeotriggerFeed; import com.esri.arcgisruntime.layers.FeatureLayer; import com.esri.arcgisruntime.location.LocationDataSource; import com.esri.arcgisruntime.location.SimulatedLocationDataSource; import com.esri.arcgisruntime.location.SimulationParameters; import com.esri.arcgisruntime.mapping.ArcGISMap; import com.esri.arcgisruntime.mapping.view.LocationDisplay; import com.esri.arcgisruntime.mapping.view.MapView; import com.esri.arcgisruntime.portal.Portal; import com.esri.arcgisruntime.portal.PortalItem;  import org.apache.commons.io.IOUtils;  public class SetUpLocationDrivenGeotriggersController {   @FXML private MapView mapView;  @FXML private ImageView gardenSectionImageView;  @FXML private Label currentGardenSectionTitle;  @FXML private Label currentGardenSectionDescription;  @FXML private Label pointsOfInterestTitle;  @FXML private VBox vBox;   private GeotriggerMonitor gardenSectionGeotriggerMonitor;  private GeotriggerMonitor gardenPOIGeotriggerMonitor;  private HashSet<String> names;  private SimulatedLocationDataSource simulatedLocationDataSource;   public void initialize() throws IOException {   // instantiate a new hashset to store unique names of nearby features visited  names = new HashSet<>();   // create a map with a predefined tile basemap, feature styles and labels in the Santa Barbara Botanic Garden and set it to the map view  Portal portal = new Portal("https://www.arcgis.com/");  ArcGISMap map = new ArcGISMap(new PortalItem(portal, "6ab0e91dc39e478cae4f408e1a36a308"));  mapView.setMap(map);   // initialize the simulated location display  initializeSimulatedLocationDisplay();   // once the map has loaded, obtain service feature tables from its list of operational layers  map.addDoneLoadingListener(() -> {   // get the garden section feature table from the map's list of feature layers  FeatureLayer gardenSectionFeatureLayer = (FeatureLayer) map.getOperationalLayers().get(0);  ServiceFeatureTable gardenSectionFeatureTable = (ServiceFeatureTable) gardenSectionFeatureLayer.getFeatureTable();  // get the points of interest feature table from the map's list of feature layers  FeatureLayer gardenPOISectionFeatureLayer = (FeatureLayer) map.getOperationalLayers().get(2);  ServiceFeatureTable gardenPOIFeatureTable = (ServiceFeatureTable) gardenPOISectionFeatureLayer.getFeatureTable();  // set view insets to the map view when the map has loaded  mapView.setViewInsets(new Insets(0, vBox.getWidth(), 0, 0));   // once the simulated location data source has started, set up and start the location display and handle geotriggers  simulatedLocationDataSource.addStatusChangedListener( statusChangedEvent -> {  System.out.println(statusChangedEvent.getStatus());  if (statusChangedEvent.getStatus() == LocationDataSource.Status.STARTED) {   // create, configure and start a location display that follows the simulated location data source  setUpAndStartLocationDisplay();   // create feature fence parameters for the garden section, and for the garden points of interest with a buffer of 10m  FeatureFenceParameters featureFenceParametersGardenSection = new FeatureFenceParameters(gardenSectionFeatureTable);  FeatureFenceParameters featureFenceParametersPOI = new FeatureFenceParameters(gardenPOIFeatureTable, 10);   // define an arcade expression that returns the value for the "name" field of the feature that triggered the monitor  ArcadeExpression arcadeExpression = new ArcadeExpression("$fenceFeature.name");  // create a location geotrigger feed from the simulated location data source  LocationGeotriggerFeed locationGeotriggerFeed = new LocationGeotriggerFeed(simulatedLocationDataSource);   // create fence geotriggers for each of the service feature tables  FenceGeotrigger fenceGeotriggerGardenSection = new FenceGeotrigger(locationGeotriggerFeed, FenceRuleType.ENTER_OR_EXIT,  featureFenceParametersGardenSection, arcadeExpression, "Section Geotrigger");  FenceGeotrigger fenceGeotriggerPOI = new FenceGeotrigger(locationGeotriggerFeed, FenceRuleType.ENTER_OR_EXIT,  featureFenceParametersPOI, arcadeExpression, "POI Geotrigger");   // create geotrigger monitors from the fence geotriggers  gardenSectionGeotriggerMonitor = new GeotriggerMonitor(fenceGeotriggerGardenSection);  gardenPOIGeotriggerMonitor = new GeotriggerMonitor(fenceGeotriggerPOI);  List<GeotriggerMonitor> geotriggerMonitors = new ArrayList<>(Arrays.asList(  gardenSectionGeotriggerMonitor, gardenPOIGeotriggerMonitor));   // for each geotrigger monitor, add a notification event listener, and start the monitor  geotriggerMonitors.forEach(monitor -> {   monitor.addGeotriggerMonitorNotificationEventListener(notificationEvent -> {  // fence geotrigger notification info provides access to the feature that triggered the notification  var fenceGeotriggerNotificationInfo = (FenceGeotriggerNotificationInfo) notificationEvent.getGeotriggerNotificationInfo();   // get the name of the fence feature and geotrigger  String fenceFeatureName = fenceGeotriggerNotificationInfo.getMessage();  String geoTriggerName = fenceGeotriggerNotificationInfo.getGeotriggerMonitor().getGeotrigger().getName();   // determine the notification type on the notification info (entered or exited)  FenceNotificationType fenceNotificationType = fenceGeotriggerNotificationInfo.getFenceNotificationType();  // get a reference to the fence feature that triggered the notification  ArcGISFeature fenceFeature = (ArcGISFeature) fenceGeotriggerNotificationInfo.getFenceGeoElement();   // when entering a given geofence, add the feature's information to the UI  if (fenceNotificationType == FenceNotificationType.ENTERED) {   // add the description from the feature's attributes to the UI  handleAddingFeatureInfoToUI(fenceFeature, fenceFeatureName, geoTriggerName);   } else if (fenceNotificationType == FenceNotificationType.EXITED) {  // when exiting a given geofence, remove its information from the UI  handleRemovingFeatureInfoFromUI(fenceFeatureName, geoTriggerName);  }   });   // start the geotrigger monitor  monitor.startAsync();   });  } else if (statusChangedEvent.getStatus() == LocationDataSource.Status.FAILED_TO_START) {  new Alert(Alert.AlertType.ERROR, "Simulated data location source failed to start").show();  }  });  simulatedLocationDataSource.startAsync();  });  }   /**  * Creates and starts a simulated location data source based on a json file containing a set polyline data path.  */  private void initializeSimulatedLocationDisplay() throws IOException {   // read a json string which contains a set of points collected along a walking route  String polylineData = IOUtils.toString(getClass().getResourceAsStream(  "/set_up_location_driven_geotriggers/polyline_data.json"), StandardCharsets.UTF_8);  // create a polyline representing a walking route from the json string  Polyline locations = (Polyline) Geometry.fromJson(polylineData, SpatialReferences.getWgs84());   // create a new simulated location data source to replicate the path walked around the garden  simulatedLocationDataSource = new SimulatedLocationDataSource();  // set the location of the simulated location data source with simulation parameters with a velocity of 2m/s  simulatedLocationDataSource.setLocations(  locations, new SimulationParameters(Calendar.getInstance(), 2.0, 0.0, 0.0));   // disable map view interaction, the location display will automatically center on the mock device location  mapView.setEnableMousePan(false);  mapView.setEnableKeyboardNavigation(false);   }   /**  * Gets information from the fence geotrigger notification information and the fence feature itself and adds the information  * to the UI either as a formatted string or as an image.  *  * @param fenceFeature the feature  */  private void handleAddingFeatureInfoToUI(ArcGISFeature fenceFeature, String fenceFeatureName, String geoTriggerName) {   // fetch the fence feature's attachments  ListenableFuture<List<Attachment>> attachmentsFuture = fenceFeature.fetchAttachmentsAsync();  // listen for fetch attachments to complete  attachmentsFuture.addDoneListener(() -> {  // get the feature attachments  try {  List<Attachment> attachments = attachmentsFuture.get();  if (!attachments.isEmpty()) {  // get the first (and only) attachment for the feature, which is an image  Attachment imageAttachment = attachments.get(0);  // fetch the attachment's data  ListenableFuture<InputStream> attachmentDataFuture = imageAttachment.fetchDataAsync();  // listen for fetch data to complete  attachmentDataFuture.addDoneListener(() -> {  // get the attachments data as an input stream  try {  InputStream attachmentInputStream = attachmentDataFuture.get();  // save the input stream to a temporary directory and get a reference to its URI  Image imageFromStream = new Image(attachmentInputStream);  attachmentInputStream.close();   // if the geotrigger notification was from entering a garden section, populate the garden section part of the UI  if (geoTriggerName.equals(gardenSectionGeotriggerMonitor.getGeotrigger().getName())) {  // add details to the UI  currentGardenSectionTitle.setText(fenceFeatureName);  // get the first sentence of the description to display in the UI  String firstSentenceOfDescription = fenceFeature.getAttributes().get("description").toString().split("\\.")[0];  currentGardenSectionDescription.setText(firstSentenceOfDescription + ".");  gardenSectionImageView.setImage(imageFromStream);   // if the geotrigger notification was from entering a POI buffer, populate the POI part of the UI  } else if (geoTriggerName.equals(gardenPOIGeotriggerMonitor.getGeotrigger().getName())) {  // add details to the UI  names.add(fenceFeatureName);  String str = String.join(", ", names);  pointsOfInterestTitle.setText(str);  }   } catch (Exception exception) {  exception.printStackTrace();  new Alert(Alert.AlertType.ERROR, "Error getting attachment").show();  }  });  } else new Alert(Alert.AlertType.ERROR, "No attachments to display").show();  } catch (InterruptedException | ExecutionException e) {  e.printStackTrace();  new Alert(Alert.AlertType.ERROR, "Error getting fence feature attachments").show();  }  });   }   /**  * Removes the name of the fence feature being exited from the collection of feature names, and updates the label on the UI.  */  private void handleRemovingFeatureInfoFromUI(String fenceFeatureName, String geoTriggerName) {   // if exiting a garden section, reset the UI to inform the user they are walking on a path  if (geoTriggerName.equals(gardenSectionGeotriggerMonitor.getGeotrigger().getName())) {  currentGardenSectionTitle.setText("On the path");  currentGardenSectionDescription.setText("You are walking between sections");  gardenSectionImageView.setImage(null);   // if exiting a POI buffer, remove the name of the buffer from the list displayed and handle UI for if no features are nearby  } else if (geoTriggerName.equals(gardenPOIGeotriggerMonitor.getGeotrigger().getName())) {  names.remove(fenceFeatureName);  String str = String.join(", ", names);  pointsOfInterestTitle.setText(str);  if (names.isEmpty()) {  pointsOfInterestTitle.setText("No features nearby");  }  }   }   /**  * Creates and sets up a location display from the simulated location data source, and starts it.  */  private void setUpAndStartLocationDisplay() {  // configure the map view's location display to follow the simulated location data source  LocationDisplay locationDisplay = mapView.getLocationDisplay();  locationDisplay.setLocationDataSource(simulatedLocationDataSource);  locationDisplay.setAutoPanMode(LocationDisplay.AutoPanMode.RECENTER);  locationDisplay.setInitialZoomScale(1000);  // start the location display  locationDisplay.startAsync();  }   /**  * Disposes application resources.  */  void terminate() {  if (mapView != null) {  simulatedLocationDataSource.stopAsync();  gardenPOIGeotriggerMonitor.stop();  gardenSectionGeotriggerMonitor.stop();  mapView.dispose();  }  }  }