com.groupdocs.search.dictionaries

Interface HomophoneDictionary

All Superinterfaces:

DictionaryBase, Iterable<String>

public interface HomophoneDictionary
extends DictionaryBase, Iterable<String>

Defines interface of a dictionary of heterographic homophones.

Learn more

• Homophone search
• Managing homophone dictionary

Method Summary

Modifier and Type	Method and Description
void	addRange(Iterable<String[]> homophones) Adds the specified collection of homophone groups to this instance of the HomophoneDictionary.
void	addRange(String[][] homophones) Adds the specified collection of homophone groups to this instance of the HomophoneDictionary.
void	clear() Removes all words from a HomophoneDictionary object.
String[][]	getAllHomophoneGroups() Gets all groups of homophones contained in this dictionary.
int	getCount() Gets the number of words contained in this HomophoneDictionary.
String[][]	getHomophoneGroups(String word) Gets all groups of homophones to which the specified word belongs.
String[]	getHomophones(String word) Gets the homophones 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[]> homophones)

Adds the specified collection of homophone groups to this instance of the HomophoneDictionary.

Parameters:

homophones - The collection of homophone groups to add to the dictionary.

addRange

void addRange(String[][] homophones)

Adds the specified collection of homophone groups to this instance of the HomophoneDictionary.

Parameters:

homophones - The collection of homophone groups to add to the dictionary.

clear

void clear()

Removes all words from a HomophoneDictionary object.

Specified by:

clear in interface DictionaryBase

getAllHomophoneGroups

String[][] getAllHomophoneGroups()

Gets all groups of homophones contained in this dictionary.

Returns:

All groups of homophones.

getCount

int getCount()

Gets the number of words contained in this HomophoneDictionary.

Returns:

The number of words.

getHomophoneGroups

String[][] getHomophoneGroups(String word)

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

Parameters:

word - The word for getting groups of homophones.

Returns:

All groups of homophones to which the specified word belongs.

getHomophones

String[] getHomophones(String word)

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

Parameters:

word - The word to suggest the homophones.

Returns:

The homophones for the specified word or empty array if the HomophoneDictionary 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.