Display subtype feature layer

/*
 * Copyright 2022 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.
 */

module com.esri.samples.display_subtype_feature_layer {
  // require ArcGIS Maps SDK for Java module
  requires com.esri.arcgisruntime;

  // handle SLF4J http://www.slf4j.org/codes.html#StaticLoggerBinder
  requires org.slf4j.nop;

  // require JavaFX modules that the application uses
  requires javafx.graphics;
  requires javafx.controls;
  requires javafx.fxml;

  // make all @FXML annotated objects reflectively accessible to the javafx.fxml module
  opens com.esri.samples.display_subtype_feature_layer to javafx.fxml;

  exports com.esri.samples.display_subtype_feature_layer;
}

/*
 * Copyright 2019 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.display_subtype_feature_layer;

import javafx.beans.binding.Bindings;
import javafx.fxml.FXML;
import javafx.scene.control.Alert;
import javafx.scene.control.CheckBox;
import javafx.scene.control.Label;
import javafx.scene.layout.VBox;
import javafx.scene.paint.Color;

import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.arcgisservices.LabelDefinition;
import com.esri.arcgisruntime.arcgisservices.LabelingPlacement;
import com.esri.arcgisruntime.data.ServiceFeatureTable;
import com.esri.arcgisruntime.geometry.Envelope;
import com.esri.arcgisruntime.geometry.SpatialReferences;
import com.esri.arcgisruntime.layers.SubtypeFeatureLayer;
import com.esri.arcgisruntime.layers.SubtypeSublayer;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.BasemapStyle;
import com.esri.arcgisruntime.mapping.labeling.SimpleLabelExpression;
import com.esri.arcgisruntime.mapping.Viewpoint;
import com.esri.arcgisruntime.mapping.view.MapView;
import com.esri.arcgisruntime.security.UserCredential;
import com.esri.arcgisruntime.symbology.Renderer;
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
import com.esri.arcgisruntime.symbology.SimpleRenderer;
import com.esri.arcgisruntime.symbology.Symbol;
import com.esri.arcgisruntime.symbology.TextSymbol;

public class DisplaySubtypeFeatureLayerController {

  @FXML private MapView mapView;
  @FXML private Label currentMapScaleLabel;
  @FXML private Label minScaleLabel;
  @FXML private CheckBox sublayerVisibilityCheckbox;
  @FXML private VBox vBox;

  private Renderer originalRenderer;
  private Renderer alternativeRenderer;
  private SubtypeSublayer sublayer;

  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 add it to the map view
      ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_STREETS_NIGHT);
      mapView.setMap(map);

      // display the current map scale
      currentMapScaleLabel.textProperty().bind(Bindings.createStringBinding(() -> {
        return "Current map scale: 1:" + Math.round(mapView.mapScaleProperty().get());
      }, mapView.mapScaleProperty()));

      // set a viewpoint on the map view, to Naperville, Illinois
      Viewpoint initialViewpoint = new Viewpoint(new Envelope(-9812691.11079696, 5128687.20710657,
        -9812377.9447607, 5128865.36767282, SpatialReferences.getWebMercator()));
      mapView.setViewpoint(initialViewpoint);

      // create a subtype feature layer from the service feature table, and add it to the map
      ServiceFeatureTable serviceFeatureTable = new ServiceFeatureTable(
        "https://sampleserver7.arcgisonline.com/server/rest/services/UtilityNetwork/NapervilleElectric/FeatureServer/0");

      // set user credentials to authenticate with the service
      UserCredential userCredential = new UserCredential("viewer01", "I68VGU^nMurF");
      serviceFeatureTable.setCredential(userCredential);

      SubtypeFeatureLayer subtypeFeatureLayer = new SubtypeFeatureLayer(serviceFeatureTable);
      map.getOperationalLayers().add(subtypeFeatureLayer);

      // create a text symbol for styling the sublayer label definition
      var textSymbol = new TextSymbol();
      textSymbol.setSize(12);
      textSymbol.setOutlineColor(Color.WHITE);
      textSymbol.setColor(Color.BLUE);
      textSymbol.setHaloColor(Color.WHITE);
      textSymbol.setHaloWidth(3);

      // create a label definition with a simple label expression
      var simpleLabelExpression = new SimpleLabelExpression("[nominalvoltage]");
      var labelDefinition = new LabelDefinition(simpleLabelExpression, textSymbol);
      labelDefinition.setPlacement(LabelingPlacement.POINT_ABOVE_RIGHT);
      labelDefinition.setUseCodedValues(true);

      // load the subtype feature layer
      subtypeFeatureLayer.loadAsync();
      subtypeFeatureLayer.addDoneLoadingListener(() -> {
        if (subtypeFeatureLayer.getLoadStatus() == LoadStatus.LOADED) {
          // show the UI for interaction with the sublayer once it has loaded
          vBox.setVisible(true);

          // get the Street Light sublayer and define its labels
          sublayer = subtypeFeatureLayer.getSublayerWithSubtypeName("Street Light");
          sublayer.setLabelsEnabled(true);
          sublayer.getLabelDefinitions().add(labelDefinition);

          // get the original renderer of the sublayer (white and black circular icon)
          originalRenderer = sublayer.getRenderer();
          // create a custom renderer for the sublayer (light pink diamond symbol)
          Symbol symbol = new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.DIAMOND, Color.LIGHTPINK, 20);
          alternativeRenderer = new SimpleRenderer(symbol);
        } else {
          new Alert(Alert.AlertType.ERROR, "Failed to load feature layer").show();
        }
      });

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

  /**
   * Sets the minimum scale of the labels for the sublayer.
   */
  @FXML
  private void handleMinScaleButtonClicked() {
    sublayer.setMinScale(mapView.getMapScale());
    minScaleLabel.setText("Sublayer min scale: 1:" + Math.round(sublayer.getMinScale()));
  }

  /**
   * Sets the visibility of the sublayer.
   */
  @FXML
  private void handleSublayerVisibility() {
    sublayer.setVisible(sublayerVisibilityCheckbox.isSelected());
  }

  /**
   * Sets the renderer of the sublayer to its original format (a white and black circular icon).
   */
  @FXML
  private void handleOriginalRendererButtonClicked() {
    sublayer.setRenderer(originalRenderer);
  }

  /**
   * Sets the renderer of the sublayer to that of a pink diamond symbol.
   */
  @FXML
  private void handleAlternativeRendererButtonClicked() {
    sublayer.setRenderer(alternativeRenderer);
  }

  /**
   * Disposes application resources.
   */
  void terminate() {
    if (mapView != null) {
      mapView.dispose();
    }
  }

}

/*
 * Copyright 2019 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.display_subtype_feature_layer;

import java.io.IOException;

import javafx.application.Application;
import javafx.fxml.FXMLLoader;
import javafx.scene.Parent;
import javafx.scene.Scene;
import javafx.stage.Stage;

public class DisplaySubtypeFeatureLayerSample extends Application {

  private static DisplaySubtypeFeatureLayerController controller;

  @Override
  public void start(Stage stage) throws IOException {

    FXMLLoader loader = new FXMLLoader(getClass().getResource("/display_subtype_feature_layer/main.fxml"));
    Parent root = loader.load();
    controller = loader.getController();
    Scene scene = new Scene(root);

    // set up the stage
    stage.setTitle("Display subtype feature layer sample");
    stage.setWidth(800);
    stage.setHeight(700);
    stage.setScene(scene);
    stage.show();
  }

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

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

    Application.launch(args);
  }

}