HomophoneDictionary Leave feedback
On this page
All Implemented Interfaces: com.groupdocs.search.dictionaries.DictionaryBase, java.lang.Iterable
public interface HomophoneDictionary extends DictionaryBase, Iterable<String>
Defines interface of a dictionary of heterographic homophones.
Learn more
| Method | Description |
|---|---|
| getCount() | Gets the number of words contained in this HomophoneDictionary . |
| addRange(Iterable<String[]> homophones) | Adds the specified collection of homophone groups to this instance of the HomophoneDictionary . |
| addRange(String[][] homophones) | Adds the specified collection of homophone groups to this instance of the HomophoneDictionary . |
| clear() | Removes all words from a HomophoneDictionary object. |
| getHomophones(String word) | Gets the homophones for the specified word. |
| getHomophoneGroups(String word) | Gets all groups of homophones to which the specified word belongs. |
| getAllHomophoneGroups() | Gets all groups of homophones contained in this dictionary. |
| iterator() | Returns an iterator that iterates through the collection. |
public abstract int getCount()
Gets the number of words contained in this HomophoneDictionary .
Returns: int - The number of words.
public abstract void addRange(Iterable<String[]> homophones)
Adds the specified collection of homophone groups to this instance of the HomophoneDictionary .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| homophones | java.lang.Iterable<java.lang.String[]> | The collection of homophone groups to add to the dictionary. |
public abstract void addRange(String[][] homophones)
Adds the specified collection of homophone groups to this instance of the HomophoneDictionary .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| homophones | java.lang.String[][] | The collection of homophone groups to add to the dictionary. |
public abstract void clear()
Removes all words from a HomophoneDictionary object.
public abstract String[] getHomophones(String word)
Gets the homophones for the specified word. The resulting array does not contain the original word.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| word | java.lang.String | The word to suggest the homophones. |
Returns: java.lang.String[] - The homophones for the specified word or empty array if the HomophoneDictionary object does not contain the specified word.
public abstract String[][] getHomophoneGroups(String word)
Gets all groups of homophones to which the specified word belongs.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| word | java.lang.String | The word for getting groups of homophones. |
Returns: java.lang.String[][] - All groups of homophones to which the specified word belongs.
public abstract String[][] getAllHomophoneGroups()
Gets all groups of homophones contained in this dictionary.
Returns: java.lang.String[][] - All groups of homophones.
public abstract Iterator<String> iterator()
Returns an iterator that iterates through the collection.
Returns: java.util.Iterator<java.lang.String> - An iterator that can be used to iterate through the collection.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.