Package org.languagetool.languagemodel

Class LuceneSingleIndexLanguageModel

java.lang.Object

org.languagetool.languagemodel.BaseLanguageModel

org.languagetool.languagemodel.LuceneSingleIndexLanguageModel

All Implemented Interfaces:

java.lang.AutoCloseable, LanguageModel

public class LuceneSingleIndexLanguageModel
extends BaseLanguageModel

Information about ngram occurrences, taken from Lucene indexes (one index per ngram level). This is not a real language model as it only returns information about occurrence counts but has no probability calculation, especially not for the case with 0 occurrences.

Since:

3.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	LuceneSingleIndexLanguageModel.LuceneSearcher

Field Summary

Fields

Modifier and Type	Field	Description
private static java.util.Map<java.io.File,LuceneSingleIndexLanguageModel.LuceneSearcher>	dirToSearcherMap
private java.util.List<java.io.File>	indexes
private java.util.Map<java.lang.Integer,LuceneSingleIndexLanguageModel.LuceneSearcher>	luceneSearcherMap
private long	maxNgram
private java.io.File	topIndexDir

Fields inherited from interface org.languagetool.languagemodel.LanguageModel

GOOGLE_SENTENCE_END, GOOGLE_SENTENCE_START

Constructor Summary

Constructors

Constructor	Description
LuceneSingleIndexLanguageModel(int maxNgram)
LuceneSingleIndexLanguageModel(java.io.File topIndexDir)

Method Summary

Modifier and Type	Method	Description
private void	addIndex(java.io.File topIndexDir, int ngramSize)
static void	clearCaches()	Only used internally.
void	close()
protected void	doValidateDirectory(java.io.File topIndexDir)
private LuceneSingleIndexLanguageModel.LuceneSearcher	getCachedLuceneSearcher(java.io.File indexDir)
long	getCount(java.lang.String token1)	Get the occurrence count for token.
long	getCount(java.util.List<java.lang.String> tokens)	Get the occurrence count for the given token sequence.
private long	getCount(org.apache.lucene.index.Term term, LuceneSingleIndexLanguageModel.LuceneSearcher luceneSearcher)
protected LuceneSingleIndexLanguageModel.LuceneSearcher	getLuceneSearcher(int ngramSize)
long	getTotalTokenCount()
java.lang.String	toString()
static void	validateDirectory(java.io.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 org.languagetool.languagemodel.BaseLanguageModel

getPseudoProbability, getPseudoProbabilityStupidBackoff

Methods inherited from class java.lang.Object

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

Field Detail

dirToSearcherMap

private static final java.util.Map<java.io.File,LuceneSingleIndexLanguageModel.LuceneSearcher> dirToSearcherMap

indexes

private final java.util.List<java.io.File> indexes

luceneSearcherMap

private final java.util.Map<java.lang.Integer,LuceneSingleIndexLanguageModel.LuceneSearcher> luceneSearcherMap

topIndexDir

private final java.io.File topIndexDir

maxNgram

private final long maxNgram

Constructor Detail

LuceneSingleIndexLanguageModel

public LuceneSingleIndexLanguageModel(java.io.File topIndexDir)

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.

LuceneSingleIndexLanguageModel

@Experimental
public LuceneSingleIndexLanguageModel(int maxNgram)

Method Detail

validateDirectory

public static void validateDirectory(java.io.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

clearCaches

@Experimental
public static void clearCaches()

Only used internally.

Since:

3.2

doValidateDirectory

protected void doValidateDirectory(java.io.File topIndexDir)

addIndex

private void addIndex(java.io.File topIndexDir,
                      int ngramSize)

getCount

public long getCount(java.util.List<java.lang.String> tokens)

Description copied from class: BaseLanguageModel

Get the occurrence count for the given token sequence.

Specified by:

getCount in class BaseLanguageModel

getCount

public long getCount(java.lang.String token1)

Description copied from class: BaseLanguageModel

Get the occurrence count for token.

Specified by:

getCount in class BaseLanguageModel

getTotalTokenCount

public long getTotalTokenCount()

Specified by:

getTotalTokenCount in class BaseLanguageModel

getLuceneSearcher

protected LuceneSingleIndexLanguageModel.LuceneSearcher getLuceneSearcher(int ngramSize)

getCachedLuceneSearcher

private LuceneSingleIndexLanguageModel.LuceneSearcher getCachedLuceneSearcher(java.io.File indexDir)

getCount

private long getCount(org.apache.lucene.index.Term term,
                      LuceneSingleIndexLanguageModel.LuceneSearcher luceneSearcher)

close

public void close()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object