Package org.languagetool

Class ResultCache

java.lang.Object

org.languagetool.ResultCache

public class ResultCache
extends Object

A cache to speed up text checking for use cases where sentences are checked more than once. This typically happens when using LT as a server and texts get re-checked after corrections have been applied for some sentences. Use the same cache object for all JLanguageTool objects only if the JLanguageTool objects all use the same rules. For example, if you call JLanguageTool.addRule() in different ways for the different instances that you use the same cache for, the cache will return invalid results. Using a cache with bitext rules isn't supported either. It is okay however, to use the same cache for JLanguageTool objects with different languages, as cached results are not used for a different language.

Since:

3.7

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	ResultCache.MatchesWeigher
(package private) static class	ResultCache.RemoteMatchesWeigher
(package private) static class	ResultCache.SentenceWeigher

Field Summary

Fields

Modifier and Type	Field	Description
private final com.google.common.cache.Cache<InputSentence,List<ProtoResultCache.CachedResultMatch>>	matchesCache
private final com.google.common.cache.Cache<InputSentence,Map<String,List<RuleMatch>>>	remoteMatchesCache	rules can fail individually, results can be partial -> store list if success (can be empty), null -> failure/not checked
private final com.google.common.cache.Cache<SimpleInputSentence,AnalyzedSentence>	sentenceCache

Constructor Summary

Constructors

Constructor	Description
ResultCache(long maxSize)	Create a cache that expires items 5 minutes after the latest read access.
ResultCache(long maxSize, long expireAfter, TimeUnit timeUnit)

Method Summary

Modifier and Type	Method	Description
List<RuleMatch>	getIfPresent(InputSentence key)
AnalyzedSentence	getIfPresent(SimpleInputSentence key)
com.google.common.cache.Cache<InputSentence,List<ProtoResultCache.CachedResultMatch>>	getMatchesCache()
com.google.common.cache.Cache<InputSentence,Map<String,List<RuleMatch>>>	getRemoteMatchesCache()
com.google.common.cache.Cache<SimpleInputSentence,AnalyzedSentence>	getSentenceCache()
long	hitCount()
double	hitRate()
void	put(InputSentence key, List<RuleMatch> sentenceMatches)
void	put(SimpleInputSentence key, AnalyzedSentence aSentence)
double	requestCount()

Methods inherited from class java.lang.Object

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

Field Details

remoteMatchesCache

private final com.google.common.cache.Cache<InputSentence,Map<String,List<RuleMatch>>> remoteMatchesCache

rules can fail individually, results can be partial -> store list if success (can be empty), null -> failure/not checked

matchesCache

private final com.google.common.cache.Cache<InputSentence,List<ProtoResultCache.CachedResultMatch>> matchesCache

sentenceCache

private final com.google.common.cache.Cache<SimpleInputSentence,AnalyzedSentence> sentenceCache

Constructor Details

ResultCache

public ResultCache(long maxSize)

Create a cache that expires items 5 minutes after the latest read access.

Parameters:

maxSize - maximum cache size in number of sentences

ResultCache

public ResultCache(long maxSize,
 long expireAfter,
 TimeUnit timeUnit)

Parameters:

maxSize - maximum cache size in number of sentences

expireAfter - time to expire sentences from the cache after last read access

Method Details

hitRate

public double hitRate()

requestCount

public double requestCount()

hitCount

public long hitCount()

getIfPresent

public List<RuleMatch> getIfPresent(@NotNull
 InputSentence key)

getIfPresent

public AnalyzedSentence getIfPresent(SimpleInputSentence key)

put

public void put(@NotNull
 InputSentence key,
 @NotNull
 List<RuleMatch> sentenceMatches)

put

public void put(SimpleInputSentence key,
 AnalyzedSentence aSentence)

getMatchesCache

public com.google.common.cache.Cache<InputSentence,List<ProtoResultCache.CachedResultMatch>> getMatchesCache()

Since:

4.1

getRemoteMatchesCache

public com.google.common.cache.Cache<InputSentence,Map<String,List<RuleMatch>>> getRemoteMatchesCache()

Since:

5.0

getSentenceCache

public com.google.common.cache.Cache<SimpleInputSentence,AnalyzedSentence> getSentenceCache()

Since:

4.1