-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
ResultCache.java
71 lines (62 loc) · 2.85 KB
/
ResultCache.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/* LanguageTool, a natural language style checker
* Copyright (C) 2017 Daniel Naber (http://www.danielnaber.de)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
* USA
*/
package org.languagetool;
import com.google.common.cache.Cache;
import com.google.common.cache.CacheBuilder;
import com.google.common.cache.CacheStats;
import org.languagetool.rules.RuleMatch;
import java.util.List;
import java.util.concurrent.TimeUnit;
/**
* 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 {@link JLanguageTool} objects <strong>only if
* the JLanguageTool objects all use the same rules.</strong> For example, if you call {@code JLanguageTool.addRule()}
* in different ways for the different instances that you use the same cache for, the cache will return invalid results.
* It is okay however, to use same same cache for {@link JLanguageTool} objects with different languages, as
* cached results are not used for a different language.
* @since 3.7
*/
@Experimental
public class ResultCache {
private final Cache<InputSentence, List<RuleMatch>> cache;
/**
* Create a cache that expires items 5 minutes after the latest read access.
* @param maxSize maximum cache size in number of sentences
*/
public ResultCache(long maxSize) {
cache = CacheBuilder.newBuilder().maximumSize(maxSize).recordStats().expireAfterAccess(5, TimeUnit.MINUTES).build();
}
/**
* @param maxSize maximum cache size in number of sentences
* @param expireAfter time to expire sentences from the cache after last read access
*/
public ResultCache(long maxSize, int expireAfter, TimeUnit timeUnit) {
cache = CacheBuilder.newBuilder().maximumSize(maxSize).recordStats().expireAfterAccess(expireAfter, timeUnit).build();
}
public CacheStats stats() {
return cache.stats();
}
public List<RuleMatch> getIfPresent(InputSentence key) {
return cache.getIfPresent(key);
}
public void put(InputSentence key, List<RuleMatch> sentenceMatches) {
cache.put(key, sentenceMatches);
}
}