Package org.languagetool.server
Class Pipeline
java.lang.Object
org.languagetool.JLanguageTool
org.languagetool.server.Pipeline
class Pipeline
extends org.languagetool.JLanguageTool
Wrapper for JLanguageTool instances that can be made immutable
Use case: Setup instances once (ahead of time or on demand), cache and use when matching queries come in; work around thread safety issues by only giving out one reference at a time
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static class
Nested classes/interfaces inherited from class org.languagetool.JLanguageTool
org.languagetool.JLanguageTool.Mode, org.languagetool.JLanguageTool.ParagraphHandling
-
Field Summary
FieldsFields inherited from class org.languagetool.JLanguageTool
BUILD_DATE, DICTIONARY_FILENAME_EXTENSION, FALSE_FRIEND_FILE, GIT_SHORT_ID, MESSAGE_BUNDLE, PARAGRAPH_END_TAGNAME, PATTERN_FILE, SENTENCE_END_TAGNAME, SENTENCE_START_TAGNAME, VERSION
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
activateLanguageModelRules
(File indexDir) void
activateWord2VecModelRules
(File indexDir) void
addMatchFilter
(@NotNull org.languagetool.rules.RuleMatchFilter filter) void
addRule
(org.languagetool.rules.Rule rule) void
disableCategory
(org.languagetool.rules.CategoryId id) void
disableRule
(String ruleId) void
disableRules
(List<String> ruleIds) void
enableRule
(String ruleId) void
enableRuleCategory
(org.languagetool.rules.CategoryId id) List
<org.languagetool.rules.Rule> List
<org.languagetool.rules.Rule> List
<org.languagetool.rules.Rule> Map
<org.languagetool.rules.CategoryId, org.languagetool.rules.Category> List
<org.languagetool.rules.patterns.AbstractPatternRule> getPatternRulesByIdAndSubId
(String Id, String subId) (package private) boolean
Test if expire time has elapsed since last use.List
<org.languagetool.rules.patterns.AbstractPatternRule> loadFalseFriendRules
(String filename) List
<org.languagetool.rules.patterns.AbstractPatternRule> loadPatternRules
(String filename) (package private) void
Refresh expire timer of pipelinevoid
setCleanOverlappingMatches
(boolean cleanOverlappingMatches) void
void
setMaxErrorsPerWordRate
(float maxErrorsPerWordRate) void
setOutput
(PrintStream printStream) (package private) void
Prevents any further changes after this method was called.Methods inherited from class org.languagetool.JLanguageTool
activateNeuralNetworkRules, addTemporaryFile, adjustRuleMatchPos, analyzeSentences, analyzeText, applyCustomFilters, check, check, check, check, check, check, check, check, check, checkAnalyzedSentence, getAnalyzedSentence, getDataBroker, getLanguage, getMessageBundle, getMessageBundle, getRawAnalyzedSentence, isCategoryDisabled, isPremiumVersion, performCheck, performCheck, printIfVerbose, printSentenceInfo, rememberUnknownWords, removeTemporaryFiles, sentenceTokenize, setDataBroker, setListUnknownWords
-
Field Details
-
setup
private boolean setup -
lastUsedTimestamp
private long lastUsedTimestamp
-
-
Constructor Details
-
Pipeline
Pipeline(org.languagetool.Language language, List<org.languagetool.Language> altLanguages, org.languagetool.Language motherTongue, org.languagetool.ResultCache cache, org.languagetool.GlobalConfig globalConfig, org.languagetool.UserConfig userConfig)
-
-
Method Details
-
setupFinished
void setupFinished()Prevents any further changes after this method was called. -
refreshExpireTimer
void refreshExpireTimer()Refresh expire timer of pipeline -
isExpired
boolean isExpired()Test if expire time has elapsed since last use.- Returns:
- is pipeline expired?
-
setCleanOverlappingMatches
public void setCleanOverlappingMatches(boolean cleanOverlappingMatches) - Overrides:
setCleanOverlappingMatches
in classorg.languagetool.JLanguageTool
-
setMaxErrorsPerWordRate
public void setMaxErrorsPerWordRate(float maxErrorsPerWordRate) - Overrides:
setMaxErrorsPerWordRate
in classorg.languagetool.JLanguageTool
-
setOutput
- Overrides:
setOutput
in classorg.languagetool.JLanguageTool
-
loadPatternRules
public List<org.languagetool.rules.patterns.AbstractPatternRule> loadPatternRules(String filename) throws IOException - Overrides:
loadPatternRules
in classorg.languagetool.JLanguageTool
- Throws:
IOException
-
loadFalseFriendRules
public List<org.languagetool.rules.patterns.AbstractPatternRule> loadFalseFriendRules(String filename) throws ParserConfigurationException, SAXException, IOException - Overrides:
loadFalseFriendRules
in classorg.languagetool.JLanguageTool
- Throws:
ParserConfigurationException
SAXException
IOException
-
activateLanguageModelRules
- Overrides:
activateLanguageModelRules
in classorg.languagetool.JLanguageTool
- Throws:
IOException
-
activateWord2VecModelRules
- Overrides:
activateWord2VecModelRules
in classorg.languagetool.JLanguageTool
- Throws:
IOException
-
addMatchFilter
public void addMatchFilter(@NotNull @NotNull org.languagetool.rules.RuleMatchFilter filter) - Overrides:
addMatchFilter
in classorg.languagetool.JLanguageTool
-
addRule
public void addRule(org.languagetool.rules.Rule rule) - Overrides:
addRule
in classorg.languagetool.JLanguageTool
-
disableRule
- Overrides:
disableRule
in classorg.languagetool.JLanguageTool
-
disableRules
- Overrides:
disableRules
in classorg.languagetool.JLanguageTool
-
disableCategory
public void disableCategory(org.languagetool.rules.CategoryId id) - Overrides:
disableCategory
in classorg.languagetool.JLanguageTool
-
getDisabledRules
- Overrides:
getDisabledRules
in classorg.languagetool.JLanguageTool
-
enableRule
- Overrides:
enableRule
in classorg.languagetool.JLanguageTool
-
enableRuleCategory
public void enableRuleCategory(org.languagetool.rules.CategoryId id) - Overrides:
enableRuleCategory
in classorg.languagetool.JLanguageTool
-
getUnknownWords
- Overrides:
getUnknownWords
in classorg.languagetool.JLanguageTool
-
getCategories
- Overrides:
getCategories
in classorg.languagetool.JLanguageTool
-
getAllRules
- Overrides:
getAllRules
in classorg.languagetool.JLanguageTool
-
getAllActiveRules
- Overrides:
getAllActiveRules
in classorg.languagetool.JLanguageTool
-
getAllActiveOfficeRules
- Overrides:
getAllActiveOfficeRules
in classorg.languagetool.JLanguageTool
-
getPatternRulesByIdAndSubId
public List<org.languagetool.rules.patterns.AbstractPatternRule> getPatternRulesByIdAndSubId(String Id, String subId) - Overrides:
getPatternRulesByIdAndSubId
in classorg.languagetool.JLanguageTool
-
setConfigValues
- Overrides:
setConfigValues
in classorg.languagetool.JLanguageTool
-