ArcGIS Runtime SDK for Java

Query Map Image Sublayer

Demonstrates how to execute an attribute and spatial query on the sublayers of an ArcGIS map image layer.

Sublayers of an ArcGISMapImageLayer may expose a ServiceFeatureTable through a Table property. This allows you to perform the same queries available when working with a table from a FeatureLayer: attribute query, spatial query, statistics query, query for related features, and so on.

How it works

To query map image sublayers:

  1. Create an ArcGISMapImageLayer using the URL of it's image service.
  2. After loading the layer, get its sublayers you want to query with ArcGISMapImageLayer.
  3. Load the sublayer, and then get its ArcGISMapImageLayer with sublayer.getTable().
  4. Create QueryParameters. You can use the where clause to query against a table attribute or set the parameters geometry to limit the results to an area of the map.
  5. Call sublayerTable.queryFeaturesAsync(queryParameters) to get a FeatureQueryResult with features matching the query.
  6. Iterate through the result features to use them however you wish.


 * Copyright 2018 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
 * 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.imagelayers.query_map_image_sublayer;

import javafx.application.Application;
import javafx.geometry.Insets;
import javafx.geometry.Pos;
import javafx.scene.Scene;
import javafx.scene.control.Alert;
import javafx.scene.control.Button;
import javafx.scene.control.Label;
import javafx.scene.control.Spinner;
import javafx.scene.layout.Background;
import javafx.scene.layout.BackgroundFill;
import javafx.scene.layout.CornerRadii;
import javafx.scene.layout.StackPane;
import javafx.scene.layout.VBox;
import javafx.scene.paint.Paint;
import javafx.stage.Stage;

import com.esri.arcgisruntime.concurrent.ListenableFuture;
import com.esri.arcgisruntime.geometry.Point;
import com.esri.arcgisruntime.geometry.SpatialReferences;
import com.esri.arcgisruntime.layers.ArcGISMapImageLayer;
import com.esri.arcgisruntime.layers.ArcGISMapImageSublayer;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.Basemap;
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.symbology.SimpleFillSymbol;
import com.esri.arcgisruntime.symbology.SimpleLineSymbol;
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;

public class QueryMapImageSublayerSample extends Application {

  private MapView mapView;

  public void start(Stage stage) {

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

      // size the stage and add a title
      stage.setTitle("Query Map Image Sublayer Sample");

      // create a map with a basemap and set its initial viewpoint
      ArcGISMap map = new ArcGISMap(Basemap.createStreetsVector());
      Point initialLocation = new Point(-12716000.00, 4170400.00, SpatialReferences.getWebMercator());
      Viewpoint viewpoint = new Viewpoint(initialLocation, 6000000);

      // create and add a map image layer to the map
      ArcGISMapImageLayer imageLayer = new ArcGISMapImageLayer("");

      // create a map view and set the map to it
      mapView = new MapView();

      // create a graphics overlay to show the results in
      GraphicsOverlay graphicsOverlay = new GraphicsOverlay();

      // create symbols for showing the results of each sublayer
      SimpleMarkerSymbol citySymbol = new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, 0xFFFF0000, 16);
      SimpleLineSymbol stateSymbol = new SimpleLineSymbol(SimpleLineSymbol.Style.SOLID, 0xFF0000FF, 6);
      SimpleLineSymbol countyLineSymbol = new SimpleLineSymbol(SimpleLineSymbol.Style.DASH, 0xFF00FFFF, 2);
      SimpleFillSymbol countySymbol = new SimpleFillSymbol(SimpleFillSymbol.Style.DIAGONAL_CROSS, 0xFF00FFFF,

      // create a VBox to hold the controls
      VBox controlsVBox = new VBox(6);
      controlsVBox.setBackground(new Background(new BackgroundFill(Paint.valueOf("rgba(0,0,0,0.3)"), CornerRadii.EMPTY,
      controlsVBox.setPadding(new Insets(10.0));
      controlsVBox.setMaxSize(170, 100);

      // create a spinner to input the population filter
      Label label = new Label("Population greater than");
      Spinner<Integer> populationSpinner = new Spinner<>(0, 100000000, 1800000);

      // create a button to execute the query, disable initially
      Button queryButton = new Button("Query");

      // add the controls to the VBox
      controlsVBox.getChildren().addAll(label, populationSpinner, queryButton);

      // wait until the layer is loaded before enabling the query button
      imageLayer.addDoneLoadingListener(() -> {
        if (imageLayer.getLoadStatus() == LoadStatus.LOADED) {

          // get and load each sublayer to query
          ArcGISMapImageSublayer citiesSublayer = (ArcGISMapImageSublayer) imageLayer.getSublayers().get(0);
          ArcGISMapImageSublayer statesSublayer = (ArcGISMapImageSublayer) imageLayer.getSublayers().get(2);
          ArcGISMapImageSublayer countiesSublayer = (ArcGISMapImageSublayer) imageLayer.getSublayers().get(3);

          // query the sublayers when the button is clicked
          queryButton.setOnAction(e -> {

            // clear any previous results

            // create query parameters filtering based on population and the map view's current viewpoint
            QueryParameters populationQuery = new QueryParameters();
            populationQuery.setWhereClause("POP2000 > " + populationSpinner.getValue());

            // query each sublayer's feature table with the query parameters and display the result features as graphics
            if (citiesSublayer.getLoadStatus() == LoadStatus.LOADED) {
              ServiceFeatureTable citiesTable = citiesSublayer.getTable();
              ListenableFuture<FeatureQueryResult> citiesQuery = citiesTable.queryFeaturesAsync(populationQuery);
              citiesQuery.addDoneListener(() -> {
                try {
                  FeatureQueryResult result = citiesQuery.get();
                  for (Feature feature : result) {
                    Graphic cityGraphic = new Graphic(feature.getGeometry(), citySymbol);
                } catch (Exception ex) {
                  new Alert(Alert.AlertType.ERROR, "Failed to query cities").show();

            if (statesSublayer.getLoadStatus() == LoadStatus.LOADED) {
              ServiceFeatureTable statesTable = statesSublayer.getTable();
              ListenableFuture<FeatureQueryResult> statesQuery = statesTable.queryFeaturesAsync(populationQuery);
              statesQuery.addDoneListener(() -> {
                try {
                  FeatureQueryResult result = statesQuery.get();
                  for (Feature feature : result) {
                    Graphic stateGraphic = new Graphic(feature.getGeometry(), stateSymbol);
                } catch (Exception ex) {
                  new Alert(Alert.AlertType.ERROR, "Failed to query states").show();

            if (countiesSublayer.getLoadStatus() == LoadStatus.LOADED) {
              ServiceFeatureTable countiesTable = countiesSublayer.getTable();
              ListenableFuture<FeatureQueryResult> countiesQuery = countiesTable.queryFeaturesAsync(populationQuery);
              countiesQuery.addDoneListener(() -> {
                try {
                  FeatureQueryResult result = countiesQuery.get();
                  for (Feature feature : result) {
                    Graphic countyGraphic = new Graphic(feature.getGeometry(), countySymbol);
                } catch (Exception ex) {
                  new Alert(Alert.AlertType.ERROR, "Failed to query counties").show();

        } else {
          new Alert(Alert.AlertType.ERROR,  imageLayer.getLoadError().getMessage()).show();

      // add the mapview and controls to the stack pane
      stackPane.getChildren().addAll(mapView, controlsVBox);
      StackPane.setAlignment(controlsVBox, Pos.TOP_LEFT);
      StackPane.setMargin(controlsVBox, new Insets(10, 0, 0, 10));

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

  public void stop() {

    // releases resources when the application closes
    if (mapView != null) {

   * Starting point of this application.
   * @param args arguments to this application.
  public static void main(String[] args) {


In this topic
  1. How it works
  2. Code