Package com.apple.foundationdb.record.provider.common.text

Support classes for text indexing.

Tokenizing Text

A text index has an entry for every token (word) of the indexed string value. The conversion of the string value to tokens is done by a TextTokenizer. The Index options in the meta-data specify the name of the tokenizer, which is looked up in the TextTokenizerRegistry to get a TextTokenizerFactory to create the actual tokenizer object.

Interface Summary

Interface	Description
TextCollator	An interface for locale-sensitive text comparison and sorting.
TextCollatorRegistry	Registry for TextCollators.
TextTokenizer	An interface to tokenize text fields.
TextTokenizerFactory	Each implementation of TextTokenizer should have its own implementation of this factory interface to provide instances of the tokenizer to a TextTokenizerRegistry.
TextTokenizerRegistry	Registry for TextTokenizers.

Class Summary

Class	Description
DefaultTextTokenizer	This is the default tokenizer used by full-text indexes.
DefaultTextTokenizerFactory	Factory class for the DefaultTextTokenizer.
TextCollator.Strength	Standard strength values.
TextCollatorRegistryJRE	A text collator registry using the Java Platform's own Collator implementation.
TextCollatorRegistryJRE.TextCollatorJRE
TextTokenizerRegistryImpl	Default implementation of the TextTokenizerRegistry.

Enum Summary

Enum	Description
TextTokenizer.TokenizerMode	Mode that can be used to alter tokenizer behavior depending on the the context its used in.