com.esri.core.symbol.advanced
Class SymbolDictionary

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

public class SymbolDictionary
extends Object

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

Nested Class Summary

static class

SymbolDictionary.DictionaryType Enumeration of the supported types of dictionary

Constructor Summary

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.

Method Summary

Set<String>	getFilterNames() Returns the names of the available filters for this symbol dictionary
List<String>	getFilterValues(String filterName) Returns the possible values for the filter passed in parameter.
List<String>	getKeywords() Returns the available keywords for this symbol dictionary.
boolean	getSymbolImage(String symbolName, android.graphics.Bitmap bitmapImage) Gets a Bitmap of the symbol which name has been provided.
List<String>	getSymbolKeywords(String symbolName) Returns the available keywords for the symbol passed in parameter.
List<String>	getSymbolNames(SymbolDictionaryQuery query) Returns all the symbol names corresponding to the query passed in parameter for this symbol dictionary.
Map<String,String>	getSymbolValues(String symbolName) Returns the available values for the Category, SymbolId and style for the symbol passed in parameter.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SymbolDictionary

public SymbolDictionary(SymbolDictionary.DictionaryType type)
                 throws FileNotFoundException

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

SymbolDictionary

public SymbolDictionary(SymbolDictionary.DictionaryType type,
                        String resourcePath)
                 throws FileNotFoundException

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

Method Detail

getSymbolImage

public boolean getSymbolImage(String symbolName,
                              android.graphics.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.

getFilterNames

public Set<String> getFilterNames()

Returns the names of the available filters for this symbol dictionary

Returns:

a Set of filter names

getFilterValues

public List<String> getFilterValues(String filterName)

Returns the possible values for the filter passed in parameter.

Parameters:

filterName - the name of the filter to retrieve the values for

Returns:

a List of values (as Strings)

getKeywords

public List<String> getKeywords()

Returns the available keywords for this symbol dictionary.

Returns:

a List of keywords

getSymbolKeywords

public List<String> getSymbolKeywords(String symbolName)

Returns the available keywords for the symbol passed in parameter.

Parameters:

symbolName - the name of the symbol to retrieve the keywords for

getSymbolNames

public List<String> getSymbolNames(SymbolDictionaryQuery query)

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

getSymbolValues

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

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