LuceneLanguageModel

java.lang.Object

org.languagetool.languagemodel.BaseLanguageModel

org.languagetool.languagemodel.LuceneLanguageModel

All Implemented Interfaces:: AutoCloseable, LanguageModel

public class LuceneLanguageModel extends BaseLanguageModel

Like LuceneSingleIndexLanguageModel, but can merge the results of lookups in several independent indexes to one result.

Since:: 2.7

Field Summary

Fields

Modifier and Type

Field

Description

private final List<LuceneSingleIndexLanguageModel>

lms

Fields inherited from interface org.languagetool.languagemodel.LanguageModel
GOOGLE_SENTENCE_END, GOOGLE_SENTENCE_START
Constructor Summary

Constructors

Constructor

Description

LuceneLanguageModel(File topIndexDir)
Method Summary

Modifier and Type

Method

Description

void

close()

long

getCount(String token)

Get the occurrence count for token.

long

getCount(List<String> tokens)

Get the occurrence count for the given token sequence.

private static @Nullable File[]

getSubDirectoriesOrNull(File topIndexDir)

long

getTotalTokenCount()

String

toString()

static void

validateDirectory(File topIndexDir)

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 Details
- lms
  
  private final List<LuceneSingleIndexLanguageModel> lms
Constructor Details
- LuceneLanguageModel
  
  public LuceneLanguageModel(File topIndexDir)
  
  Parameters:
  
  topIndexDir - a directory which contains either: 1) sub directories called 1grams, 2grams, 3grams, which are Lucene indexes with ngram occurrences as created by org.languagetool.dev.FrequencyIndexCreator or 2) sub directories index-1, index-2 etc that contain the sub directories described under 1)
Method Details
- validateDirectory
  
  public static void validateDirectory(File topIndexDir)
- getSubDirectoriesOrNull
  
  @Nullable private static @Nullable File[] getSubDirectoriesOrNull(File topIndexDir)
- getCount
  
  public long getCount(List<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(String token)
  
  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
- close
  
  public void close()
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object