HighFrequencyDictionary (Lucene 3.6.2 API)

java.lang.Object
- org.apache.lucene.search.spell.HighFrequencyDictionary

All Implemented Interfaces:

Dictionary
```
public class HighFrequencyDictionary
extends Object
implements Dictionary
```
HighFrequencyDictionary: terms taken from the given field of a Lucene index, which appear in a number of documents above a given threshold. Threshold is a value in [0..1] representing the minimum number of documents (of the total) where a term should appear. Based on LuceneDictionary.

- Constructor Summary
  
  Constructors
  Constructor Description
  
  HighFrequencyDictionary(org.apache.lucene.index.IndexReader reader, String field, float thresh)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  org.apache.lucene.util.BytesRefIterator getWordsIterator()
  Return all words present in the dictionary
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructors
Constructor	Description
`HighFrequencyDictionary(org.apache.lucene.index.IndexReader reader, String field, float thresh)`

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.apache.lucene.util.BytesRefIterator`	`getWordsIterator()`	Return all words present in the dictionary

Constructor Detail

HighFrequencyDictionary

public HighFrequencyDictionary(org.apache.lucene.index.IndexReader reader,
                               String field,
                               float thresh)

Method Detail
- getWordsIterator
```
public final org.apache.lucene.util.BytesRefIterator getWordsIterator()
                                                               throws IOException
```
  Description copied from interface: Dictionary
  
  Return all words present in the dictionary
  
  Specified by:
  
  getWordsIterator in interface Dictionary
  
  Returns:
  
  Iterator
  
  Throws:
  
  IOException

Class HighFrequencyDictionary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HighFrequencyDictionary

Method Detail

getWordsIterator