com.groupdocs.search.dictionaries

Interface Alphabet

All Superinterfaces:

DictionaryBase, Iterable<Character>

public interface Alphabet
extends DictionaryBase, Iterable<Character>

Defines interface of a dictionary of characters that is used during indexing to detect character type. Each character can be handled as separator, as letter, or both.

Learn more

• Character types
• Managing alphabet

Method Summary

Modifier and Type	Method and Description
void	clear() Sets the CharacterType.Separator type for all characters in this Alphabet.
CharacterType	getCharacterType(char character) Gets a type of a character.
int	getCount() Gets the number of characters contained in the Alphabet.
Iterator<Character>	iterator() Returns an iterator that iterates through the collection.
void	setRange(char[] characters, CharacterType type) Sets the type for each character of the specified collection in this instance of the Alphabet.

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

exportDictionary, getDictionaryType, importDictionary

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

clear

void clear()

Sets the CharacterType.Separator type for all characters in this Alphabet.

Specified by:

clear in interface DictionaryBase

getCharacterType

CharacterType getCharacterType(char character)

Gets a type of a character.

Parameters:

character - The character to get a type.

Returns:

A type of the character.

getCount

int getCount()

Gets the number of characters contained in the Alphabet.

Returns:

The number of characters in the dictionary.

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.

setRange

void setRange(char[] characters,
              CharacterType type)

Sets the type for each character of the specified collection in this instance of the Alphabet.

Parameters:

characters - The collection of characters to set the type.

type - The character type.