StopWordDictionary class

StopWordDictionary class

Represents a dictionary of stop words.

The dictionary defines how the text of documents is divided into terms. Therefore the dictionary of an index can be changed only while the index contains no documents and its status is IndexStatus.ready; otherwise a method that changes the dictionary throws RuntimeError. A call that does not change the content of the dictionary is always allowed. To use another content with documents that are indexed already, create a new index and index the documents again.

A change of the dictionary of an index is saved in the index at once. If it cannot be saved, the method throws the exception that describes the failure, and the dictionary stays unchanged.

The StopWordDictionary type exposes the following members:

Methods

Method Description
add_range Adds the specified collection of words to this StopWordDictionary.
add_range Adds the specified collection of words to the StopWordDictionary instance.
clear Removes all words from the StopWordDictionary.
contains Determines whether the StopWordDictionary contains the specified word.
get_enumerator Returns an iterator that iterates through the collection.
remove_range Removes the specified collection of words from this StopWordDictionary.
remove_range Removes the specified collection of words from this StopWordDictionary.
export_dictionary Exports the dictionary to a file with the specified name. (inherited from DictionaryBase)
import_dictionary Imports a dictionary from the specified file. (inherited from DictionaryBase)

Properties

Property Description
count The number of stop words contained in the StopWordDictionary.
dictionary_type The dictionary type.

See Also