com.groupdocs.search.dictionaries

Interface CharacterReplacementDictionary

All Superinterfaces:

DictionaryBase, Iterable<Character>

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

• Character replacement during Indexing
• Managing character replacements

Method Summary

Modifier and Type	Method and Description
void	addRange(CharacterReplacementPair[] characterReplacements) Adds the specified collection of character replacements to this instance of the CharacterReplacementDictionary.
void	addRange(Iterable<CharacterReplacementPair> characterReplacements) Adds the specified collection of character replacements to this instance of the CharacterReplacementDictionary.
void	clear() Removes all character replacements from a CharacterReplacementDictionary object.
boolean	contains(char character) Determines whether a CharacterReplacementDictionary object contains a replacement for the specified character.
int	getCount() Gets the number of characters contained in this CharacterReplacementDictionary.
char	getReplacement(char character) Gets a replacement for the specified character.
Iterator<Character>	iterator() Returns an iterator that iterates through the collection.
void	removeRange(char[] characters) Removes the specified collection of character replacements from this instance of the CharacterReplacementDictionary.

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(CharacterReplacementPair[] characterReplacements)

Adds the specified collection of character replacements to this instance of the CharacterReplacementDictionary.

Parameters:

characterReplacements - The collection of character replacements to add to the dictionary.

addRange

void addRange(Iterable<CharacterReplacementPair> characterReplacements)

Adds the specified collection of character replacements to this instance of the CharacterReplacementDictionary.

Parameters:

characterReplacements - The collection of character replacements to add to the dictionary.

clear

void clear()

Removes all character replacements from a CharacterReplacementDictionary object.

Specified by:

clear in interface DictionaryBase

contains

boolean contains(char character)

Determines whether a CharacterReplacementDictionary object contains a replacement for the specified character.

Parameters:

character - The character to locate in the CharacterReplacementDictionary object.

Returns:

true if the CharacterReplacementDictionary object contains the specified character; otherwise, false.

getCount

int getCount()

Gets the number of characters contained in this CharacterReplacementDictionary.

Returns:

The number of characters in the dictionary.

getReplacement

char getReplacement(char character)

Gets a replacement for the specified character.

Parameters:

character - The character to get a replacement for.

Returns:

The replacement for the specified character.

iterator

Iterator<Character> iterator()

Returns an iterator that iterates through the collection.

Specified by:

iterator in interface Iterable<Character>

Returns:

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

removeRange

void removeRange(char[] characters)

Removes the specified collection of character replacements from this instance of the CharacterReplacementDictionary.

Parameters:

characters - The collection of characters to remove.