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(List<String> keywords)
Finds SymbolProperties associated with the given keyword list.
List<SymbolProperties> findSymbols(Map<String, List<String>> filters)
Finds SymbolProperties associated with the given filters.
List<SymbolProperties> findSymbols(List<String> keywords, Map<String, List<String>> filters)
Finds SymbolProperties associated with the given keywords and filters.
Set<String> getFilterNames()
This method is deprecated. use getFilters() instead
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.

[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: 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: SymbolDictionary.DictionaryType of the dictionary to be created
resourcePath String: 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
List<SymbolProperties> a list of SymbolProperties.
Throws
IOException the IO exception

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

Finds SymbolProperties associated with the given keyword list.

Parameters
keywords List: keyword list.
Returns
List<SymbolProperties> a list ofSymbolProperties.
Throws
IOException the IO exception

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

Finds SymbolProperties associated with the given filters.

Parameters
filters Map: filter map.
Returns
List<SymbolProperties> a list of SymbolProperties.

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

Finds SymbolProperties associated with the given keywords and filters.

Parameters
keywords List: keyword list.
filters Map: filter map.
Returns
List<SymbolProperties> a list of SymbolProperties.

public Set<String> getFilterNames ()

This method is deprecated.
use getFilters() instead

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

Returns
Set<String> a Set of filter names

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

Returns available filters for this symbol dictionary.

Returns
Map<String, List<String>> 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
List<String> 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 String: Name of the symbol to get the image for
bitmapImage Bitmap: output Bitmap parameter
Returns
boolean true if the symbol was successfully generated, false otherwise.