com.esri.core.symbol.advanced
Class SymbolDictionaryQuery

java.lang.Object
  extended by com.esri.core.symbol.advanced.SymbolDictionaryQuery

public class SymbolDictionaryQuery
extends Object

The SymbolDictionaryQuery class is used to build up queries against the symbol dictionary to return a list of symbols.
You can search symbols by filtering the dictionary with SymbolDictionaryFilters and/or keywords.

Since:
1.1

Constructor Summary
SymbolDictionaryQuery()
           
 
Method Summary
 void addFilter(SymbolDictionaryFilter filter)
          Adds a filter to the query.
 void addKeyword(String keyword)
          Adds a keyword to the query.
 void clear()
          Clears the query (removes all filters and keywords).
 List<SymbolDictionaryFilter> getFilters()
          Returns all the filters currently held in the query.
 List<String> getKeywords()
          Returns all the keywords currently held in the query.
 void removeFilter(SymbolDictionaryFilter filter)
          Removes the filter passed in parameter from the query.
 void removeKeyword(String keyword)
          Removes the keyword passed in parameter from the query.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SymbolDictionaryQuery

public SymbolDictionaryQuery()
Method Detail

addFilter

public void addFilter(SymbolDictionaryFilter filter)
Adds a filter to the query.

Parameters:
filter - the SymbolDictionaryFilter to add
Since:
1.1

addKeyword

public void addKeyword(String keyword)
Adds a keyword to the query.

Parameters:
keyword - the keyword to add
Since:
1.1

clear

public void clear()
Clears the query (removes all filters and keywords).

Since:
1.1

getFilters

public List<SymbolDictionaryFilter> getFilters()
Returns all the filters currently held in the query.

Returns:
a List of SymbolDictionaryFilter
Since:
1.1

getKeywords

public List<String> getKeywords()
Returns all the keywords currently held in the query.

Returns:
a List of keywords
Since:
1.1

removeFilter

public void removeFilter(SymbolDictionaryFilter filter)
Removes the filter passed in parameter from the query.

Parameters:
filter - the SymbolDictionaryFilter to remove
Since:
1.1

removeKeyword

public void removeKeyword(String keyword)
Removes the keyword passed in parameter from the query.

Parameters:
keyword - the keyword to remove
Since:
1.1


Copyright © 2010. All Rights Reserved.