ArcGIS Runtime SDK for Java

Local Server Map Image Layer

Demonstrates how to start a Local Server and Local Map Service, then create a Map Image Layer from the Local Map Service and add it to a map.

Note: Local Server is not supported on MacOS

How it works

To create a ArcGISMapImageLayer from a LocalMapService:

  1. Create and run a local server.

    • LocalServer.INSTANCE creates a local server
    • Server.startAsync() starts the server asynchronously

  2. Wait for server to be in the LocalServerStatus.STARTED state.

    • Server.addStatusChangedListener() fires whenever the status of the local server has changed.

  3. Create and run a local map service.

    • new LocalMapService(Url), creates a local map service with the given url path to mpk file
    • LocalMapService.startAsync(), starts the service asynchronously
    • service will be added to the local server automatically

  4. Wait for map service to be in the LocalServerStatus.STARTED state.

    • LocalMapService.addStatusChangedListener() fires whenever the status of the local service has changed.

  5. Create a map image layer from local map service.

    • create a new ArcGISMapImageLayer(Url) from local map service url, LocalMapService.getUrl()
    • load the layer asynchronously, ArcGISMapImageLayer.loadAsync()

  6. Add map image layer to map, Map.getOperationalLayers().add(ArcGISMapImageLayer).

Code

/*
 * 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
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.esri.samples.localserver.local_server_map_image_layer;

import java.io.File;

import javafx.application.Application;
import javafx.application.Platform;
import javafx.geometry.Pos;
import javafx.scene.Scene;
import javafx.scene.control.Alert;
import javafx.scene.control.Alert.AlertType;
import javafx.scene.control.ProgressIndicator;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;

import com.esri.arcgisruntime.layers.ArcGISMapImageLayer;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.localserver.LocalMapService;
import com.esri.arcgisruntime.localserver.LocalServer;
import com.esri.arcgisruntime.localserver.LocalServerStatus;
import com.esri.arcgisruntime.localserver.LocalService.StatusChangedEvent;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.Basemap;
import com.esri.arcgisruntime.mapping.Viewpoint;
import com.esri.arcgisruntime.mapping.view.MapView;

public class LocalServerMapImageLayerSample extends Application {

  private static final int APPLICATION_WIDTH = 800;

  private MapView mapView;
  private LocalMapService mapImageService;
  private ProgressIndicator imageLayerProgress;

  @Override
  public void start(Stage stage) {

    try {
      // create stack pane and application scene
      StackPane stackPane = new StackPane();
      Scene scene = new Scene(stackPane);

      // set title, size, and add scene to stage
      stage.setTitle("Local Server Map Image Layer Sample");
      stage.setWidth(APPLICATION_WIDTH);
      stage.setHeight(700);
      stage.setScene(scene);
      stage.show();

      // create a view with a map and basemap
      ArcGISMap map = new ArcGISMap(Basemap.createStreets());
      mapView = new MapView();
      mapView.setMap(map);

      // track progress of loading map image layer to map
      imageLayerProgress = new ProgressIndicator(ProgressIndicator.INDETERMINATE_PROGRESS);
      imageLayerProgress.setMaxWidth(30);

      // check that local server install path can be accessed
      if (LocalServer.INSTANCE.checkInstallValid()) {
        LocalServer server = LocalServer.INSTANCE;
        // start local server
        server.addStatusChangedListener(status -> {
          if (status.getNewStatus() == LocalServerStatus.STARTED) {
            // start map image service
            String mapServiceURL = new File("./samples-data/local_server/RelationshipID.mpk").getAbsolutePath();
            mapImageService = new LocalMapService(mapServiceURL);
            mapImageService.addStatusChangedListener(this::addLocalMapImageLayer);
            mapImageService.startAsync();
          }
        });
        server.startAsync();
      } else {
        Platform.runLater(() -> {
          Alert dialog = new Alert(AlertType.INFORMATION);
          dialog.setHeaderText("Local Server Load Error");
          dialog.setContentText("Local Geoprocessing Failed to load.");
          dialog.showAndWait();

          Platform.exit();
        });
      }

      // add view to application window with progress bar
      stackPane.getChildren().addAll(mapView, imageLayerProgress);
      StackPane.setAlignment(imageLayerProgress, Pos.CENTER);
    } catch (Exception e) {
      // on any error, display the stack trace.
      e.printStackTrace();
    }
  }

  /**
   * Once the map service starts, a map image layer is created from that service and added to the map.
   * <p>
   * When the map image layer is done loading, the view will zoom to the location of were the image has been added.
   * 
   * @param status status of feature service
   */
  private void addLocalMapImageLayer(StatusChangedEvent status) {

    // check that the map service has started
    if (status.getNewStatus() == LocalServerStatus.STARTED) {
      // get the url of where map service is located
      String url = mapImageService.getUrl();
      // create a map image layer using url
      ArcGISMapImageLayer imageLayer = new ArcGISMapImageLayer(url);
      // set viewpoint once layer has loaded
      imageLayer.addDoneLoadingListener(() -> {
        if (imageLayer.getLoadStatus() == LoadStatus.LOADED && imageLayer.getFullExtent() != null) {
          mapView.setViewpoint(new Viewpoint(imageLayer.getFullExtent()));
          Platform.runLater(() -> imageLayerProgress.setVisible(false));
        } else {
          Alert alert = new Alert(Alert.AlertType.ERROR, "Image Layer Failed to Load!");
          alert.show();
        }
      });
      imageLayer.loadAsync();
      // add image layer to map
      mapView.getMap().getOperationalLayers().add(imageLayer);
    }
  }

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

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

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

    Application.launch(args);
  }
}


In this topic
  1. How it works
  2. Code