CharacterReplacementDictionary Leave feedback
On this page
All Implemented Interfaces: com.groupdocs.search.dictionaries.DictionaryBase, java.lang.Iterable
public interface CharacterReplacementDictionary extends DictionaryBase, Iterable<Character>
Defines interface of a character replacement dictionary that is used during the indexing process. Character replacement can be used, for example, to remove accents from accented characters or to make case-insensitive index.
Learn more
| Method | Description |
|---|---|
| getCount() | Gets the number of characters contained in this CharacterReplacementDictionary . |
| addRange(Iterable |
Adds the specified collection of character replacements to this instance of the CharacterReplacementDictionary . |
| addRange(CharacterReplacementPair[] characterReplacements) | Adds the specified collection of character replacements to this instance of the CharacterReplacementDictionary . |
| removeRange(char[] characters) | Removes the specified collection of character replacements from this instance of the CharacterReplacementDictionary . |
| contains(char character) | Determines whether a CharacterReplacementDictionary object contains a replacement for the specified character. |
| getReplacement(char character) | Gets a replacement for the specified character. |
| clear() | Removes all character replacements from a CharacterReplacementDictionary object. |
| iterator() | Returns an iterator that iterates through the collection. |
public abstract int getCount()
Gets the number of characters contained in this CharacterReplacementDictionary .
Returns: int - The number of characters in the dictionary.
public abstract void addRange(Iterable<CharacterReplacementPair> characterReplacements)
Adds the specified collection of character replacements to this instance of the CharacterReplacementDictionary .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| characterReplacements | java.lang.Iterable<com.groupdocs.search.dictionaries.CharacterReplacementPair> | The collection of character replacements to add to the dictionary. |
public abstract void addRange(CharacterReplacementPair[] characterReplacements)
Adds the specified collection of character replacements to this instance of the CharacterReplacementDictionary .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| characterReplacements | CharacterReplacementPair[] | The collection of character replacements to add to the dictionary. |
public abstract void removeRange(char[] characters)
Removes the specified collection of character replacements from this instance of the CharacterReplacementDictionary .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| characters | char[] | The collection of characters to remove. |
public abstract boolean contains(char character)
Determines whether a CharacterReplacementDictionary object contains a replacement for the specified character.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| character | char | The character to locate in the CharacterReplacementDictionary object. |
Returns: boolean - true if the CharacterReplacementDictionary object contains the specified character; otherwise, false .
public abstract char getReplacement(char character)
Gets a replacement for the specified character.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| character | char | The character to get a replacement for. |
Returns: char - The replacement for the specified character.
public abstract void clear()
Removes all character replacements from a CharacterReplacementDictionary object.
public abstract Iterator<Character> iterator()
Returns an iterator that iterates through the collection.
Returns: java.util.Iterator<java.lang.Character> - 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.