com.groupdocs.search.dictionaries

Interface SynonymDictionary

All Superinterfaces:

DictionaryBase, Iterable<String>

public interface SynonymDictionary
extends DictionaryBase, Iterable<String>

Defines interface of a dictionary of synonyms.

Learn more

• Synonym search
• Managing synonym dictionary

Method Summary

Modifier and Type	Method and Description
void	addRange(Iterable<String[]> synonyms) Adds the specified collection of synonym groups to this instance of the SynonymDictionary.
void	addRange(String[][] synonyms) Adds the specified collection of synonym groups to this instance of the SynonymDictionary.
void	clear() Removes all words from this SynonymDictionary object.
String[][]	getAllSynonymGroups() Gets all groups of synonyms contained in this dictionary.
int	getCount() Gets the number of words contained in this SynonymDictionary.
String[][]	getSynonymGroups(String word) Gets all groups of synonyms to which the specified word belongs.
String[]	getSynonyms(String word) Gets the synonyms for the specified word.
Iterator<String>	iterator() Returns an iterator that iterates through the collection.

Methods inherited from interface com.groupdocs.search.dictionaries.DictionaryBase

exportDictionary, getDictionaryType, importDictionary

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

addRange

void addRange(Iterable<String[]> synonyms)

Adds the specified collection of synonym groups to this instance of the SynonymDictionary.

Parameters:

synonyms - The collection of synonym groups to add to the dictionary.

addRange

void addRange(String[][] synonyms)

Adds the specified collection of synonym groups to this instance of the SynonymDictionary.

Parameters:

synonyms - The collection of synonym groups to add to the dictionary.

clear

void clear()

Removes all words from this SynonymDictionary object.

Specified by:

clear in interface DictionaryBase

getAllSynonymGroups

String[][] getAllSynonymGroups()

Gets all groups of synonyms contained in this dictionary.

Returns:

All groups of synonyms.

getCount

int getCount()

Gets the number of words contained in this SynonymDictionary.

Returns:

The number of words contained in this SynonymDictionary.

getSynonymGroups

String[][] getSynonymGroups(String word)

Gets all groups of synonyms to which the specified word belongs.

Parameters:

word - The word for getting groups of synonyms.

Returns:

All groups of synonyms to which the specified word belongs.

getSynonyms

String[] getSynonyms(String word)

Gets the synonyms for the specified word. The resulting array does not contain the original word.

Parameters:

word - The word to suggest the synonyms.

Returns:

The synonyms for the specified word or empty array if the SynonymDictionary object does not contain the specified word.

iterator

Iterator<String> iterator()

Returns an iterator that iterates through the collection.

Specified by:

iterator in interface Iterable<String>

Returns:

An iterator that can be used to iterate through the collection.