org.apache.lucene.search.spell

Class PlainTextDictionary

java.lang.Object

org.apache.lucene.search.spell.PlainTextDictionary

All Implemented Interfaces:

Dictionary

public class PlainTextDictionary
extends java.lang.Object
implements Dictionary

Dictionary represented by a text file.

Format allowed: 1 word per line:
word1
word2
word3

Constructor Summary

Constructors

Constructor and Description
PlainTextDictionary(java.io.File file)
PlainTextDictionary(java.io.InputStream dictFile)
PlainTextDictionary(java.io.Reader reader) Creates a dictionary based on a reader.

Method Summary

Modifier and Type	Method and 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

Constructor Detail

PlainTextDictionary

public PlainTextDictionary(java.io.File file)
                    throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

PlainTextDictionary

public PlainTextDictionary(java.io.InputStream dictFile)

PlainTextDictionary

public PlainTextDictionary(java.io.Reader reader)

Creates a dictionary based on a reader.

Method Detail

getWordsIterator

public org.apache.lucene.util.BytesRefIterator getWordsIterator()
                                                         throws java.io.IOException

Description copied from interface: Dictionary

Return all words present in the dictionary

Specified by:

getWordsIterator in interface Dictionary

Returns:

Iterator

Throws:

java.io.IOException