You are here: com.dtsearch.engine Package > Classes > WordListBuilder Class > WordListBuilder.listMatchingWords Method
Close
dtSearch Engine API for Java
ContentsIndexHome
PreviousUpNext
WordListBuilder.listMatchingWords Method

List words that match an expression

WordListBuilder Class
com.dtsearch.engine Package
Syntax
Java
public int listMatchingWords(String toMatch, int nLimit, int nFlags, int nFuzziness);
Parameters
Description
String toMatch
Expression to match.
int nLimit
Maximum number of words to list.
int nFlags
SearchFlags value to specify fuzzy searching, phonic searching, etc.
int nFuzziness
If SearchFlags includes dtsSearchFuzzy, the level of fuzziness to apply

The number of words found.

A SearchFilter can be used with listMatchingWords to limit the results to values in a set of documents. Use setFilter to attach a SearchFilter to the WordListBuilder. When a SearchFilter is used, all counts returned by WordListBuilder are document counts. For example, if a word occurs 20 times in 7 documents, the count returned will be 7 for both GetNthWordCount and GetNthWordDocCount.