org.apache.lucene.search.spell
Class HighFrequencyDictionary

java.lang.Object
  extended by 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. When using IndexReader.terms(Term) the code must not call next() on TermEnum as the first call to TermEnum, see: http://issues.apache.org/jira/browse/LUCENE-6 Threshold is a value in [0..1] representing the minimum number of documents (of the total) where a term should appear. Based on LuceneDictionary.


Nested Class Summary
(package private)  class HighFrequencyDictionary.HighFrequencyIterator
           
 
Constructor Summary
HighFrequencyDictionary(IndexReader reader, String field, float thresh)
           
 
Method Summary
 Iterator getWordsIterator()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HighFrequencyDictionary

public HighFrequencyDictionary(IndexReader reader,
                               String field,
                               float thresh)
Method Detail

getWordsIterator

public final Iterator getWordsIterator()
Specified by:
getWordsIterator in interface Dictionary


Copyright (c) 2004-2008 The Compass Project.