org.languagetool.languagemodel

Class LuceneLanguageModel

java.lang.Object

org.languagetool.languagemodel.LuceneLanguageModel

All Implemented Interfaces:

AutoCloseable, LanguageModel

public class LuceneLanguageModel
extends Object
implements LanguageModel

Information about ngram occurrences, taken from a Lucene index.

Since:

2.7

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	LuceneLanguageModel.LuceneSearcher

Field Summary

Fields inherited from interface org.languagetool.languagemodel.LanguageModel

GOOGLE_SENTENCE_END, GOOGLE_SENTENCE_START

Constructor Summary

Constructors

Constructor and Description
LuceneLanguageModel(File topIndexDir)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
long	getCount(List<String> tokens) Get the occurrence count for the given token sequence.
long	getCount(String token1) Get the occurrence count for token.
long	getCount(String token1, String token2) Get the occurrence count for the phrase token1 token2.
long	getCount(String token1, String token2, String token3) Get the occurrence count for the phrase token1 token2 token3.
protected LuceneLanguageModel.LuceneSearcher	getLuceneSearcher(int ngramSize)
long	getTotalTokenCount()
String	toString()
static void	validateDirectory(File topIndexDir) Throw RuntimeException is the given directory does not seem to be a valid ngram top directory with sub directories 1grams etc.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LuceneLanguageModel

public LuceneLanguageModel(File topIndexDir)
                    throws IOException

Parameters:

topIndexDir - a directory which contains at least another sub directory called 3grams, which is a Lucene index with ngram occurrences as created by org.languagetool.dev.FrequencyIndexCreator.

Throws:

IOException

Method Detail

validateDirectory

public static void validateDirectory(File topIndexDir)

Throw RuntimeException is the given directory does not seem to be a valid ngram top directory with sub directories 1grams etc.

Since:

3.0

getCount

public long getCount(List<String> tokens)

Description copied from interface: LanguageModel

Get the occurrence count for the given token sequence.

Specified by:

getCount in interface LanguageModel

getCount

public long getCount(String token1)

Description copied from interface: LanguageModel

Get the occurrence count for token.

Specified by:

getCount in interface LanguageModel

getCount

public long getCount(String token1,
            String token2)

Description copied from interface: LanguageModel

Get the occurrence count for the phrase token1 token2.

Specified by:

getCount in interface LanguageModel

getCount

public long getCount(String token1,
            String token2,
            String token3)

Description copied from interface: LanguageModel

Get the occurrence count for the phrase token1 token2 token3.

Specified by:

getCount in interface LanguageModel

getTotalTokenCount

public long getTotalTokenCount()

Specified by:

getTotalTokenCount in interface LanguageModel

getLuceneSearcher

protected LuceneLanguageModel.LuceneSearcher getLuceneSearcher(int ngramSize)

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface LanguageModel

toString

public String toString()

Overrides:

toString in class Object