Package org.apache.lucene.search.spell
Class HighFrequencyDictionary
- 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(IndexReader reader, String field, float thresh)Creates a new Dictionary, pulling source terms from the specifiedfieldin the providedreader.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InputIteratorgetEntryIterator()Returns an iterator over all the entries
-
-
-
Constructor Detail
-
HighFrequencyDictionary
public HighFrequencyDictionary(IndexReader reader, String field, float thresh)
Creates a new Dictionary, pulling source terms from the specifiedfieldin the providedreader.Terms appearing in less than
threshpercentage of documents will be excluded.
-
-
Method Detail
-
getEntryIterator
public final InputIterator getEntryIterator() throws IOException
Description copied from interface:DictionaryReturns an iterator over all the entries- Specified by:
getEntryIteratorin interfaceDictionary- Returns:
- Iterator
- Throws:
IOException
-
-