public class

SymbolDictionary

extends Object
java.lang.Object
   ↳ com.esri.core.symbol.advanced.SymbolDictionary

Class Overview

The SymbolDictionary class contains functionality to get information about the dictionary including lists of symbols and their associated information.

Summary

Nested Classes
enum SymbolDictionary.DictionaryType Enumeration of the supported types of dictionary. 
Public Constructors
SymbolDictionary(SymbolDictionary.DictionaryType type)
Constructor requiring the type of dictionary to be created.
SymbolDictionary(SymbolDictionary.DictionaryType type, String resourcePath)
Constructor requiring the type of dictionary to be created and the path to the dictionary file on the device.
Public Methods
List<SymbolProperties> findSymbols()
Finds all the SymbolProperties in the dictionary.
List<SymbolProperties> findSymbols(Map<String, List<String>> filters)
Finds SymbolProperties associated with the given filters.
List<SymbolProperties> findSymbols(List<String> keywords)
Finds SymbolProperties associated with the given keyword list.
List<SymbolProperties> findSymbols(List<String> keywords, Map<String, List<String>> filters)
Finds SymbolProperties associated with the given keywords and filters.
Set<String> getFilterNames()
Returns the names of the available filters for this symbol dictionary.@deprecated
List<String> getFilterValues(String filterName)
This method is deprecated. No replacement.
Map<String, List<String>> getFilters()
Returns available filters for this symbol dictionary.
List<String> getKeywords()
Returns the available keywords for this symbol dictionary.
boolean getSymbolImage(String symbolName, Bitmap bitmapImage)

Gets a Bitmap of the symbol which name has been provided.

List<String> getSymbolKeywords(String symbolName)
This method is deprecated. No replacement.
List<String> getSymbolNames(SymbolDictionaryQuery query)
This method is deprecated. No replacement.
Map<String, String> getSymbolValues(String symbolName)
This method is deprecated. No replacement.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public SymbolDictionary (SymbolDictionary.DictionaryType type)

Constructor requiring the type of dictionary to be created.

Parameters
type SymbolDictionary.DictionaryType of the dictionary to be created
Throws
FileNotFoundException if the dictionary cannot be found on the device at the default location

public SymbolDictionary (SymbolDictionary.DictionaryType type, String resourcePath)

Constructor requiring the type of dictionary to be created and the path to the dictionary file on the device.

Parameters
type SymbolDictionary.DictionaryType of the dictionary to be created
resourcePath path to the dictionary file on the device
Throws
FileNotFoundException if the dictionary cannot be found on the device at the location provided

Public Methods

public List<SymbolProperties> findSymbols ()

Finds all the SymbolProperties in the dictionary.

Returns
  • a list of SymbolProperties.
Throws
IOException the IO exception

public List<SymbolProperties> findSymbols (Map<String, List<String>> filters)

Finds SymbolProperties associated with the given filters.

Parameters
filters filter map.
Returns

public List<SymbolProperties> findSymbols (List<String> keywords)

Finds SymbolProperties associated with the given keyword list.

Parameters
keywords keyword list.
Returns
Throws
IOException the IO exception

public List<SymbolProperties> findSymbols (List<String> keywords, Map<String, List<String>> filters)

Finds SymbolProperties associated with the given keywords and filters.

Parameters
keywords keyword list.
filters filter map.
Returns

public Set<String> getFilterNames ()

Returns the names of the available filters for this symbol dictionary.@deprecated

Returns
  • a Set of filter names

public List<String> getFilterValues (String filterName)

This method is deprecated.
No replacement.

Returns the possible values for the filter passed in parameter.

Parameters
filterName the name of the filter to retrieve the values for
Returns

public Map<String, List<String>> getFilters ()

Returns available filters for this symbol dictionary.

Returns
  • an map in which key is the filter name and the value is a list of possible values.

public List<String> getKeywords ()

Returns the available keywords for this symbol dictionary.

Returns
  • a list of keywords

public boolean getSymbolImage (String symbolName, Bitmap bitmapImage)

Gets a Bitmap of the symbol which name has been provided.
Passing the output Bitmap as a parameter allows the user to manage the Bitmap as they see fit.

Parameters
symbolName Name of the symbol to get the image for
bitmapImage output Bitmap parameter
Returns
  • true if the symbol was successfully generated, false otherwise.

public List<String> getSymbolKeywords (String symbolName)

This method is deprecated.
No replacement.

Returns the available keywords for the symbol passed in parameter.

Parameters
symbolName the name of the symbol to retrieve the keywords for
Returns
  • the symbol keywords

public List<String> getSymbolNames (SymbolDictionaryQuery query)

This method is deprecated.
No replacement.

Returns all the symbol names corresponding to the query passed in parameter for this symbol dictionary.

Parameters
query the query used to search the symbol names
Returns
  • a List of symbol names

public Map<String, String> getSymbolValues (String symbolName)

This method is deprecated.
No replacement.

Returns the available values for the Category, SymbolId and style for the symbol passed in parameter.

Parameters
symbolName the name of the symbol to retrieve the values for
Returns
  • a Map of values