LuceneDictionary (Lucene 3.6.2 API)
Keywords: org.apache.lucene.search.spell.LuceneDictionary class

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.lucene.search.spell
Class LuceneDictionary

    java.lang.Object
      org.apache.lucene.search.spell.LuceneDictionary

All Implemented Interfaces:
  Dictionary

    public class LuceneDictionary

extends Object
implements Dictionary

Lucene Dictionary: terms taken from the given field of a Lucene index. 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

Constructor Summary
`LuceneDictionary(IndexReader reader, String field)`

Method Summary
`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`

Constructor Detail

### LuceneDictionary

    public LuceneDictionary(IndexReader reader,
                            String field)

Method Detail

### getWordsIterator

    public final 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`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD