Update dictionary renderer samples to use new Ordered Anchor Points (#675)

* update dictionary renderer graphics overlay 2D

* Update DictionaryRendererGraphicsOverlay.png

* update graphics overlay dictionary renderer 3d

* Update symbology/graphics-overlay-dictionary-renderer-3D/README.md

Co-authored-by: Jen Merritt <[email protected]>

* Update symbology/graphics-overlay-dictionary-renderer-3D/src/main/java/com/esri/samples/graphics_overlay_dictionary_renderer_3D/GraphicsOverlayDictionaryRenderer3DSample.java

Co-authored-by: Jen Merritt <[email protected]>

* Update symbology/graphics-overlay-dictionary-renderer-3D/src/main/java/com/esri/samples/graphics_overlay_dictionary_renderer_3D/GraphicsOverlayDictionaryRenderer3DSample.java

Co-authored-by: Jen Merritt <[email protected]>

* review comments

Co-authored-by: Jen Merritt <[email protected]>

Author: Rachael-E

display_information/dictionary-renderer-graphics-overlay/DictionaryRendererGraphicsOverlay.png

@@ -1,6 +1,6 @@
 # Dictionary renderer with graphics overlay
 
-Create graphics using a local mil2525d style file and an XML file with key/value pairs for each graphic.
+Create graphics from an XML file with key-value pairs for each graphic, and display the military symbols using a MIL-STD-2525D web style in 2D.
 
 ![Image of dictionary renderer graphics overlay](DictionaryRendererGraphicsOverlay.png)
 
@@ -14,9 +14,9 @@ Run the sample and view the military symbols on the map.
 
 ## How it works
 
-1. Create a new `SymbolDictionary(specificationType, dictionaryPath)`.
-2. Create a new `DictionaryRenderer(symbolDictionary)`.
-3. Create a new `GraphicsOverlay`
+1. Create a new `DictionarySymbolStyle(portalItem)` with a portal item containing a MIL-STD-2525D dictionary web style.
+2. Create a new `DictionaryRenderer` from the dictionary symbol style.
+3. Create a new `GraphicsOverlay`.
 4. Set the  dictionary renderer to the graphics overlay.
 5. Parse through the local XML file creating a map of key/value pairs for each block of attributes.
 6. Create a `Graphic` for each attribute.
@@ -30,6 +30,10 @@ Run the sample and view the military symbols on the map.
 * DictionarySymbolStyle
 * GraphicsOverlay
 
+## About the data
+
+The dictionary symbol style in this sample is constructed from a portal item containing a [MIL-STD-2525D symbol dictionary web style](https://arcgis.com/home/item.html?id=d815f3bdf6e6452bb8fd153b654c94ca). This ArcGIS Web Style is used to build custom applications that incorporate the MIL-STD-2525D symbol dictionary. This style supports a configuration for modeling locations as ordered anchor points or full geometries.
+
 ## Tags
 
-visualization
+defense, military, situational awareness, tactical, visualization

display_information/dictionary-renderer-graphics-overlay/README.md

@@ -1,11 +1,15 @@
 {
     "category": "Display information",
-    "description": "Create graphics using a local mil2525d style file and an XML file with key/value pairs for each graphic.",
+    "description": "Create graphics from an XML file with key-value pairs for each graphic, and display the military symbols using a MIL-STD-2525D web style in 2D.",
     "ignore": false,
     "images": [
         "DictionaryRendererGraphicsOverlay.png"
     ],
     "keywords": [
+        "defense",
+        "military",
+        "situational awareness",
+        "tactical",
         "visualization",
         "DictionaryRenderer",
         "DictionarySymbolStyle",

display_information/dictionary-renderer-graphics-overlay/README.metadata.json

@@ -6,17 +6,12 @@ def ant = new groovy.util.AntBuilder()
 if (!file("./samples-data").exists()) {
     file("./samples-data/xml").mkdirs()
     ant.get(
-            src: "https://arcgisruntime.maps.arcgis.com/sharing/rest/content/items/1e4ea99af4b440c092e7959cf3957bfa/data",
+            src: "https://arcgisruntime.maps.arcgis.com/sharing/rest/content/items/623382e0113d40698538f249e3bcb1c0/data",
             dest: file("./data.zip")
     )
     ant.unzip(
             src: file("./data.zip"),
             dest: file("./samples-data/xml")
     )
     delete file("./data.zip")
-    file("./samples-data/stylx").mkdirs()
-    ant.get(
-            src: "https://arcgisruntime.maps.arcgis.com/sharing/rest/content/items/c78b149a1d52414682c86a5feeb13d30/data",
-            dest: file("./samples-data/stylx/mil2525d.stylx")
-    )
 }

display_information/dictionary-renderer-graphics-overlay/settings.gradle

@@ -1,12 +1,12 @@
 /*
  * 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
@@ -16,35 +16,33 @@
 
 package com.esri.samples.dictionary_renderer_graphics_overlay;
 
-import javax.xml.parsers.DocumentBuilder;
-import javax.xml.parsers.DocumentBuilderFactory;
-import org.w3c.dom.Document;
+import javafx.application.Application;
+import javafx.scene.Scene;
+import javafx.scene.control.Alert;
+import javafx.scene.layout.StackPane;
+import javafx.stage.Stage;
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 
+import javax.xml.parsers.DocumentBuilderFactory;
 import java.io.File;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import javafx.application.Application;
-import javafx.scene.Scene;
-import javafx.scene.layout.StackPane;
-import javafx.stage.Stage;
-
 import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
 import com.esri.arcgisruntime.geometry.Multipoint;
 import com.esri.arcgisruntime.geometry.Point;
 import com.esri.arcgisruntime.geometry.PointCollection;
 import com.esri.arcgisruntime.geometry.SpatialReference;
+import com.esri.arcgisruntime.loadable.LoadStatus;
 import com.esri.arcgisruntime.mapping.ArcGISMap;
 import com.esri.arcgisruntime.mapping.BasemapStyle;
 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.portal.Portal;
+import com.esri.arcgisruntime.portal.PortalItem;
 import com.esri.arcgisruntime.symbology.DictionaryRenderer;
 import com.esri.arcgisruntime.symbology.DictionarySymbolStyle;
 
@@ -54,10 +52,11 @@ public class DictionaryRendererGraphicsOverlaySample extends Application {
   private GraphicsOverlay graphicsOverlay;
 
   @Override
-  public void start(Stage stage) throws Exception {
-    mapView = new MapView();
-    StackPane appWindow = new StackPane(mapView);
-    Scene scene = new Scene(appWindow);
+  public void start(Stage stage) {
+    try {
+    // create stack pane and application scene
+    var stackPane = new StackPane();
+    var scene = new Scene(stackPane);
 
     // set title, size, and add scene to stage
     stage.setTitle("Dictionary Renderer Graphics Overlay Sample");
@@ -70,36 +69,73 @@ public void start(Stage stage) throws Exception {
     String yourAPIKey = System.getProperty("apiKey");
     ArcGISRuntimeEnvironment.setApiKey(yourAPIKey);
 
-    // create a map with the topographic basemap style and set it to the map view
+    // create a map view
+    mapView = new MapView();
+    // create a map with the topographic basemap style
     ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);
-    mapView.setMap(map);
 
     graphicsOverlay = new GraphicsOverlay();
     // graphics no longer show after zooming passed this scale
     graphicsOverlay.setMinScale(1000000);
     mapView.getGraphicsOverlays().add(graphicsOverlay);
 
-    // create symbol dictionary from style file
-    File stylxFile = new File(System.getProperty("data.dir"), "./samples-data/stylx/mil2525d.stylx");
-    DictionarySymbolStyle symbolDictionary = DictionarySymbolStyle.createFromFile(stylxFile.getAbsolutePath());
-
-    // tells graphics overlay how to render graphics with symbol dictionary attributes set
-    DictionaryRenderer renderer = new DictionaryRenderer(symbolDictionary);
-    graphicsOverlay.setRenderer(renderer);
-
-    // parse graphic attributes from a XML file
-    List<Map<String, Object>> messages = parseMessages();
+    // create the dictionary symbol style from the Joint Military Symbology MIL-STD-2525D portal item
+    var portalItem = new PortalItem(new Portal("https://www.arcgis.com/", false), "d815f3bdf6e6452bb8fd153b654c94ca");
+    var dictionarySymbolStyle = new DictionarySymbolStyle(portalItem);
+
+    // add done loading listeners to the map and dictionary symbol style and check they have loaded
+    map.addDoneLoadingListener(() -> {
+      if (map.getLoadStatus() == LoadStatus.LOADED) {
+        dictionarySymbolStyle.addDoneLoadingListener(() -> {
+          if (dictionarySymbolStyle.getLoadStatus() == LoadStatus.LOADED) {
+
+            // find the first configuration setting which has the property name "model",
+            // and set its value to "ORDERED ANCHOR POINT"
+            dictionarySymbolStyle.getConfigurations().stream()
+              .filter(configuration -> configuration.getName().equals("model"))
+              .findFirst()
+              .ifPresent(modelConfiguration -> modelConfiguration.setValue("ORDERED ANCHOR POINT"));
+
+            // create a new dictionary renderer from the dictionary symbol style to render graphics
+            // with symbol dictionary attributes and set it to the graphics overlay renderer
+            var dictionaryRenderer = new DictionaryRenderer(dictionarySymbolStyle);
+            graphicsOverlay.setRenderer(dictionaryRenderer);
+
+            // parse graphic attributes from an XML file following the mil2525d specification
+            try {
+              List<Map<String, Object>> messages = parseMessages();
+
+              // create graphics with attributes and add to graphics overlay
+              List<Graphic> graphics = messages.stream()
+                .map(DictionaryRendererGraphicsOverlaySample::createGraphic)
+                .collect(Collectors.toList());
+              graphicsOverlay.getGraphics().addAll(graphics);
+              // set the viewpoint to the extent of the graphics overlay
+              mapView.setViewpointGeometryAsync(graphicsOverlay.getExtent());
+
+            } catch (Exception e) {
+              e.printStackTrace();
+            }
+          } else {
+            new Alert(Alert.AlertType.ERROR,
+              "Failed to load symbol style " + dictionarySymbolStyle.getLoadError().getCause().getMessage()).show();
+          }
+        });
+      } else {
+        new Alert(Alert.AlertType.ERROR, "Map failed to load" + map.getLoadError().getCause().getMessage()).show();
+      }
+      // load the dictionary symbol style once the map has loaded
+      dictionarySymbolStyle.loadAsync();
+    });
 
-    // create graphics with attributes and add to graphics overlay
-    messages.stream()
-        .map(DictionaryRendererGraphicsOverlaySample::createGraphic)
-        .collect(Collectors.toCollection(() -> graphicsOverlay.getGraphics()));
+    // set the map to the map view and add the map view to the stack pane
+    mapView.setMap(map);
+    stackPane.getChildren().add(mapView);
 
-    // once view has loaded
-    mapView.addSpatialReferenceChangedListener(e -> {
-      // set initial viewpoint
-      mapView.setViewpointGeometryAsync(graphicsOverlay.getExtent());
-    });
+    } catch (Exception ex) {
+      // on any exception, print the stacktrace
+      ex.printStackTrace();
+    }
   }
 
   /**
@@ -108,20 +144,20 @@ public void start(Stage stage) throws Exception {
   private List<Map<String, Object>> parseMessages() throws Exception {
 
     File mil2525dFile = new File(System.getProperty("data.dir"), "./samples-data/xml/Mil2525DMessages.xml");
-    DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
-    DocumentBuilder documentBuilder = documentBuilderFactory.newDocumentBuilder();
-    Document document = documentBuilder.parse(mil2525dFile);
+    var documentBuilderFactory = DocumentBuilderFactory.newInstance();
+    var documentBuilder = documentBuilderFactory.newDocumentBuilder();
+    var document = documentBuilder.parse(mil2525dFile);
     document.getDocumentElement().normalize();
 
     final List<Map<String, Object>> messages = new ArrayList<>();
 
-    for (int i = 0; i < document.getElementsByTagName("message").getLength() ; i++) {
+    for (int i = 0; i < document.getElementsByTagName("message").getLength(); i++) {
       Node message = document.getElementsByTagName("message").item(i);
 
       Map<String, Object> attributes = new HashMap<>();
 
       NodeList childNodes = message.getChildNodes();
-      for (int j = 0; j < childNodes.getLength() ; j++) {
+      for (int j = 0; j < childNodes.getLength(); j++) {
         attributes.put(childNodes.item(j).getNodeName(), childNodes.item(j).getTextContent());
       }
       messages.add(attributes);
@@ -132,7 +168,7 @@ private List<Map<String, Object>> parseMessages() throws Exception {
 
   /**
    * Creates a graphic using a symbol dictionary and the attributes that were passed.
-   * 
+   *
    * @param attributes tells symbol dictionary what symbol to apply to graphic
    */
   private static Graphic createGraphic(Map<String, Object> attributes) {
@@ -141,13 +177,13 @@ private static Graphic createGraphic(Map<String, Object> attributes) {
     int wkid = Integer.parseInt((String) attributes.get("_wkid"));
     SpatialReference sr = SpatialReference.create(wkid);
 
-    // get points from coordinates' string
+    // get points from the coordinate string in the "_control_points" attribute (delimited with ';')
     PointCollection points = new PointCollection(sr);
     String[] coordinates = ((String) attributes.get("_control_points")).split(";");
     Stream.of(coordinates)
-        .map(cs -> cs.split(","))
-        .map(c -> new Point(Double.valueOf(c[0]), Double.valueOf(c[1]), sr))
-        .collect(Collectors.toCollection(() -> points));
+      .map(cs -> cs.split(","))
+      .map(c -> new Point(Double.parseDouble(c[0]), Double.parseDouble(c[1]), sr))
+      .collect(Collectors.toCollection(() -> points));
 
     // return a graphic with multipoint geometry
     return new Graphic(new Multipoint(points), attributes);

display_information/dictionary-renderer-graphics-overlay/src/main/java/com/esri/samples/dictionary_renderer_graphics_overlay/DictionaryRendererGraphicsOverlaySample.java

@@ -1,6 +1,6 @@
 # Graphics overlay dictionary renderer 3D
 
-Display MIL-STD-2525. military symbology in 3D.
+Create graphics from an XML file with key-value pairs for each graphic, and display the military symbols using a MIL-STD-2525D web style in 3D.
 
 ![Image of graphics overlay dictionary renderer 3D](GraphicsOverlayDictionaryRenderer3D.png)
 
@@ -14,24 +14,24 @@ When launched, this sample displays a scene with a dictionary renderer. Pan and
 
 ## How it works
 
-1. Create a `SymbolDictionary` from a dictionary (stylx) file.
-2. Create a `DictionaryRenderer` with the symbol dictionary.
+1. Create a new `DictionarySymbolStyle(portalItem)` with a portal item containing a MIL-STD-2525D dictionary web style.
+2. Create a new `DictionaryRenderer` from the dictionary symbol style.
 3. Set the renderer on a graphics overlay with `graphicsOverlay.setRenderer(dictionaryRenderer)`.
-4. Parse an XML file conforming to the specification. It should have key-value pairs to use as attributes for each graphic:
+4. Parse through the local XML file creating a map of key/value pairs for each block of attributes:
     * Use the name of the XML node as the attribute key and the content of the node as the attribute value.
     * Get the WKID and coordinates from the XML to create the graphic's geometry.
 5. The other attributes such as "symbolentity" and "symbolset" will describe the symbology for the graphic.
 6. Create the graphic with the geometry and attributes and add it to the graphics overlay.
 
 ## Relevant API
 
-* GraphicsOverlay
 * DictionaryRenderer
 * DictionarySymbolStyle
+* GraphicsOverlay
 
 ## Additional information
 
-The dictionary renderer creates these graphics using a local mil2525d style file included in the SDK's resources/symbols directory plus an XML file with key-value attributes for each graphic.
+The dictionary symbol style in this sample is constructed from a portal item containing a [MIL-STD-2525D symbol dictionary web style](https://arcgis.com/home/item.html?id=d815f3bdf6e6452bb8fd153b654c94ca). This ArcGIS Web Style is used to build custom applications that incorporate the MIL-STD-2525D symbol dictionary. This style supports a configuration for modeling locations as ordered anchor points or full geometries.
 
 ## Tags
 

symbology/graphics-overlay-dictionary-renderer-3D/GraphicsOverlayDictionaryRenderer3D.png

@@ -1,6 +1,6 @@
 {
     "category": "Symbology",
-    "description": "Display MIL-STD-2525. military symbology in 3D.",
+    "description": "Create graphics from an XML file with key-value pairs for each graphic, and display the military symbols using a MIL-STD-2525D web style in 3D.",
     "ignore": false,
     "images": [
         "GraphicsOverlayDictionaryRenderer3D.png"

symbology/graphics-overlay-dictionary-renderer-3D/README.md

@@ -39,6 +39,17 @@ dependencies {
     implementation 'org.jooq:joox:1.4.0'
 }
 
+task createGradlePropertiesAndWriteApiKey {
+    description = "Creates a new gradle.properties file with an empty API key variable in the user home ./gradle folder, if the file doesn't already exist."
+    group = "build"
+    def propertiesFile = new File("${System.properties.getProperty("user.home")}/.gradle/gradle.properties")
+    if (!propertiesFile.exists()) {
+        print("Go to " + new URL("https://developers.arcgis.com/dashboard") + " to get an API key.")
+        print(" Add your API key to ${System.properties.getProperty("user.home")}\\.gradle\\gradle.properties.")
+        propertiesFile.write("apiKey = ")
+    }
+}
+
 task copyNatives(type: Copy) {
     description = "Copies the arcgis native libraries into the project build directory for development."
     group = "build"
@@ -50,6 +61,10 @@ task copyNatives(type: Copy) {
 }
 
 run {
+    doFirst {
+        // sets the API key from the gradle.properties file as a Java system property
+        systemProperty 'apiKey', apiKey
+    }
     dependsOn copyNatives
     mainClassName = 'com.esri.samples.graphics_overlay_dictionary_renderer_3D.GraphicsOverlayDictionaryRenderer3DLauncher'
 }

symbology/graphics-overlay-dictionary-renderer-3D/README.metadata.json

@@ -6,17 +6,12 @@ def ant = new groovy.util.AntBuilder()
 if (!file("./samples-data").exists()) {
     file("./samples-data/xml/").mkdirs()
     ant.get(
-            src: "https://arcgisruntime.maps.arcgis.com/sharing/rest/content/items/1e4ea99af4b440c092e7959cf3957bfa/data",
+            src: "https://arcgisruntime.maps.arcgis.com/sharing/rest/content/items/623382e0113d40698538f249e3bcb1c0/data",
             dest: file("./data.zip")
     )
     ant.unzip(
             src: file("./data.zip"),
             dest: file("./samples-data/xml/")
     )
     delete file("./data.zip")
-    file("./samples-data/stylx").mkdirs()
-    ant.get(
-            src: "https://arcgisruntime.maps.arcgis.com/sharing/rest/content/items/c78b149a1d52414682c86a5feeb13d30/data",
-            dest: file("./samples-data/stylx/mil2525d.stylx")
-    )
 }