Search symbol dictionary

View on GitHub
Sample viewer app

Find symbols within the mil2525d specification that match a keyword.

Image of search symbol dictionary

Use case

You can use support for military symbology to allow users to report changes in the field using the correct military symbols.

How to use the sample

By default, leaving the fields blank and hitting search will find all symbols.

To search for certain symbols, enter text into one or more search boxes and click "Search for symbols". Results are shown in a list. Pressing "Clear" will reset the search.

How it works

  1. Create a symbol dictionary with the mil2525d specification by passing the path to a .stylx file to the SymbolDictionary.createFromFile(path) constructor.
  2. Create StyleSymbolSearchParameters.
  3. Add members to the names, tags, symbolClasses, categories, and keys list fields of the search parameters.
  4. Search for symbols using the parameters with symbolDictionary.searchSymbolsAsync(styleSymbolSearchParameters).
  5. Get the Symbol from the list of returned StyleSymbolSearchResults.

Relevant API

  • StyleSymbolSearchParameters
  • StyleSymbolSearchResult
  • Symbol
  • SymbolDictionary

Additional information

This sample features the mil2525D specification. ArcGIS Runtime supports other military symbology standards, including mil2525C and mil2525B(change 2). See the Military Symbology Styles overview on ArcGIS Solutions for Defense for more information about support for military symbology.

While developing, you can omit the path to the .stylx style file; Runtime will refer to a copy installed with the SDK. For production, you should take care to deploy the proper style files and explicitly specify the path to that file when creating the symbol dictionary. See the Military Symbology Styles overview on ArcGIS Solutions for Defense for more information about support for military symbology.

Tags

CIM, defense, look up, MIL-STD-2525B, MIL-STD-2525C, MIL-STD-2525D, mil2525b, mil2525c, mil2525d, military, military symbology, search, symbology

Sample Code

SymbolDictionaryController.javaSymbolDictionarySample.javaSymbolView.javamain.fxmlsymbol_view.fxml
                                                                                                                        
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
/*
 * 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.symbol_dictionary;

import java.io.File;
import java.util.List;
import java.util.concurrent.ExecutionException;
import java.util.stream.Collectors;

import javafx.collections.FXCollections;
import javafx.collections.ListChangeListener;
import javafx.collections.ObservableList;
import javafx.fxml.FXML;
import javafx.scene.control.ListView;
import javafx.scene.control.Pagination;
import javafx.scene.control.TextField;
import javafx.scene.text.Text;

import com.esri.arcgisruntime.concurrent.ListenableFuture;
import com.esri.arcgisruntime.symbology.DictionarySymbolStyle;
import com.esri.arcgisruntime.symbology.SymbolStyleSearchParameters;
import com.esri.arcgisruntime.symbology.SymbolStyleSearchResult;

public class SymbolDictionaryController {

  @FXML private TextField nameField;
  @FXML private TextField tagField;
  @FXML private TextField symbolClassField;
  @FXML private TextField categoryField;
  @FXML private TextField keyField;
  @FXML private Text searchResultsFound;
  @FXML private Pagination resultPages;

  private ObservableList<SymbolStyleSearchResult> results;
  private DictionarySymbolStyle dictionarySymbol;
  private static final int MAX_RESULTS_PER_PAGE = 20;

  public void initialize() {
    // loads a specification for the symbol dictionary
    File stylxFile = new File(System.getProperty("data.dir"), "./samples-data/stylx/mil2525d.stylx");
    dictionarySymbol = DictionarySymbolStyle.createFromFile(stylxFile.getAbsolutePath());
    dictionarySymbol.loadAsync();

    // initialize result list
    results = FXCollections.observableArrayList();

    // add listener to update pagination control when results change
    results.addListener((ListChangeListener<SymbolStyleSearchResult>) e -> {
      int resultSize = results.size();
      resultPages.setPageCount(resultSize / MAX_RESULTS_PER_PAGE + 1);
      resultPages.setCurrentPageIndex(0);
      resultPages.setPageFactory(pageIndex -> {
        ListView<SymbolView> resultsList = new ListView<>();
        int start = pageIndex * MAX_RESULTS_PER_PAGE;
        List<SymbolView> resultViews = results.subList(start, Math.min(start + MAX_RESULTS_PER_PAGE, results.size()))
          .stream()
          .map(SymbolView::new)
          .collect(Collectors.toList());
        resultsList.getItems().addAll(resultViews);
        return resultsList;
      });
    });
  }

  /**
   * Searches through the symbol dictionary using the text from the search fields.
   */
  @FXML
  private void handleSearchAction() {
    // get parameters from input fields
    SymbolStyleSearchParameters searchParameters = new SymbolStyleSearchParameters();
    searchParameters.getNames().add(nameField.getText());
    searchParameters.getTags().add(tagField.getText());
    searchParameters.getSymbolClasses().add(symbolClassField.getText());
    searchParameters.getCategories().add(categoryField.getText());
    searchParameters.getKeys().add(keyField.getText());

    // search for any matching symbols
    ListenableFuture<List<SymbolStyleSearchResult>> search = dictionarySymbol.searchSymbolsAsync(searchParameters);
    search.addDoneListener(() -> {
      try {
        // update the result list (triggering the listener)
        List<SymbolStyleSearchResult> searchResults = search.get();
        searchResultsFound.setText(String.valueOf(searchResults.size()));
        results.clear();
        results.addAll(searchResults);
      } catch (ExecutionException | InterruptedException e) {
        e.printStackTrace();
      }
    });
  }

  /**
   * Clears search results and any text in the search fields.
   */
  @FXML
  private void handleClearAction() {
    nameField.clear();
    tagField.clear();
    symbolClassField.clear();
    categoryField.clear();
    keyField.clear();
    results.clear();
    searchResultsFound.setText("");
  }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.