org.mdiutil.text.autocomplete

Class AutoCompleteDictionary

java.lang.Object

org.mdiutil.text.autocomplete.AutoCompleteDictionary

public class AutoCompleteDictionary
extends Object

The AutoComplete Dictionnary.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AutoCompleteDictionary.Category Represents a category of results in the dictionnary.
static interface	AutoCompleteDictionary.Item A common interface for items to use for the Autocomplete.

Constructor Summary

Constructors

Constructor and Description
AutoCompleteDictionary()

Method Summary

Modifier and Type	Method and Description
void	acceptDuplicates(boolean acceptDuplicates) Set if the dictionnary accept duplicates.
boolean	addCategory(AutoCompleteDictionary.Category category) Add a Category to the dictionary.
AutoCompleteDictionary.Category	addCategory(String name) Add a Category to the dictionary.
boolean	addToDictionary(AutoCompleteDictionary.Item item) Add an item to the dictionary to use for the autoComplete.
boolean	addToDictionary(String word) Add a word to the dictionary to use for the autoComplete.
boolean	addToDictionary(String category, AutoCompleteDictionary.Item item) Add an item to the dictionary to use for the autoComplete.
boolean	addToDictionary(String category, String word) Add a word to the dictionary to use for the autoComplete.
Map<String,AutoCompleteDictionary.Category>	getCategories() Return the map of categories.
List<AutoCompleteDictionary.Category>	getDictionary() Return the dictionary.
boolean	hasDefaultCategory() Return true if the dictionnary uses only the default category.
boolean	isAcceptingDuplicates() Return true if the dictionnary accept duplicates.
boolean	removeCategory(AutoCompleteDictionary.Category category) Remove a category from the dictionary.
boolean	removeCategory(String name) Remove a category from the dictionary.
boolean	removeFromDictionary(AutoCompleteDictionary.Item item) Remove an item from the dictionary to use for the autoComplete.
boolean	removeFromDictionary(String word) Remove a word from the dictionary to use for the autoComplete.
boolean	removeFromDictionary(String category, AutoCompleteDictionary.Item item) Remove an item from the dictionary to use for the autoComplete.
boolean	removeFromDictionary(String category, String word) Remove a word from the dictionary to use for the autoComplete.
void	reset() Reset the Dictionnary to use for the autoComplete.

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoCompleteDictionary

public AutoCompleteDictionary()

Method Detail

acceptDuplicates

public void acceptDuplicates(boolean acceptDuplicates)

Set if the dictionnary accept duplicates.

Parameters:

acceptDuplicates - true if the dictionnary accept duplicates

isAcceptingDuplicates

public boolean isAcceptingDuplicates()

Return true if the dictionnary accept duplicates.

Returns:

true if the dictionnary accept duplicates

hasDefaultCategory

public boolean hasDefaultCategory()

Return true if the dictionnary uses only the default category.

Returns:

true if the dictionnary uses only the default category

addCategory

public boolean addCategory(AutoCompleteDictionary.Category category)

Add a Category to the dictionary. Note that if a category with the same name already exists, the existing category will be returned.

Parameters:

category - the category

Returns:

true if the category did not previously exist

addCategory

public AutoCompleteDictionary.Category addCategory(String name)

Add a Category to the dictionary. Note that if a category with the same name already exists, the existing category will be returned.

Parameters:

name - the category name

Returns:

the category

removeCategory

public boolean removeCategory(AutoCompleteDictionary.Category category)

Remove a category from the dictionary.

Parameters:

category - the category

Returns:

true if the category did previously exist

removeCategory

public boolean removeCategory(String name)

Remove a category from the dictionary.

Parameters:

name - the category name

Returns:

true if a category was removed

reset

public void reset()

Reset the Dictionnary to use for the autoComplete.

addToDictionary

public boolean addToDictionary(String word)

Add a word to the dictionary to use for the autoComplete. If the dictionary use categories, the word won't be added.

Parameters:

word - the word

Returns:

true if the dictionary don't uses categories

addToDictionary

public boolean addToDictionary(AutoCompleteDictionary.Item item)

Add an item to the dictionary to use for the autoComplete. If the dictionary use categories, the item won't be added.

Parameters:

item - the item

Returns:

true if the dictionary don't uses categories

addToDictionary

public boolean addToDictionary(String category,
                               String word)

Add a word to the dictionary to use for the autoComplete. If the dictionary don't use categories, the item won't be added.

Parameters:

category - the item category

word - the word

Returns:

true if the dictionary uses categories

addToDictionary

public boolean addToDictionary(String category,
                               AutoCompleteDictionary.Item item)

Add an item to the dictionary to use for the autoComplete. If the dictionary don't use categories, the item won't be added.

Parameters:

category - the item category

item - the item

Returns:

true if the dictionary uses categories

removeFromDictionary

public boolean removeFromDictionary(String word)

Remove a word from the dictionary to use for the autoComplete.

Parameters:

word - the word

Returns:

true if the word was removed

removeFromDictionary

public boolean removeFromDictionary(AutoCompleteDictionary.Item item)

Remove an item from the dictionary to use for the autoComplete.

Parameters:

item - the item

Returns:

true if the item was removed

removeFromDictionary

public boolean removeFromDictionary(String category,
                                    String word)

Remove a word from the dictionary to use for the autoComplete.

Parameters:

category - the item category

word - the word

Returns:

true if the item was removed

removeFromDictionary

public boolean removeFromDictionary(String category,
                                    AutoCompleteDictionary.Item item)

Remove an item from the dictionary to use for the autoComplete.

Parameters:

category - the item category

item - the item

Returns:

true if the item was removed

getDictionary

public List<AutoCompleteDictionary.Category> getDictionary()

Return the dictionary.

Returns:

the dictionary

getCategories

public Map<String,AutoCompleteDictionary.Category> getCategories()

Return the map of categories.

Returns:

the map of categories