IWordListBuilder Interface

WordListBuilder provides a way to list words in an index.

File

File: dten600.idl

Module: COM Interface

Syntax

IDL

interface IWordListBuilder : IDispatch;

Group

Interfaces

Members

Properties

Property	Description
Count	Number of words in the list

Methods

Method	Description
CloseIndex	Close the index that was opened by OpenIndex.
GetNthWord	Get the text of a word in the word list.
GetNthWordCount	Get the number of times this word occurs in the index
GetNthWordDocCount	Get the number of documents in which this word occurs
GetNthWordField	If the dtsWlbListFields flag was set in ListMatchingWords, you can call GetNthWordField to get the field in which a word occurred
ListFieldValues	List all field values in the index that match an expression @param field The name of the field to enumerate. @param toMatch Wildcard expression to match in the field. @param nLimit Maximum number of values to obtain. @return The number of values found.
ListFields	List all fields in the index
ListMatchingWords	List all words in the index that match toMatch, using the specified searchFlags and fuzziness, up to nLimit words. Returns the number of words found
ListWords	Updates the word list with a new cursor word, which is the word in the middle of the list. Range is the number of words surrounding the cursor word
OpenIndex	Open the index at IndexPath and return 0 if the index was opened successfully, or non-zero if the index could not be opened.
SetFilter	Limit results of ListMatchingWords or ListFieldValues to the documents in a SearchFilter
Sort	Sort the word list by document count or term

Methods

Method	Description
CloseIndex	Close the index that was opened by OpenIndex.
GetNthWord	Get the text of a word in the word list.
GetNthWordCount	Get the number of times this word occurs in the index
GetNthWordDocCount	Get the number of documents in which this word occurs
GetNthWordField	If the dtsWlbListFields flag was set in ListMatchingWords, you can call GetNthWordField to get the field in which a word occurred
ListFieldValues	List all field values in the index that match an expression @param field The name of the field to enumerate. @param toMatch Wildcard expression to match in the field. @param nLimit Maximum number of values to obtain. @return The number of values found.
ListFields	List all fields in the index
ListMatchingWords	List all words in the index that match toMatch, using the specified searchFlags and fuzziness, up to nLimit words. Returns the number of words found
ListWords	Updates the word list with a new cursor word, which is the word in the middle of the list. Range is the number of words surrounding the cursor word
OpenIndex	Open the index at IndexPath and return 0 if the index was opened successfully, or non-zero if the index could not be opened.
SetFilter	Limit results of ListMatchingWords or ListFieldValues to the documents in a SearchFilter
Sort	Sort the word list by document count or term

Properties

Property	Description
Count	Number of words in the list

Remarks

WordListBuilder is intended for quick enumeration of words.

Two ways of listing words are provided, one for listing the words before and after a word in an index, and one for listing words that match a search term in an index.

The scrolling list of indexed words that updates as a user enters a search request in dtSearch Desktop is implemented using WordListBuilder's ListWords method. The "Browse Words" dialog box in dtSearch Desktop that lists words matching an expression is implemented using the ListMatchingWords method.

For speed, WordListBuilder does not actually enumerate the references for each word and instead relies on counts incrementally stored in the index. Therefore, the reported counts may include artifacts of the indexing process such as reindexed or removed documents, so the counts may be higher than the actual count of references in the index. Compressing an index will remove these extra references.

Class Hierarchy

IWordListBuilder