Class Dictionary
java.lang.Object
org.apache.lucene.analysis.hunspell.Dictionary
In-memory structure for the dictionary (.dic) and affix (.aff) data of a hunspell dictionary.
-
Constructor Summary
ConstructorDescriptionDictionary
(Directory tempDir, String tempFileNamePrefix, InputStream affix, InputStream dictionary) Creates a new Dictionary containing the information read from the provided InputStreams to hunspell affix and dictionary files.Dictionary
(Directory tempDir, String tempFileNamePrefix, InputStream affix, List<InputStream> dictionaries, boolean ignoreCase) Creates a new Dictionary containing the information read from the provided InputStreams to hunspell affix and dictionary files. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns true if this dictionary was constructed with theignoreCase
optionlookupEntries
(String root)
-
Constructor Details
-
Dictionary
public Dictionary(Directory tempDir, String tempFileNamePrefix, InputStream affix, InputStream dictionary) throws IOException, ParseException Creates a new Dictionary containing the information read from the provided InputStreams to hunspell affix and dictionary files. You have to close the provided InputStreams yourself.- Parameters:
tempDir
- Directory to use for offline sortingtempFileNamePrefix
- prefix to use to generate temp file namesaffix
- InputStream for reading the hunspell affix file (won't be closed).dictionary
- InputStream for reading the hunspell dictionary file (won't be closed).- Throws:
IOException
- Can be thrown while reading from the InputStreamsParseException
- Can be thrown if the content of the files does not meet expected formats
-
Dictionary
public Dictionary(Directory tempDir, String tempFileNamePrefix, InputStream affix, List<InputStream> dictionaries, boolean ignoreCase) throws IOException, ParseException Creates a new Dictionary containing the information read from the provided InputStreams to hunspell affix and dictionary files. You have to close the provided InputStreams yourself.- Parameters:
tempDir
- Directory to use for offline sortingtempFileNamePrefix
- prefix to use to generate temp file namesaffix
- InputStream for reading the hunspell affix file (won't be closed).dictionaries
- InputStream for reading the hunspell dictionary files (won't be closed).- Throws:
IOException
- Can be thrown while reading from the InputStreamsParseException
- Can be thrown if the content of the files does not meet expected formats
-
-
Method Details
-
lookupEntries
- Parameters:
root
- a string to look up in the dictionary. No case conversion or affix removal is performed. To get the possible roots of any word, you may callHunspell.getRoots(String)
- Returns:
- the dictionary entries for the given root, or
null
if there's none
-
getIgnoreCase
public boolean getIgnoreCase()Returns true if this dictionary was constructed with theignoreCase
option
-